UIControlledApplication

Public Class

Represents the Autodesk Revit user interface, providing access to UI customization methods and events.

Inheritance Hierarchy

System.Object
Autodesk.Revit.UI.UIControlledApplication

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

Syntax

public class UIControlledApplication

The UIControlledApplication type exposes the following members.

Properties

Name

Description

Public Property

ActiveAddInId

Get current active external application or external command id.

Public Property

ControlledApplication

Returns the database level ControlledApplication represented by this UI-level ControlledApplication.

Public Property

IsLateAddinLoading

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.

Public Property

IsViewerModeActive

Determines if Revit session is in Viewer mode.

Public Property
LoadedApplications

Returns an array of successfully loaded external applications.

Public Property
MainWindowHandle

Get the handle of the Revit main window.

Public Property

ProductIsRS

Identifies if the current Revit product has an RS designation. Most add-ins will not need to use this information.

Methods

Name

Description

Public Method

CreateAddInCommandBinding

Creates a new AddInCommandBinding.

Public Method
Code Example
CreateRibbonPanel(String)

Create a new RibbonPanel on the Add-Ins tab.

Public Method
CreateRibbonPanel(String, String)

Create a new RibbonPanel on the specified tab.

Public Method
CreateRibbonPanel(Tab, String)

Create a new RibbonPanel on the designated standard Revit tab.

Public Method
Code Example
CreateRibbonTab

Creates a new tab on the Revit user interface.

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetDockablePane

Gets a DockablePane object by its ID.

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method
GetRibbonPanels.

Get all the custom Panels on Add-Ins tab of Revit.

Public Method
GetRibbonPanels(String)

Get all the custom Panels on a designated Revit tab.

Public Method
GetRibbonPanels(Tab)

Get all the custom Panels on a designated standard Revit tab.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
LoadAddIn

Loads add-ins from the given manifest file.

Public Method

LoadPackageContents

Loads add-ins from the given packageContents.xml file.

Public Method
RegisterContextMenu

Adds a new context menu creator.

Public Method
Code Example

RegisterDockablePane

Adds a new dockable pane to the Revit user interface.

Public Method

RemoveAddInCommandBinding

Removes an AddInCommandBinding.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Events

Name

Description

Public Event
ApplicationClosing

Subscribe to the ApplicationClosing event to be notified when the Revit application is just about to be closed.

Public Event
Code Example
DialogBoxShowing

Subscribe to the DialogBoxShowing event to be notified when Revit is just about to show a dialog box or a message box.

Public Event

DisplayingOptionsDialog

Subscribe to the options dialog displaying event to be notified when Revit options dialog is displaying.

Public Event
DockableFrameFocusChanged

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.

Public Event
DockableFrameVisibilityChanged

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.

Public Event
FabricationPartBrowserChanged

Subscribe to MEP Fabrication part browser changed event to be notified when MEP Fabrication part browser is updated.

Public Event

FormulaEditing

Subscribe to the FormulaEditing event to be notified when the edit formula button has been clicked.

Public Event
Code Example
Idling

Subscribe to the Idling event to be notified when Revit is not in an active tool or transaction.

Public Event
SelectionChanged

Subscribe to the SelectionChanged event to be notified after the selection was changed.

Public Event
ThemeChanged

Subscribe to the ThemeChanged event to be notified after the theme was changed.

Public Event
TransferredProjectStandards

Subscribe to the TransferredProjectStandards event to be notified after the scope of a Transfer Project Standards operation has been finalized.

Public Event
TransferringProjectStandards

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.

Public Event
ViewActivated

Subscribe to the ViewActivated event to be notified immediately after Revit has finished activating a view of a document.

Public Event
ViewActivating

Subscribe to the ViewActivating event to be notified when Revit is just about to activate a view of a document.

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.