2022 Class
Changes 0
C

UpdaterRegistry

Description:
An object that stores and manages all updaters registered in the current session.
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.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.UpdaterRegistry
public class UpdaterRegistry : IDisposable
Name Return Type Description
M AddTrigger(UpdaterId, Document, ElementFilter, ChangeType) None Adds trigger with the specified element filter and ChangeType for the specified document
M AddTrigger(UpdaterId, Document, ICollection<ElementId>, ChangeType) None Adds a trigger to an updater with specified set of elements and ChangeType
M AddTrigger(UpdaterId, ElementFilter, ChangeType) None Adds trigger with the specified element filter and ChangeType for all documents associated with this Updater
M DisableUpdater(UpdaterId) None Disables the updater.
M Dispose() None Releases all resources used by the
M EnableUpdater(UpdaterId) None Enables the updater.
M GetIsUpdaterOptional(UpdaterId) bool Check if the updater is optional or not.
M GetRegisteredUpdaterInfos() IList<UpdaterInfo> Returns UpdaterInfos for all the application-wide updaters.
M GetRegisteredUpdaterInfos(Document) IList<UpdaterInfo> Returns information about all updaters applicable to the given document.
M IsUpdaterEnabled(UpdaterId) bool Checks if the updater is enabled or not.
M IsUpdaterRegistered(UpdaterId) bool Checks whether updater with the given id is registered
M IsUpdaterRegistered(UpdaterId, Document) bool Checks whether updater with the given id is registered in a document.
M RegisterUpdater(IUpdater) None Registers an updater application-wide, which means the updater may get triggered in any open document.
M RegisterUpdater(IUpdater, Boolean) None Registers an updater application-wide, which means the updater may get triggered in any open document.
M RegisterUpdater(IUpdater, Document) None Registers the updater for a specified document, which means the updater can only be triggered by changes made in that document.
M RegisterUpdater(IUpdater, Document, Boolean) None Registers the updater for a specified document, which means the updater can only be triggered by changes made in that document.
M RemoveAllTriggers(UpdaterId) None Removes all triggers associated with Updater with specified UpdaterId. Does not unregister updater.
M RemoveDocumentTriggers(UpdaterId, Document) None Removes all triggers associated with specified document and Updater Does not unregister updater.
M SetExecutionOrder(UpdaterId, UpdaterId) None Forces execution order between two updaters Execution order: first before second
M SetIsUpdaterOptional(UpdaterId, Boolean) None Sets a flag indicating whether an updater is optional or not.
M UnregisterUpdater(UpdaterId) None Removes the updater associated with the input id from the UpdaterRegistry. Also removes all triggers associated with the Updater.
M UnregisterUpdater(UpdaterId, Document) None Unregisters an updater for the given document.
Name Return Type Description
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.