Autodesk.Revit.UI.UIDocument

The Autodesk.Revit.UI.UIDocument is a class in the Revit API that represents a document in the Revit user interface (UI). It provides access to the elements that make up the document, the views that display them, and the parameters that define their characteristics.

Properties

The UIDocument class has several properties that allow you to access information about the document, including:

• Application: An instance of the Autodesk.Revit.ApplicationServices.Application class that represents the Revit application.
• Document: An instance of the Autodesk.Revit.DB.Document class that represents the document itself.
• CurrentView: An instance of the Autodesk.Revit.DB.View class that represents the current view in the document.
• Selection: An instance of the Autodesk.Revit.UI.Selection.Selection class that represents the current selection in the document.

Methods

The UIDocument class also contains methods that allow you to interact with the document, including:

• Close(bool save): Closes the current document, optionally saving any changes.
• GetElement(ElementId id): Returns the element with the specified ID from the document.
• GetElementsByType(Type type): Returns a collection of elements of the specified type from the document.
• PickObject(ObjectType objectType, string message): Prompts the user to select an object of the specified type and returns the selected object.

Events

The UIDocument class also defines several events that allow you to respond to changes in the document, including:

• ViewActivated: Raised when a view is activated in the document.
• ViewChanged: Raised when the view changes in the document.
• SelectionChanged: Raised when the selection changes in the document.

Usage

To use the UIDocument class, you need to create an instance of the Autodesk.Revit.UI.UIDocument class and pass it a reference to the current Revit document. You can then use the properties and methods of the class to interact with the document and its elements.

UIDocument uiDocument = new UIDocument(document);

Remarks

The Autodesk.Revit.UI.UIDocument class is an essential part of the Revit API, allowing developers to programmatically access and manipulate the elements and views in a Revit document. Its properties, methods, and events provide a powerful set of tools for creating custom Revit applications and workflows.