2021 Members
Changes 4
M

DocumentEntryPoint

Name Return Type Description Inherited From
M AcquireCoordinates(ElementId) None Acquires coordinates from the specified link instance. (Inherited from Document .) Document
M AutoJoinElements() None Forces the elements in the Revit document to automatically join to their neighbors where appropriate. (Inherited from Document .) Document
M CanEnableCloudWorksharing() bool Checks if cloud worksharing can be enabled for the cloud model. (Inherited from Document .) Document
M CanEnableWorksharing() bool Checks if worksharing can be enabled in the document. (Inherited from Document .) Document
M Close.() bool Closes the document, save the changes if there are. (Inherited from Document .) Document
M Close(Boolean) bool Closes the document with the option to save. (Inherited from Document .) Document
M CombineElements(CombinableElementArray) GeomCombination Combine a set of combinable elements into a geometry combination. (Inherited from Document .) Document
M ConvertDetailToModelCurves(View, DetailCurveArray) ModelCurveArray Converts a group of DetailCurves to equivalent ModelCurves. (Inherited from Document .) Document
M ConvertModelToDetailCurves(View, ModelCurveArray) DetailCurveArray Converts a group of ModelCurves to equivalent DetailCurves. (Inherited from Document .) Document
M ConvertModelToSymbolicCurves(View, ModelCurveArray) SymbolicCurveArray Converts a group of ModelCurves to equivalent SymbolicCurves. (Inherited from Document .) Document
M ConvertSymbolicToModelCurves(View, SymbolicCurveArray) ModelCurveArray Converts a group of SymbolicCurves to equivalent ModelCurves. (Inherited from Document .) Document
M Delete(ElementId) ICollection<ElementId> Deletes an element from the document given the id of that element. (Inherited from Document .) Document
M Delete(ICollection.ElementId.) ICollection<ElementId> Deletes a set of elements from the document. (Inherited from Document .) Document
M Dispose() None (Inherited from Document .) Document
M EditFamily(Family) Document Gets the document of a loaded family to edit. (Inherited from Document .) Document
M EnableCloudWorksharing() None Enables cloud worksharing for a cloud model (Inherited from Document .) Document
M EnableWorksharing(String, String) None Enables worksharing in the document. (Inherited from Document .) Document
M Equals(Object) bool Determines whether the specified Object equals to this Object . (Inherited from Document .) Document
M EraseSchemaAndAllEntities(Schema) None Erases Schema and all its Entities from the document. (Inherited from Document .) Document
M Export(String, String, MassGBXMLExportOptions) None Exports a gbXML file from a mass model document. (Inherited from Document .) Document
M Export(String, String, GBXMLExportOptions) bool Export the model in gbXML (green-building) format. (Inherited from Document .) Document
M Export(String, String, IFCExportOptions) bool Exports the document to the Industry Standard Classes (IFC) format. (Inherited from Document .) Document
M Export(String, String, NavisworksExportOptions) None Exports a Revit project to the Navisworks .nwc format. (Inherited from Document .) Document
M Export(String, String, ViewSet, DWFExportOptions) bool Exports the current view or a selection of views in DWF format. (Inherited from Document .) Document
M Export(String, String, ViewSet, DWFXExportOptions) bool Exports the current view or a selection of views in DWFX format. (Inherited from Document .) Document
M Export(String, String, ViewSet, FBXExportOptions) bool Exports the document in 3D-Studio Max (FBX) format. (Inherited from Document .) Document
M Export(String, String, ICollection.ElementId., DGNExportOptions) bool Exports a selection of views in DGN format. (Inherited from Document .) Document
M Export(String, String, ICollection.ElementId., DWGExportOptions) bool Exports a selection of views in DWG format. (Inherited from Document .) Document
M Export(String, String, ICollection.ElementId., DXFExportOptions) bool Exports a selection of views in DXF format. (Inherited from Document .) Document
M Export(String, String, ICollection.ElementId., SATExportOptions) bool Exports the current view or a selection of views in SAT format. (Inherited from Document .) Document
M ExportImage(ImageExportOptions) None Exports a view or set of views into an image file. (Inherited from Document .) Document
M FinishInitializationEO() None For Revit Macros internal use only.
M GetCloudModelPath() ModelPath Gets the cloud model path of the cloud model. (Inherited from Document .) Document
M GetDefaultElementTypeId(ElementTypeGroup) ElementId Gets the default element type id with the given DefaultElementType id. (Inherited from Document .) Document
M GetDefaultFamilyTypeId(ElementId) ElementId Gets the default family type id with the given family category id. (Inherited from Document .) Document
M GetDocumentPreviewSettings() The preview settings. Returns the preview settings for the given document. (Inherited from Document .) Document
M GetElement(String) Element Gets the Element referenced by a unique id string. (Inherited from Document .) Document
M GetElement(ElementId) Element Gets the Element referenced by the input ElementId. (Inherited from Document .) Document
M GetElement(Reference) Element Gets the Element referenced by the input reference. (Inherited from Document .) Document
M GetHashCode() int Gets the hash code of this document instance. (Inherited from Document .) Document
M GetPaintedMaterial(ElementId, Face) ElementId Get the material painted on the element's face. Returns invalidElementId if the face is not painted. (Inherited from Document .) Document
M GetPrintSettingIds() ICollection<ElementId> Retrieves all Print Settings of current project. (Inherited from Document .) Document
M GetRoomAtPoint(XYZ) Room Gets a room containing the point. (Inherited from Document .) Document
M GetRoomAtPoint(XYZ, Phase) Room Gets a room containing the point. (Inherited from Document .) Document
M GetSpaceAtPoint(XYZ) Space Gets a space containing the point. (Inherited from Document .) Document
M GetSpaceAtPoint(XYZ, Phase) Space Gets a space containing the point. (Inherited from Document .) Document
M GetSubelement(String) Subelement Gets the subelement referenced by a unique id string. (Inherited from Document .) Document
M GetSubelement(Reference) Subelement Gets the subelement referenced by the input reference. (Inherited from Document .) Document
M GetSubelement(ElementId, Int32) Subelement Gets the subelement referenced by a parent id and subelement id. (Inherited from Document .) Document
M GetType None (Inherited from Object .) Object .
M GetUnits() The Units object. Gets the Units object. (Inherited from Document .) Document
M GetWarnings() IList<FailureMessage> Returns list of failure messages generated from persistent (reviewable) warnings accumulated in the document. (Inherited from Document .) Document
M GetWorksetId(ElementId) WorksetId Get Id of the Workset which owns the element. (Inherited from Document .) Document
M GetWorksetTable() WorksetTable Get the WorksetTable of this document. (Inherited from Document .) Document
M GetWorksharingCentralModelPath() ModelPath Gets the central model path of the worksharing model. (Inherited from Document .) Document
M HasAllChangesFromCentral() bool Returns whether the model in the current session is up to date with central. (Inherited from Document .) Document
M Import(String, GBXMLImportOptions) bool Imports a Green-Building XML file into the document. (Inherited from Document .) Document
M Import(String, SATImportOptions, View) ElementId Imports an SAT file into the document. (Inherited from Document .) Document
M Import(String, SKPImportOptions, View) ElementId Imports an SKP file into the document. (Inherited from Document .) Document
M Import(String, DGNImportOptions, View, ElementId.) bool Imports a DGN file to the document. (Inherited from Document .) Document
M Import(String, DWGImportOptions, View, ElementId.) bool Imports a DWG or DXF file to the document. (Inherited from Document .) Document
M Initialize(Object, String) None For Revit Macros internal use only.
M IsBackgroundCalculationInProgress() bool Indicates whether there are any background calculations in progress for this document. (Inherited from Document .) Document
M IsDefaultElementTypeIdValid(ElementTypeGroup, ElementId) bool Checks whether the element type id is valid for the give DefaultElmentType id. (Inherited from Document .) Document
M IsDefaultFamilyTypeIdValid(ElementId, ElementId) bool Checks whether the family type id is valid for the give family category. (Inherited from Document .) Document
M IsPainted(ElementId, Face) bool Checks if the element's face is painted with a material. (Inherited from Document .) Document
M Link(String, DWFImportOptions) IList<ElementId> Links Markups in a DWF file into the project document. (Inherited from Document .) Document
M Link(String, SATImportOptions, View) ElementId Links an SAT file into the project document. (Inherited from Document .) Document
M Link(String, SKPImportOptions, View) ElementId Links an SKP file into the project document. (Inherited from Document .) Document
M Link(String, DGNImportOptions, View, ElementId.) bool Links a DGN file into the project document. (Inherited from Document .) Document
M Link(String, DWGImportOptions, View, ElementId.) bool Links a DWG or DXF file into the project document. (Inherited from Document .) Document
M LoadFamily(String) bool Loads an entire family and all its types/symbols into the document. (Inherited from Document .) Document
M LoadFamily(Document) Family Loads the contents of this family document into another document. (Inherited from Document .) Document
M LoadFamily(String, Family.) bool Loads an entire family and all its types/symbols into the document and provides a reference to the loaded family. (Inherited from Document .) Document
M LoadFamily(Document, IFamilyLoadOptions) Family Loads the contents of this family document into another document. (Inherited from Document .) Document
M LoadFamily(String, IFamilyLoadOptions, Family.) bool Loads an entire family and all its types/symbols into the document and provides a reference to the loaded family. (Inherited from Document .) Document
M LoadFamilySymbol(String, String) bool Loads only a specified family type/symbol from a family file into the document. (Inherited from Document .) Document
M LoadFamilySymbol(String, String, FamilySymbol.) bool Loads only the specified family type/symbol from a family file into the document and provides a reference to the loaded family symbol. (Inherited from Document .) Document
M LoadFamilySymbol(String, String, IFamilyLoadOptions, FamilySymbol.) bool Loads only the specified family type/symbol from a family file into the document and provides a reference to the loaded family symbol. (Inherited from Document .) Document
M MakeTransientElements(ITransientElementMaker) None This method encapsulates the process of creating transient elements in the document. (Inherited from Document .) Document
M OnShutdownEO() None For Revit Macros internal use only.
M Paint(ElementId, Face, ElementId) None Paint the element's face with specified material. (Inherited from Document .) Document
M Paint(ElementId, Face, FamilyParameter) None Paint the element's face with specified material. (Inherited from Document .) Document
M PostFailure(FailureMessage) FailureMessageKey Posts a failure to be displayed to the user at the end of transaction. (Inherited from Document .) Document
M Print(ViewSet) None Prints a set of views with default view template and default print settings. (Inherited from Document .) Document
M Print(ViewSet, View) None Prints a set of views with a specified view template and default print settings. (Inherited from Document .) Document
M Print(ViewSet, Boolean) None Prints a set of views with default view template and default print settings. (Inherited from Document .) Document
M Print(ViewSet, View, Boolean) None Prints a set of views with a specified view template and default print settings. (Inherited from Document .) Document
M PublishCoordinates(LinkElementId) None Publish coordinates to the specified ProjectLocation of the link instance. (Inherited from Document .) Document
M Regenerate() None Updates the elements in the Revit document to reflect all changes. (Inherited from Document .) Document
M ReloadLatest(ReloadLatestOptions) None Fetches changes from central (due to one or more synchronizations with central) and merges them into the current session. (Inherited from Document .) Document
M RemovePaint(ElementId, Face) None Remove the material painted on the element's face. If the face is currently not painted,it will do nothing. (Inherited from Document .) Document
M Save.() None Saves the document. (Inherited from Document .) Document
M Save(SaveOptions) None Saves the document. (Inherited from Document .) Document
M SaveAs(String) None Saves the document to a given file path. (Inherited from Document .) Document
M SaveAs(String, SaveAsOptions) None Saves the document to a given file path. (Inherited from Document .) Document
M SaveAs(ModelPath, SaveAsOptions) None Saves the document to a given path. (Inherited from Document .) Document
M SaveAsCloudModel(String, String) None Obsolete. Saves current nonworkshared model as a cloud model in BIM 360. (Inherited from Document .) Document
M SaveAsCloudModel(Guid, Guid, String, String) None Saves current nonworkshared model as a cloud model in BIM 360. (Inherited from Document .) Document
M SaveCloudModel() None Saves cloud model. (Inherited from Document .) Document
M SaveToProjectAsImage(ImageExportOptions) ElementId Creates an image view from the currently active view. (Inherited from Document .) Document
M SeparateElements(CombinableElementArray) None Separate a set of combinable elements out of combinations they currently belong to. (Inherited from Document .) Document
M SetDefaultElementTypeId(ElementTypeGroup, ElementId) None Sets the default element type id of the given DefaultElementType id. (Inherited from Document .) Document
M SetDefaultFamilyTypeId(ElementId, ElementId) None Sets the default family type id for the given family category. (Inherited from Document .) Document
M SetUnits(Units) None Sets the units. (Inherited from Document .) Document
M SynchronizeWithCentral(TransactWithCentralOptions, SynchronizeWithCentralOptions) None Performs reload latest until the model in the current session is up to date and then saves changes back to central. A save to central is performed even if no changes were made. (Inherited from Document .) Document
M ToString None (Inherited from Object .) Object .
M UnpostFailure(FailureMessageKey) None Deletes the posted failure message associated with a given FailureMessageKey. (Inherited from Document .) Document
Name Return Type Description Inherited From
P ActiveProjectLocation ProjectLocation Retrieve the active project location. (Inherited from Document .) Document
P ActiveView View The document's active view. (Inherited from Document .) Document
P AddinFolder string The full path to the Revit Macros module.
P Application Application Returns the Application in which the Document resides. (Inherited from Document .) Document
P Create Document An object that can be used to create new instances of Autodesk Revit API elements within a project. (Inherited from Document .) Document
P DisplayUnitSystem DisplayUnit Provides access to display unit type with in the document. (Inherited from Document .) Document
P FamilyCreate FamilyItemFactory An object that can be used to create new instances of Autodesk Revit API elements within a family document. (Inherited from Document .) Document
P FamilyManager FamilyManager The family manager object provides access to family types and parameters. (Inherited from Document .) Document
P IsDetached bool Identifies if a workshared document is detached. Also, see IsWorkshared (Inherited from Document .) Document
P IsFamilyDocument bool Identifies if the current document is a family document. (Inherited from Document .) Document
P IsLinked bool Identifies if a document is a linked RVT. (Inherited from Document .) Document
P IsModelInCloud bool Identifies if document is stored on Autodesk cloud services. (Inherited from Document .) Document
P IsModifiable bool The document's state of modifiability. (Inherited from Document .) Document
P IsModified bool The state of changes made to the document. (Inherited from Document .) Document
P IsReadOnly bool Identifies if the document is read-only or can possibly be modified. (Inherited from Document .) Document
P IsReadOnlyFile bool Signals whether the document was opened from a read-only file. (Inherited from Document .) Document
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. (Inherited from Document .) Document
P IsWorkshared bool Identifies if worksharing (i.e. editing permissions and multiple worksets) have been enabled in the document. Also, see IsDetached (Inherited from Document .) Document
P MassDisplayTemporaryOverride MassDisplayTemporaryOverrideType This setting controls temporary display in views of objects with mass category or subcategories. (Inherited from Document .) Document
P MullionTypes MullionTypeSet This property is used to retrieve all the mullion types in current system. (Inherited from Document .) Document
P OwnerFamily Family Get the Family of this Family Document. (Inherited from Document .) Document
P PanelTypes PanelTypeSet Retrieves a set of PanelType objects that contains all the panel types that are currently loaded into the project. (Inherited from Document .) Document
P ParameterBindings BindingMap Retrieves an object from which mappings between parameter definitions and categories can be found. (Inherited from Document .) Document
P PathName string The fully qualified path of the document's disk file. (Inherited from Document .) Document
P Phases PhaseArray Retrieves all the object that represent phases within the project. (Inherited from Document .) Document
P PlanTopologies PlanTopologySet Get the PlanTopologies of the current project in the last phase. (Inherited from Document .) Document
P PlanTopologies.Phase. PlanTopologySet Gets the PlanTopologies of the current project in a given phase. (Inherited from Document .) Document
P PlanTopology.Level. PlanTopology Get the PlanTopology of a given level in the last phase. (Inherited from Document .) Document
P PlanTopology.Level, Phase. PlanTopology Get the PlanTopology of a given level in a given phase. (Inherited from Document .) Document
P PrintManager PrintManager Retrieve the PrintManager of current project. (Inherited from Document .) Document
P ProjectInformation ProjectInfo Return the Project Information of the current project. (Inherited from Document .) Document
P ProjectLocations ProjectLocationSet Retrieve all the project locations associated with this project (Inherited from Document .) Document
P ReactionsAreUpToDate bool Reports if the analytical model has regenerated in a document with reaction loads. (Inherited from Document .) Document
P Settings Settings Provides access to general application settings, such as Categories. (Inherited from Document .) Document
P SiteLocation SiteLocation Returns the site location information. (Inherited from Document .) Document
P Title string The document's title. (Inherited from Document .) Document
P TypeOfStorage StorageType Get the storage type of the specified BuiltInParameter. (Inherited from Document .) Document
P WorksharingCentralGUID Guid The central GUID of the server-based model. (Inherited from Document .) Document