UpdaterRegistry

Public Class

An object that stores and manages all updaters registered in the current session.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.UpdaterRegistry

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class UpdaterRegistry : IDisposable

The UpdaterRegistry type exposes the following members.

Properties

Name

Description

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Methods

Name

Description

Public Method
Static Member
AddTrigger(UpdaterId, ElementFilter, ChangeType)

Adds trigger with the specified element filter and ChangeType for all documents associated with this Updater

Public Method
Static Member
AddTrigger(UpdaterId, Document, ElementFilter, ChangeType)

Adds trigger with the specified element filter and ChangeType for the specified document

Public Method
Static Member

AddTrigger(UpdaterId, Document, ICollection.ElementId., ChangeType)

Adds a trigger to an updater with specified set of elements and ChangeType

Public Method
Static Member

DisableUpdater

Disables the updater.

Public Method

Dispose

Releases all resources used by the UpdaterRegistry

Public Method
Static Member
EnableUpdater

Enables the updater.

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method
Static Member
GetIsUpdaterOptional

Check if the updater is optional or not.

Public Method
Static Member

GetRegisteredUpdaterInfos.

Returns UpdaterInfos for all the application-wide updaters.

Public Method
Static Member
GetRegisteredUpdaterInfos(Document)

Returns information about all updaters applicable to the given document.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
Static Member
IsUpdaterEnabled

Checks if the updater is enabled or not.

Public Method
Static Member

IsUpdaterRegistered(UpdaterId)

Checks whether updater with the given id is registered

Public Method
Static Member

IsUpdaterRegistered(UpdaterId, Document)

Checks whether updater with the given id is registered in a document.

Public Method
Static Member
RegisterUpdater(IUpdater)

Registers an updater application-wide, which means the updater may get triggered in any open document.

Public Method
Static Member
RegisterUpdater(IUpdater, Document)

Registers the updater for a specified document, which means the updater can only be triggered by changes made in that document.

Public Method
Static Member
RegisterUpdater(IUpdater, Boolean)

Registers an updater application-wide, which means the updater may get triggered in any open document.

Public Method
Static Member
RegisterUpdater(IUpdater, Document, Boolean)

Registers the updater for a specified document, which means the updater can only be triggered by changes made in that document.

Public Method
Static Member

RemoveAllTriggers

Removes all triggers associated with Updater with specified UpdaterId. Does not unregister updater.

Public Method
Static Member

RemoveDocumentTriggers

Removes all triggers associated with specified document and Updater Does not unregister updater.

Public Method
Static Member

SetExecutionOrder

Forces execution order between two updaters Execution order: first before second

Public Method
Static Member
SetIsUpdaterOptional

Sets a flag indicating whether an updater is optional or not.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Public Method
Static Member
UnregisterUpdater(UpdaterId)

Removes the updater associated with the input id from the UpdaterRegistry. Also removes all triggers associated with the Updater.

Public Method
Static Member
UnregisterUpdater(UpdaterId, Document)

Unregisters an updater for the given document.

Remarks

The registry is an application-wide singleton. It maintains all dynamic updaters currently registered, and also invokes them per their respective trigger condition during subsequent transactions.

Please note that only the application (an add-in, typically) which registered an updater is allowed to modify it later, including unregistering it. Also, an application is not allowed to register an updater with an Id, that is based on another application’s Id.