| Revit 2020 API |
| UIDocument Members |
| UIDocument Class Constructors Methods Properties See Also |
The UIDocument type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | UIDocument |
Use a database level Document to construct a UI-level Document.
|
Methods
| Name | Description | |
|---|---|---|
| CanPlaceElementType |
Verifies that the user can be prompted to place the input element type interactively.
|
| Dispose | Releases all resources used by the UIDocument |
| Equals | (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetOpenUIViews | Get a list of all open view windows in the Revit user interface. |
| GetPlacementTypes |
Get a collection of valid placement types for input family symbol.
|
 | GetRevitUIFamilyLoadOptions | Return the option object that allows you to use Revit's dialog boxes to let the user respond to questions that arise during loading of families. |
| GetSketchGalleryOptions |
Gets the valid sketch gallery options of a family symbol.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| PostRequestForElementTypePlacement |
Places a request on Revit's command queue for the user to place instances of the specified ElementType. This does not execute immediately,
but instead when control returns to Revit from the current API context.
|
| PromptForFamilyInstancePlacement(FamilySymbol) | Prompts the user to place instances of the specified FamilySymbol. |
| PromptForFamilyInstancePlacement(FamilySymbol, PromptForFamilyInstancePlacementOptions) | Prompts the user to place instances of the specified FamilySymbol. |
| PromptToMatchElementType |
Prompts the user to select elements to change them to the input type.
|
| PromptToPlaceElementTypeOnLegendView |
Prompts the user to place an element type onto a legend view.
|
| PromptToPlaceViewOnSheet |
Prompts the user to place a specified view onto a sheet.
|
| RefreshActiveView | Refresh the display of the active view in the active document. |
| RequestViewChange |
Requests an asynchronous change of the active view in the currently active document.
|
| SaveAndClose | Close the document, prompting the user for saving it when necessary. |
| SaveAs()()()() |
Saves the document to a file name obtained from the Revit user without prompting the user to overwrite file if it exists.
|
| SaveAs(UISaveAsOptions) |
Saves the document to a file name obtained from the Revit user optionally prompting the user to overwrite file if it exists.
|
| ShowElements(Element) | Shows the element by zoom to fit. |
| ShowElements(ElementId) | Shows the element by zoom to fit. |
| ShowElements(ICollection<(Of <<'(ElementId>)>>)) | Shows the elements by zoom to fit. |
| ShowElements(ElementSet) | Shows the elements by zoom to fit. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateAllOpenViews |
Update all open views in this document after elements have been changed, deleted, selected or de-selected.
Graphics in the views are fully redrawn regardless of which elements have changed.
|
Properties
| Name | Description | |
|---|---|---|
 | ActiveGraphicalView |
The currently active graphical view of the currently active document.
|
| ActiveView |
The currently active view of the currently active document.
|
| Application | Retrieves an object that represents the current Application. |
| Document | Returns the database level document represented by this UI-level document. |
| IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
|
| Selection | Retrieve the currently selected Elements in Autodesk Revit. |