UpdaterRegistry.SetIsUpdaterOptional

Public Class

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

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

Syntax

public static void SetIsUpdaterOptional(
  UpdaterId id,
  bool isOptional
)

Parameters

id UpdaterId

Id of the updater

isOptionalBoolean

Use True to make the updater optional, false to make it a mandatory updater.

Exceptions

Exception

Condition

ArgumentException

Updater with this Id is not currently registered in Revit.

ArgumentNullException

A non-optional argument was null

Remarks

This flag controls whether an updater is going to be required next time a document in which it had been used is opened. If a non-optional updater is not found (currently not registered) in a document, the end user will be presented with a warning and choices to resolve the situation.