UIDocument Methods


UIDocument Methods

The UIDocument type exposes the following members.

Methods
Name Description
Public method CanPlaceElementType Verifies that the user can be prompted to place the input element type interactively.
Public method Dispose
Public method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object )
Public method GetHashCode Serves as the default hash function.
(Inherited from Object )
Public method GetOpenUIViews Get a list of all open view windows in the Revit user interface.
Public method GetPlacementTypes Get a collection of valid placement types for input family symbol.
Public method Static member 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.
Public method GetSketchGalleryOptions Gets the valid sketch gallery options of a family symbol.
Public method GetType Gets the Type of the current instance.
(Inherited from Object )
Public method 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.
Public method PromptForFamilyInstancePlacement(FamilySymbol) Prompts the user to place instances of the specified FamilySymbol.
Public method PromptForFamilyInstancePlacement(FamilySymbol, PromptForFamilyInstancePlacementOptions) Prompts the user to place instances of the specified FamilySymbol.
Public method PromptToMatchElementType Prompts the user to select elements to change them to the input type.
Public method PromptToPlaceElementTypeOnLegendView Prompts the user to place an element type onto a legend view.
Public method PromptToPlaceViewOnSheet Prompts the user to place a specified view onto a sheet.
Public method RefreshActiveView Refresh the display of the active view in the active document.
Public method RequestViewChange Requests an asynchronous change of the active view in the currently active document.
Public method SaveAndClose Close the document, prompting the user for saving it when necessary.
Public method SaveAs Saves the document to a file name obtained from the Revit user without prompting the user to overwrite file if it exists.
Public method SaveAs(UISaveAsOptions) Saves the document to a file name obtained from the Revit user optionally prompting the user to overwrite file if it exists.
Public method ShowElements(Element) Shows the element by zoom to fit.
Public method ShowElements(ElementId) Shows the element by zoom to fit.
Public method ShowElements(ElementSet) Shows the elements by zoom to fit.
Public method ShowElements(ICollection ElementId ) Shows the elements by zoom to fit.
Public method ToString Returns a string that represents the current object.
(Inherited from Object )
Public method 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.
Top
See Also