2024 Members
Changes 4
M

DocumentEntryPoint Methods

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, IList.ElementId., PDFExportOptions) bool Exports a selection of views in PDF format. (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, OBJExportOptions) bool Exports a view specified in the export options to the OBJ format. (Inherited from Document .) Document
M Export(String, String, STLExportOptions) bool Exports a view specified in the export options to the STL 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 GetAllUnusedElements(ISet<ElementId>) Unused element ids. Returns the list of element ids that are not used. The list of unused element ids may include elements that can't be deleted. (Inherited from Document .) Document
M GetChangedElements(Guid) DocumentDifference Extracts a collection containing the ids of elements that have been created, modified or deleted between the input baseVersion and the document's current version. (Inherited from Document .) Document
M GetCloudFolderId(Boolean) string Gets ForgeDM folder id where the model locates. (Inherited from Document .) Document
M GetCloudModelPath() ModelPath Gets the cloud model path of the cloud model. (Inherited from Document .) Document
M GetCloudModelUrn() string A ForgeDM Urn identifying the 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 GetHubId() string Gets ForgeDM hub id where the model locates. It is cached in session. (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 GetProjectId() string Gets ForgeDM project id where the model locates. (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 Gets the Type of the current instance. (Inherited from Object .) Object .
M GetTypeOfStorage(ForgeTypeId) StorageType Get the storage type of the identified built-in parameter. (Inherited from Document .) Document
M GetUnits() The Units object. Gets the Units object. (Inherited from Document .) Document
M GetUnusedElements(ISet<ElementId>) ISet<ElementId> Returns the list of element ids that are not used and can be deleted from the document. (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, AXMImportOptions, View) ElementId Imports an AXM file into the document. (Inherited from Document .) Document
M Import(String, ImportOptions3DM, View) ElementId Imports a 3DM file into the document. (Inherited from Document .) Document
M Import(String, OBJImportOptions, View) ElementId Imports an OBJ 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 a SKP file into the document. (Inherited from Document .) Document
M Import(String, STLImportOptions, View) ElementId Imports an STL 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, ImportOptions3DM, View) ElementId Links a 3DM file into the project document. (Inherited from Document .) Document
M Link(String, OBJImportOptions, View) ElementId Links an OBJ 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 a SKP file into the project document. (Inherited from Document .) Document
M Link(String, STLImportOptions, View) ElementId Links an STL 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 ResetSharedCoordinates() None Reset shared coordinates for the host model/file. (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(Guid, Guid, String, String) None Saves current non-workshared or workshared model as a cloud model or workshared cloud model in BIM 360 Docs or Autodesk Docs. (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 Returns a string that represents the current object. (Inherited from Object .) Object .
M UnpostFailure(FailureMessageKey) None Deletes the posted failure message associated with a given FailureMessageKey. (Inherited from Document .) Document