Sign in
2027 Class Back to 2027
C

UIApplication

Version comparison
2020 2021 2022 2023 2024 2025 2025.3 2026 2027

Members across versions

49 members across 9 versions · 5 added later · 1 removed · 4 changed · 1 obsolete

Member-name color: stable · changed · removed · obsolete · added later

Member 2020 2021 2022 2023 2024 2025 2025.3 2026 2027
C UIApplication(Application)
same same same same same same same same same
M CanPostCommand(RevitCommandId)
same same same same same same same same same
M CreateAddInCommandBinding(RevitCommandId)
same same same same same same same same same
M CreateRibbonPanel(Tab, String)
same same same same same same same same same
M CreateRibbonPanel(String)
same same same same same same same same same
M CreateRibbonPanel(String, String)
same same same same same same same same same
M CreateRibbonTab(String)
same same same same same same same same same
M Dispose
same same same same same same same same same
M DoDragDrop(Object, IDropHandler)
same same same same same same same same same
M DoDragDrop(ICollection<String>)
same same same same same same same same same
M GetDockablePane(DockablePaneId)
same same same same same same same same same
M GetRibbonPanels(String)
same same same same same same same same same
M GetRibbonPanels(Tab)
same same same same same same same same same
M GetRibbonPanels
same same same same same same same same same
M LoadAddIn(String)
same same same same same same same same same
M LoadPackageContents(String)
same same same same same same same same same
M OpenAndActivateDocument(String)
same same same same same changed same same same
M OpenAndActivateDocument(ModelPath, OpenOptions, Boolean)
same same same same same changed same same same
M OpenAndActivateDocument(ModelPath, OpenOptions, Boolean, IOpenFromCloudCallback)
same same same same same changed same same same
M PostCommand(RevitCommandId)
same same same same same same same same same
M RegisterContextMenu(String, IContextMenuCreator)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added same same same
M RegisterDockablePane(DockablePaneId, String, IDockablePaneProvider)
same same same same same same same same same
M RemoveAddInCommandBinding(RevitCommandId)
same same same same same same same same same
P ActiveAddInId
same same same same same same same same same
P ActiveUIDocument
same same same same same same same same same
P Application
same same same same same same same same same
P DrawingAreaExtents
same same same same same same same same same
P IsValidObject
same same same same same same same same same
P IsViewerModeActive
same same same same same same same same changed
P LoadedApplications
same same same same same same same same same
P MainWindowExtents
same same same same same same same same same
P MainWindowHandle
same same same same same same same same same
P ProductIsRS
same same same same same same same same same
E ApplicationClosing
same same same same same same same same same
E DialogBoxShowing
same same same same same same same same same
E DisplayingOptionsDialog
same same same same same same same same same
E DockableFrameFocusChanged
same same same same same same same same same
E DockableFrameVisibilityChanged
same same same same same same same same same
E ExternalDataManagerChanged
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added missing missing
E FabricationPartBrowserChanged
same same same same same same same same same
E FormulaEditing
same same same same same same same same same
E Idling
same same same same same same same same same
E MacroUpdated
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added same same same
E SelectionChanged
not yet introduced not yet introduced not yet introduced added same same same same same
E ThemeChanged
not yet introduced not yet introduced not yet introduced not yet introduced added same same same same
E TransferredProjectStandards
same same same same same same same same same
E TransferringProjectStandards
same same same same same same same same same
E ViewActivated
same same same same same same same same same
E ViewActivating
same same same same same same same same same

Per-version detail

Click a version below to see what changed in that release vs your current frame (2027).
2027 current

Changes in 2020 vs 2027 4 missing 4 changed

Flip API Versions →

Missing in 2020 (only available in 2027)

RegisterContextMenu(String, IContextMenuCreator) MacroUpdated SelectionChanged ThemeChanged

Changed members

UIApplication.OpenAndActivateDocument(String)
fileName String A full path to a revit file to be opened. The file can be either a Revit project, template, or family document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean, IOpenFromCloudCallback)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
openFromCloudCallback IOpenFromCloudCallback Callback function that allow caller to handle cases when conflicts happen during opening a cloud document. Make no sense when opening a non-cloud document.
→ returns UIDocument The opened document.
UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean

Changes in 2021 vs 2027 4 missing 4 changed

Flip API Versions →

Missing in 2021 (only available in 2027)

RegisterContextMenu(String, IContextMenuCreator) MacroUpdated SelectionChanged ThemeChanged

Changed members

UIApplication.OpenAndActivateDocument(String)
fileName String A full path to a revit file to be opened. The file can be either a Revit project, template, or family document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean, IOpenFromCloudCallback)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
openFromCloudCallback IOpenFromCloudCallback Callback function that allow caller to handle cases when conflicts happen during opening a cloud document. Make no sense when opening a non-cloud document.
→ returns UIDocument The opened document.
UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean

Changes in 2022 vs 2027 4 missing 4 changed

Flip API Versions →

Missing in 2022 (only available in 2027)

RegisterContextMenu(String, IContextMenuCreator) MacroUpdated SelectionChanged ThemeChanged

Changed members

UIApplication.OpenAndActivateDocument(String)
fileName String A full path to a revit file to be opened. The file can be either a Revit project, template, or family document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean, IOpenFromCloudCallback)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
openFromCloudCallback IOpenFromCloudCallback Callback function that allow caller to handle cases when conflicts happen during opening a cloud document. Make no sense when opening a non-cloud document.
→ returns UIDocument The opened document.
UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean

Changes in 2023 vs 2027 3 missing 4 changed

Flip API Versions →

Missing in 2023 (only available in 2027)

RegisterContextMenu(String, IContextMenuCreator) MacroUpdated ThemeChanged

Changed members

UIApplication.OpenAndActivateDocument(String)
fileName String A full path to a revit file to be opened. The file can be either a Revit project, template, or family document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean, IOpenFromCloudCallback)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
openFromCloudCallback IOpenFromCloudCallback Callback function that allow caller to handle cases when conflicts happen during opening a cloud document. Make no sense when opening a non-cloud document.
→ returns UIDocument The opened document.
UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean

Changes in 2024 vs 2027 2 missing 4 changed

Flip API Versions →

Missing in 2024 (only available in 2027)

RegisterContextMenu(String, IContextMenuCreator) MacroUpdated

Changed members

UIApplication.OpenAndActivateDocument(String)
fileName String A full path to a revit file to be opened. The file can be either a Revit project, template, or family document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
→ returns UIDocument The opened document.
UIApplication.OpenAndActivateDocument(ModelPath, OpenOptions, Boolean, IOpenFromCloudCallback)
modelPath ModelPath A path to a Revit file to be opened. The file can be either a Revit project, template, or family document.
openOptions OpenOptions Options for opening the file.
detachAndPrompt Boolean True means if openOptions specifies DoNotDetach, then for workshared models detach from central and query the user whether to preserve or discard worksets. make no sense when opening a cloud document.
openFromCloudCallback IOpenFromCloudCallback Callback function that allow caller to handle cases when conflicts happen during opening a cloud document. Make no sense when opening a non-cloud document.
→ returns UIDocument The opened document.
UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean

Changes in 2025 vs 2027 1 changed

Flip API Versions →

Changed members

UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean

Changes in 2025.3 vs 2027 1 added 1 changed

Flip API Versions →

Added in 2025.3 (new since 2027)

ExternalDataManagerChanged

Changed members

UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean

Changes in 2026 vs 2027 1 changed

Flip API Versions →

Changed members

UIApplication.IsViewerModeActive()
Became obsolete in 2027: This property is deprecated in Revit 2027 and may be removed in a later version of Revit.
→ returns Boolean