<Code Lib>
Sign in
2027 Method
Changes 0
M

UpdaterRegistry.RegisterUpdater(IUpdater, Document, Boolean)

Description:
Registers the updater for a specified document, which means the updater can only be triggered by changes made in that document.
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.
Overloads (4):
RegisterUpdater
RegisterUpdater(IUpdater)
RegisterUpdater(IUpdater,Boolean)
RegisterUpdater(IUpdater,Document)
RegisterUpdater(IUpdater,Document,Boolean) 

public static void RegisterUpdater(
	IUpdater updater,
	Document document,
	bool isOptional
)

  • IUpdater
    updater
    Updater to be registered.
  • Document
    document
    Document for which this updater is to be registered.
  • Boolean
    isOptional
    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.

  • 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.
  • ArgumentNullException
    A non-optional argument was null
  • 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.

Share a snippet Help the community

Loading…