2027 Class
Changes 6
C

UIControlledApplication

Description:
Represents the Autodesk Revit user interface, providing access to UI customization methods and events.
Remarks:
This class does not provide access to documents because it is provided to you through the ExternalApplication OnStartup()/OnShutdown() methods, and those methods are when it is not possible to work with Revit documents. You can work with documents by getting them from the UIApplication class; that class is obtained from events and ExternalCommand callbacks.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.UI.UIControlledApplication
Name Return Type Description Inherited From
E ApplicationClosing event Subscribe to the ApplicationClosing event to be notified when the Revit application is just about to be closed.
E DialogBoxShowing event Subscribe to the DialogBoxShowing event to be notified when Revit is just about to show a dialog box or a message box.
E DisplayingOptionsDialog event Subscribe to the options dialog displaying event to be notified when Revit options dialog is displaying.
E DockableFrameFocusChanged event Subscribe to this event to be notified when a Revit GenericDockableFrame has gained focus or lost focus in the Revit user interface. This event is called only for API-created GenericDockableFrames.
E DockableFrameVisibilityChanged event Subscribe to this event to be notified when a Revit GenericDockableFrame has been shown or hidden in the Revit user interface. This event is called only for API-created GenericDockableFrames.
E FabricationPartBrowserChanged event Subscribe to MEP Fabrication part browser changed event to be notified when MEP Fabrication part browser is updated.
E FormulaEditing event Subscribe to the FormulaEditing event to be notified when the edit formula button has been clicked.
E Idling event Subscribe to the Idling event to be notified when Revit is not in an active tool or transaction.
E SelectionChanged event Subscribe to the SelectionChanged event to be notified after the selection was changed.
E ThemeChanged event Subscribe to the ThemeChanged event to be notified after the theme was changed.
E TransferredProjectStandards event Subscribe to the TransferredProjectStandards event to be notified after the scope of a Transfer Project Standards operation has been finalized.
E TransferringProjectStandards event Subscribe to the TransferringProjectStandards event to be notified before the scope of an impending Transfer Project Standards operation has been finalized in the Transfer Project Standards dialog.
E ViewActivated event Subscribe to the ViewActivated event to be notified immediately after Revit has finished activating a view of a document.
E ViewActivating event Subscribe to the ViewActivating event to be notified when Revit is just about to activate a view of a document.
Name Return Type Description Inherited From
M CreateAddInCommandBinding(RevitCommandId) AddInCommandBinding Creates a new AddInCommandBinding.
M CreateRibbonPanel(String) RibbonPanel Create a new RibbonPanel on the Add-Ins tab.
M CreateRibbonPanel(String, String) RibbonPanel Create a new RibbonPanel on the specified tab.
M CreateRibbonPanel(Tab, String) RibbonPanel Create a new RibbonPanel on the designated standard Revit tab.
M CreateRibbonTab(String) None Creates a new tab on the Revit user interface.
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetDockablePane(DockablePaneId) DockablePane Gets a DockablePane object by its ID.
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetRibbonPanels() List<RibbonPanel> Get all the custom Panels on Add-Ins tab of Revit.
M GetRibbonPanels(String) List<RibbonPanel> Get all the custom Panels on a designated Revit tab.
M GetRibbonPanels(Tab) List<RibbonPanel> Get all the custom Panels on a designated standard Revit tab.
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M LoadAddIn(String) None Loads add-ins from the given manifest file.
M LoadPackageContents(String) None Loads add-ins from the given packageContents.xml file.
M RegisterContextMenu(String, IContextMenuCreator) None Adds a new context menu creator.
M RegisterDockablePane(DockablePaneId, String, IDockablePaneProvider) None Adds a new dockable pane to the Revit user interface.
M RemoveAddInCommandBinding(RevitCommandId) None Removes an AddInCommandBinding.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P ActiveAddInId AddInId Get current active external application or external command id.
P ControlledApplication ControlledApplication Returns the database level ControlledApplication represented by this UI-level ControlledApplication.
P IsLateAddinLoading bool Indicates whether this add-in is loaded on the fly or not. If it is loaded when Revit is starting up, it is false, otherwise it should be true.
P IsViewerModeActive bool Determines if Revit session is in Viewer mode.
P LoadedApplications ExternalApplicationArray Returns an array of successfully loaded external applications.
P MainWindowHandle IntPtr Get the handle of the Revit main window.
P ProductIsRS bool Identifies if the current Revit product has an RS designation. Most add-ins will not need to use this information.