Registers the updater for a specified document, which means the updater can only be triggered by changes made in that document.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 2015.0.0.0 (2015.0.0.0)
Since: 2011
Syntax
| C# |
|---|
|
| Visual Basic |
|---|
|
| Visual C++ |
|---|
|
Parameters
- updater
- Type: Autodesk.Revit.DB IUpdater
Updater to be registered.
- document
- Type: Autodesk.Revit.DB Document
Document for which this updater is to be registered.
- isOptional
- Type: System Boolean
This argument controls whether the updater should be required next time a document is open in which the updater had been previously used. If a non-optional updater is not found (i.e. currently not registered), the end user will be presented with a warning and choices to resolve the situation.
Remarks
An updater may be registered in more then one document, but an updater may not be registered for a document and also for the entire application at the same time. If an updater has already been registered application-wide, an attempt to register it for a document will cause an exception.
Exceptions
| Exception | Condition |
|---|---|
| Autodesk.Revit.Exceptions ArgumentException | Updater with the the same Id has already been registered on the application level. -or- Updater with the the same Id has already been registered either in the given document or on the application level. -or- Updater's Id is not valid. |
| Autodesk.Revit.Exceptions ArgumentNullException | A non-optional argument was NULL |
| Autodesk.Revit.Exceptions InvalidOperationException | Method is not allowed during execution of a dynamic update. -or- The updater's owner's AddIn does not match the currently active AddIn, i.e. IUpdater.GetUpdaterId().GetAddInId() differs from the addInId field in the manifest file of the currently executing external application. |