Sign in
2020 Class Back to 2020
C

Document

Version comparison
2020 2021 2022 2023 2024 2025 2025.3 2026 2027

Members across versions

240 members across 9 versions · 28 added later · 10 removed · 37 changed · 15 obsolete

Member-name color: stable · changed · removed · obsolete · added later

Member 2020 2021 2022 2023 2024 2025 2025.3 2026 2027
M AcquireCoordinates(ElementId)
same same same same same same same same same
M AutoJoinElements
same same same same same same same same same
M CanEnableCloudWorksharing
same same same same same same same same same
M CanEnableWorksharing
same same same same same same same same same
M Close(Boolean)
same same same same same same same same same
M Close
same same same same same same same same same
M CombineElements(CombinableElementArray)
same same same same same same same same same
M ConvertDetailToModelCurves(View, DetailCurveArray)
same same same same same same same same same
M ConvertModelToDetailCurves(View, ModelCurveArray)
same same same same same same same same same
M ConvertModelToSymbolicCurves(View, ModelCurveArray)
same same same same same same same same same
M ConvertSymbolicToModelCurves(View, SymbolicCurveArray)
same same same same same same same same same
M Delete(ICollection<ElementId>)
same same same same same same same same same
M Delete(ElementId)
same same same same same same same same same
M Dispose
same same same same same same same same same
M EditFamily(Family)
same same same same same same same same same
M EnableCloudWorksharing
same same same same same same same same same
M EnableWorksharing(String, String)
same same same same same same same same same
M Equals(Object)
same same same same same same same same same
M EraseSchemaAndAllEntities(Schema)
not yet introduced added same same same same same same same
M Export(String, String, ICollection<ElementId>, SATExportOptions)
same same same same same same same same same
M Export(String, String, IFCExportOptions)
same same same same same same same same same
M Export(String, String, ViewSet, DWFExportOptions)
same same same same same same same same same
M Export(String, String, ICollection<ElementId>, DWGExportOptions)
same same same same same same same same same
M Export(String, String, ICollection<ElementId>, DGNExportOptions)
same same same same same same same same same
M Export(String, String, GBXMLExportOptions)
same same same same same same same same same
M Export(String, String, MassGBXMLExportOptions)
same same same changed missing missing missing missing missing
M Export(String, String, NavisworksExportOptions)
same same same same same same same same same
M Export(String, String, ICollection<ElementId>, DXFExportOptions)
same same same same same same same same same
M Export(String, String, ViewSet, FBXExportOptions)
same same same same same same same same same
M Export(String, String, ViewSet, DWFXExportOptions)
same same same same same same same same same
M Export(String, String, STLExportOptions)
not yet introduced not yet introduced added same same same same same same
M Export(String, IList<ElementId>, PDFExportOptions)
not yet introduced not yet introduced added same same same same same same
M Export(String, String, OBJExportOptions)
not yet introduced not yet introduced not yet introduced added same same same same same
M Export(String, String, STEPExportOptions)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added same same same
M ExportImage(ImageExportOptions)
same same same same same same same same same
M GetActiveEditMode
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added same
M GetAllUnusedElements(ISet<ElementId>)
not yet introduced not yet introduced not yet introduced not yet introduced added changed same same same
M GetChangedElements(Guid)
not yet introduced not yet introduced not yet introduced added same same same same same
M GetCloudFolderId(Boolean)
not yet introduced not yet introduced added same same same same same same
M GetCloudModelPath
same same same same same same same same same
M GetCloudModelUrn
not yet introduced not yet introduced added same same same same same same
M GetDefaultElementTypeId(ElementTypeGroup)
same same same same same same same same same
M GetDefaultFamilyTypeId(ElementId)
same same same same same same same same same
M GetDocumentPreviewSettings
same same same same same changed same same same
M GetDocumentVersion(Document)
same same same same same same same same same
M GetElement(Reference)
same same same same same same same same same
M GetElement(String)
same same same same same same same same same
M GetElement(ElementId)
same same same same same same same same same
M GetHashCode
same same same same same same same same same
M GetHubId
not yet introduced not yet introduced added same same same same same same
M GetPaintedMaterial(ElementId, Face)
same same same same same same same same same
M GetPrintSettingIds
same same same same same same same same same
M GetProjectId
not yet introduced not yet introduced added same same same same same same
M GetRoomAtPoint(XYZ)
same same same same same same same same same
M GetRoomAtPoint(XYZ, Phase)
same same same same same same same same same
M GetSpaceAtPoint(XYZ)
same same same same same same same same same
M GetSpaceAtPoint(XYZ, Phase)
same same same same same same same same same
M GetSubelement(Reference)
same same same same same same same same same
M GetSubelement(ElementId, Int32)
same same same same same same same same same
M GetSubelement(String)
same same same same same same same same same
M GetTypeOfStorage(ForgeTypeId)
not yet introduced not yet introduced added same same same same same same
M GetUnits
same same same same same changed same same same
M GetUnusedElements(ISet<ElementId>)
not yet introduced not yet introduced not yet introduced not yet introduced added same same same same
M GetWarnings
same same same same same same same same same
M GetWorksetId(ElementId)
same same same same same same same same same
M GetWorksetTable
same same same same same same same same same
M GetWorksharingCentralModelPath
same same same same same same same same same
M HasAllChangesFromCentral
same same same same same same same same same
M Import(String, SKPImportOptions, View)
same same same same same same same same same
M Import(String, DGNImportOptions, View, ElementId%)
same same same same same same same same same
M Import(String, DWGImportOptions, View, ElementId%)
same same same same same same same same same
M Import(String, ImageImportOptions, View, Element%)
same missing missing missing missing missing missing missing missing
M Import(String, GBXMLImportOptions)
same same same same same same same same same
M Import(String, SATImportOptions, View)
same same same same same same same same same
M Import(String, ImportOptions3DM, View)
not yet introduced not yet introduced added same same same same same same
M Import(String, STLImportOptions, View)
not yet introduced not yet introduced not yet introduced added same same same same same
M Import(String, OBJImportOptions, View)
not yet introduced not yet introduced not yet introduced added same same same same same
M Import(String, AXMImportOptions, View)
not yet introduced not yet introduced not yet introduced added same same same same changed
M Import(String, STEPImportOptions, View)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added same same same
M IsBackgroundCalculationInProgress
same same same same same same same same same
M IsDefaultElementTypeIdValid(ElementTypeGroup, ElementId)
same same same same same same same same same
M IsDefaultFamilyTypeIdValid(ElementId, ElementId)
same same same same same same same same same
M IsInEditMode
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added same same
M IsPainted(ElementId, Face)
same same same same same same same same same
M IsValidVersionGUID(Document, Guid)
not yet introduced not yet introduced not yet introduced added same same same same same
M Link(String, SKPImportOptions, View)
same same same same same same same same same
M Link(String, DGNImportOptions, View, ElementId%)
same same same same same same same same same
M Link(String, DWFImportOptions)
same same same same same same same same same
M Link(String, DWGImportOptions, View, ElementId%)
same same same same same same same same same
M Link(String, SATImportOptions, View)
same same same same same same same same same
M Link(String, ImportOptions3DM, View)
not yet introduced not yet introduced added same same same same same same
M Link(String, OBJImportOptions, View)
not yet introduced not yet introduced not yet introduced added same same same same same
M Link(String, STLImportOptions, View)
not yet introduced not yet introduced not yet introduced added same same same same same
M Link(String, STEPImportOptions, View)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added same same same
M LoadFamily(String, Family%)
same same same same same same same same same
M LoadFamily(String)
same same same same same same same same same
M LoadFamily(Document, IFamilyLoadOptions)
same same same same same same same same same
M LoadFamily(Document)
same same same same same same same same same
M LoadFamily(String, IFamilyLoadOptions, Family%)
same same same same same same same same same
M LoadFamilySymbol(String, String, IFamilyLoadOptions, FamilySymbol%)
same same same same same same same same same
M LoadFamilySymbol(String, String)
same same same same same same same same same
M LoadFamilySymbol(String, String, FamilySymbol%)
same same same same same same same same same
M MakeTransientElements(ITransientElementMaker)
same same same same same same same same same
M NewArea(ViewPlan, UV)
same same same same same same same same same
M NewAreaBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
same same same same same changed same same changed
M NewAreaBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
same same same same same changed same same changed
M NewAreaBoundaryLine(SketchPlane, Curve, ViewPlan)
same same same same same same same same same
M NewAreas(List<AreaCreationData>)
same same same same same same same same same
M NewAreaTag(ViewPlan, Area, UV)
same same same same same same same same same
M NewCrossFitting(Connector, Connector, Connector, Connector)
same same same same same same same same same
M NewCurtainSystem(FaceArray, CurtainSystemType)
same same same same same same same same same
M NewCurtainSystem2(ReferenceArray, CurtainSystemType)
same same same same same same same same same
M NewElbowFitting(Connector, Connector)
same same same same same same same same same
M NewExtrusionRoof(CurveArray, ReferencePlane, Level, RoofType, Double, Double)
same same same same same same same same same
M NewFamilyInstance(XYZ, FamilySymbol, Element, Level, StructuralType)
same same same same same changed same same same
M NewFamilyInstance(Curve, FamilySymbol, Level, StructuralType)
same same same same same changed same same same
M NewFamilyInstance(XYZ, FamilySymbol, Level, StructuralType)
same same same same missing missing missing missing missing
M NewFascia(FasciaType, ReferenceArray)
same same same same same changed same same same
M NewFascia(FasciaType, Reference)
same same same same same changed same same same
M NewFlexDuct(Connector, IList<XYZ>, FlexDuctType)
same same same same same same same same same
M NewFlexDuct(Connector, Connector, FlexDuctType)
same same same same same same same same same
M NewFlexDuct(IList<XYZ>, FlexDuctType)
same same same same same same same same same
M NewFlexPipe(IList<XYZ>, FlexPipeType)
same same same same same same same same same
M NewFlexPipe(Connector, IList<XYZ>, FlexPipeType)
same same same same same same same same same
M NewFlexPipe(Connector, Connector, FlexPipeType)
same same same same same same same same same
M NewFloor(CurveArray, FloorType, Level, Boolean)
same same changed missing missing missing missing missing missing
M NewFloor(CurveArray, FloorType, Level, Boolean, XYZ)
same same changed missing missing missing missing missing missing
M NewFloor(CurveArray, Boolean)
same same changed missing missing missing missing missing missing
M NewFootPrintRoof(CurveArray, Level, RoofType, ModelCurveArray%)
same same same same same same same same same
M NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ)
same same changed missing missing missing missing missing missing
M NewGutter(GutterType, ReferenceArray)
same same same same same changed same same same
M NewGutter(GutterType, Reference)
same same same same same changed same same same
M NewLineBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
same same same same same changed same same changed
M NewLineBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
same same same same same changed same same changed
M NewMechanicalSystem(Connector, ConnectorSet, DuctSystemType)
same same same same same same same same same
M NewOpening(Wall, XYZ, XYZ)
same same same same same same same same same
M NewOpening(Element, CurveArray, eRefFace)
same same same same same same same same same
M NewOpening(Level, Level, CurveArray)
same same same same same same same same same
M NewOpening(Element, CurveArray, Boolean)
same same same same same same same same same
M NewPipingSystem(Connector, ConnectorSet, PipeSystemType)
same same same same same same same same same
M NewPointBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
same same same same same changed same same changed
M NewRoom(Phase)
same same same same same changed same same same
M NewRoom(Room, PlanCircuit)
same same same same same changed same same same
M NewRoom(Level, UV)
same same same same same changed same same same
M NewRoomBoundaryLines(SketchPlane, CurveArray, View)
same same same same same same same same same
M NewRooms2(Level)
same same same same same changed same same same
M NewRooms2(Level, Phase)
same same same same same same same same same
M NewRooms2(Phase, Int32)
same same same same same same same same same
M NewRoomTag(LinkElementId, UV, ElementId)
same same same same same changed same same same
M NewSlab(CurveArray, Level, Line, Double, Boolean)
same same changed missing missing missing missing missing missing
M NewSlabEdge(SlabEdgeType, ReferenceArray)
same same same same same changed same same same
M NewSlabEdge(SlabEdgeType, Reference)
same same same same same changed same same same
M NewSpace(Level, UV)
same same same same same changed same same same
M NewSpace(Level, Phase, UV)
same same same same same changed same same same
M NewSpace(Phase)
same same same same same changed same same same
M NewSpaceBoundaryLines(SketchPlane, CurveArray, View)
same same same same same same same same same
M NewSpaces2(Phase, Int32)
same same same same same changed same same same
M NewSpaces2(Level, Phase, View)
same same same same same same same same same
M NewSpaceTag(Space, UV, View)
same same same same same changed same same same
M NewSpotCoordinate(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
same same same same same changed same same same
M NewSpotElevation(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
same same same same same changed same same same
M NewTakeoffFitting(Connector, MEPCurve)
same same same same same same same same same
M NewTeeFitting(Connector, Connector, Connector)
same same same same same same same same same
M NewTransitionFitting(Connector, Connector)
same same same same same same same same same
M NewUnionFitting(Connector, Connector)
same same same same same same same same same
M NewZone(Level, Phase)
same same same same same changed same changed missing
M Paint(ElementId, Face, FamilyParameter)
same same same same same same same same same
M Paint(ElementId, Face, ElementId)
same same same same same same same same same
M PostFailure(FailureMessage)
same same same same same same same same same
M Print(ViewSet)
same same same same same same same same same
M Print(ViewSet, View)
same same same same same same same same same
M Print(ViewSet, Boolean)
same same same same same same same same same
M Print(ViewSet, View, Boolean)
same same same same same same same same same
M PublishCoordinates(LinkElementId)
same same same same same same same same same
M Regenerate
same same same same same same same same same
M ReloadLatest(ReloadLatestOptions)
same same same same same same same same same
M RemovePaint(ElementId, Face)
same same same same same same same same same
M ResetSharedCoordinates
not yet introduced not yet introduced added same same same same same same
M Save
same same same same same same same same same
M Save(SaveOptions)
same same same same same same same same same
M SaveAs(ModelPath, SaveAsOptions)
same same same same same same same same same
M SaveAs(String)
same same same same same same same same same
M SaveAs(String, SaveAsOptions)
same same same same same same same same same
M SaveAsCloudModel(String, String)
same changed missing missing missing missing missing missing missing
M SaveAsCloudModel(Guid, Guid, String, String)
not yet introduced added same same same same same same same
M SaveCloudModel
same same same same same same same same same
M SaveToProjectAsImage(ImageExportOptions)
same same same same same same same same same
M SeparateElements(CombinableElementArray)
same same same same same same same same same
M SetDefaultElementTypeId(ElementTypeGroup, ElementId)
same same same same same same same same same
M SetDefaultFamilyTypeId(ElementId, ElementId)
same same same same same same same same same
M SetUnits(Units)
same same same same same same same same same
M SynchronizeWithCentral(TransactWithCentralOptions, SynchronizeWithCentralOptions)
same same same same same same same same same
M UnpostFailure(FailureMessageKey)
same same same same same same same same same
P ActiveProjectLocation
same same same same same same same same same
P ActiveView
same same same same same same same same same
P Application
same same same same same same same same same
P Create
same same same same same same same same same
P CreationGUID
not yet introduced not yet introduced not yet introduced not yet introduced added same same same same
P DisplayUnitSystem
same same same same same same same same same
P FamilyCreate
same same same same same same same same same
P FamilyManager
same same same same same same same same same
P IsDetached
same same same same same same same same same
P IsFamilyDocument
same same same same same same same same same
P IsLinked
same same same same same same same same same
P IsModelInCloud
same same same same same same same same same
P IsModifiable
same same same same same same same same same
P IsModified
same same same same same same same same same
P IsReadOnly
same same same same same same same same same
P IsReadOnlyFile
same same same same same same same same same
P IsValidObject
same same same same same same same same same
P IsWorkshared
same same same same same same same same same
P MassDisplayTemporaryOverride
same same same same same same same same same
P MullionTypes
same same same same same same same same same
P OwnerFamily
same same same same same same same same same
P PanelTypes
same same same same same same same same same
P ParameterBindings
same same same same same same same same same
P PathName
same same same same same same same same same
P Phases
same same same same same same same same same
P PlanTopologies(Phase)
same same same same same same same same same
P PlanTopologies
same same same same same same same same same
P PlanTopology(Level, Phase)
same same same same same same same same same
P PlanTopology(Level)
same same same same same same same same same
P PrintManager
same same same same same same same same same
P ProjectInformation
same same same same same same same same same
P ProjectLocations
same same same same same same same same same
P ReactionsAreUpToDate
same same same same same same same same same
P Settings
same same same same same same same same same
P SiteLocation
same same same same same same same same same
P Title
same same same same same same same same same
P TypeOfStorage(BuiltInParameter)
same same same same same same same same same
P WorksharingCentralGUID
same same same same same same same same same
E DocumentClosing
same same same same same same same same same
E DocumentPrinted
same same same same same same same same same
E DocumentPrinting
same same same same same same same same same
E DocumentSaved
same same same same same same same same same
E DocumentSavedAs
same same same same same same same same same
E DocumentSaving
same same same same same same same same same
E DocumentSavingAs
same same same same same same same same same
E ViewPrinted
same same same same same same same same same
E ViewPrinting
same same same same same same same same same

Per-version detail

Click a version below to see what changed in that release vs your current frame (2020).
2020 current

Changes in 2021 vs 2020 2 added 1 missing 1 changed

Flip API Versions →

Added in 2021 (new since 2020)

EraseSchemaAndAllEntities(Schema) SaveAsCloudModel(Guid, Guid, String, String)

Missing in 2021 (only available in 2020)

Import(String, ImageImportOptions, View, Element%)

Changed members

Document.SaveAsCloudModel(String, String)
No longer obsolete in 2020 (was obsolete in 2021)
folderId String Folder identity in BIM 360 to save the model.
modelName String Model name in BIM 360 to save the model.

Changes in 2022 vs 2020 12 added 2 missing 5 changed

Flip API Versions →

Added in 2022 (new since 2020)

EraseSchemaAndAllEntities(Schema) Export(String, String, STLExportOptions) Export(String, IList<ElementId>, PDFExportOptions) GetCloudFolderId(Boolean) GetCloudModelUrn GetHubId GetProjectId GetTypeOfStorage(ForgeTypeId) Import(String, ImportOptions3DM, View) Link(String, ImportOptions3DM, View) ResetSharedCoordinates SaveAsCloudModel(Guid, Guid, String, String)

Missing in 2022 (only available in 2020)

Import(String, ImageImportOptions, View, Element%) SaveAsCloudModel(String, String)

Changed members

Document.NewFloor(CurveArray, FloorType, Level, Boolean)
No longer obsolete in 2020 (was obsolete in 2022)
profile CurveArray An array of planar lines and arcs that represent the horizontal profile of the floor.
floorType FloorType A floor type to be used by the new floor instead of the default type.
level Level The level on which the floor is to be placed.
structural Boolean If set, specifies that the floor is structural in nature.
→ returns nullNothingnullptr if successful, a new floor object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFloor(CurveArray, FloorType, Level, Boolean, XYZ)
No longer obsolete in 2020 (was obsolete in 2022)
profile CurveArray An array of planar lines and arcs that represent the horizontal profile of the floor.
floorType FloorType A floor type to be used by the new floor instead of the default type.
level Level The level on which the floor is to be placed.
structural Boolean If set, specifies that the floor is structural in nature.
normal XYZ A vector that must be perpendicular to the profile which dictates which side of the floor is considered to be upper and down.
→ returns nullNothingnullptr if successful, a new floor object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFloor(CurveArray, Boolean)
No longer obsolete in 2020 (was obsolete in 2022)
profile CurveArray An array of planar lines and arcs that represent the horizontal profile of the floor.
structural Boolean If set, specifies that the floor is structural in nature.
→ returns nullNothingnullptr If successful a new floor object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ)
No longer obsolete in 2020 (was obsolete in 2022)
profile CurveArray An array of planar lines and arcs that represent the horizontal profile of the floor.
floorType FloorType A floor type to be used by the new floor instead of the default type.
level Level The level on which the floor is to be placed.
structural Boolean If set, specifies that the floor is structural in nature.
normal XYZ A vector that must be perpendicular to the profile which dictates which side of the floor is considered to be upper and down.
→ returns nullNothingnullptr if successful, a new foundation slab object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlab(CurveArray, Level, Line, Double, Boolean)
No longer obsolete in 2020 (was obsolete in 2022)
profile CurveArray An array of planar lines and arcs that represent the horizontal profile of the slab.
level Level The level on which the slab is to be placed.
slopedArrow Line A line use to control the sloped angle of the slab. It should be in the same face with profile.
slope Double The slope.
isStructural Boolean If set, specifies that the floor is structural in nature.
→ returns nullNothingnullptr If successful a new floor object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .

Changes in 2023 vs 2020 20 added 7 missing 1 changed

Flip API Versions →

Added in 2023 (new since 2020)

EraseSchemaAndAllEntities(Schema) Export(String, String, STLExportOptions) Export(String, IList<ElementId>, PDFExportOptions) Export(String, String, OBJExportOptions) GetChangedElements(Guid) GetCloudFolderId(Boolean) GetCloudModelUrn GetHubId GetProjectId GetTypeOfStorage(ForgeTypeId) Import(String, ImportOptions3DM, View) Import(String, STLImportOptions, View) Import(String, OBJImportOptions, View) Import(String, AXMImportOptions, View) IsValidVersionGUID(Document, Guid) Link(String, ImportOptions3DM, View) Link(String, OBJImportOptions, View) Link(String, STLImportOptions, View) ResetSharedCoordinates SaveAsCloudModel(Guid, Guid, String, String)

Missing in 2023 (only available in 2020)

Import(String, ImageImportOptions, View, Element%) NewFloor(CurveArray, FloorType, Level, Boolean) NewFloor(CurveArray, FloorType, Level, Boolean, XYZ) NewFloor(CurveArray, Boolean) NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ) NewSlab(CurveArray, Level, Line, Double, Boolean) SaveAsCloudModel(String, String)

Changed members

Document.Export(String, String, MassGBXMLExportOptions)
No longer obsolete in 2020 (was obsolete in 2023)
folder String Indicates the path of a folder where to export the gbXML file.
name String Indicates the name of the gbXML file to export. If it doesn't end with ".xml", extension ".xml" will be added automatically. The name cannot contain any of the following characters: \/:*?"<>|. Empty name is not acceptable.
options MassGBXMLExportOptions Options which control the contents of the export.

Changes in 2024 vs 2020 23 added 9 missing

Flip API Versions →

Added in 2024 (new since 2020)

EraseSchemaAndAllEntities(Schema) Export(String, String, STLExportOptions) Export(String, IList<ElementId>, PDFExportOptions) Export(String, String, OBJExportOptions) GetAllUnusedElements(ISet<ElementId>) GetChangedElements(Guid) GetCloudFolderId(Boolean) GetCloudModelUrn GetHubId GetProjectId GetTypeOfStorage(ForgeTypeId) GetUnusedElements(ISet<ElementId>) Import(String, ImportOptions3DM, View) Import(String, STLImportOptions, View) Import(String, OBJImportOptions, View) Import(String, AXMImportOptions, View) IsValidVersionGUID(Document, Guid) Link(String, ImportOptions3DM, View) Link(String, OBJImportOptions, View) Link(String, STLImportOptions, View) ResetSharedCoordinates SaveAsCloudModel(Guid, Guid, String, String) CreationGUID

Missing in 2024 (only available in 2020)

Export(String, String, MassGBXMLExportOptions) Import(String, ImageImportOptions, View, Element%) NewFamilyInstance(XYZ, FamilySymbol, Level, StructuralType) NewFloor(CurveArray, FloorType, Level, Boolean) NewFloor(CurveArray, FloorType, Level, Boolean, XYZ) NewFloor(CurveArray, Boolean) NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ) NewSlab(CurveArray, Level, Line, Double, Boolean) SaveAsCloudModel(String, String)

Changes in 2025 vs 2020 26 added 9 missing 28 changed

Flip API Versions →

Added in 2025 (new since 2020)

EraseSchemaAndAllEntities(Schema) Export(String, String, STLExportOptions) Export(String, IList<ElementId>, PDFExportOptions) Export(String, String, OBJExportOptions) Export(String, String, STEPExportOptions) GetAllUnusedElements(ISet<ElementId>) GetChangedElements(Guid) GetCloudFolderId(Boolean) GetCloudModelUrn GetHubId GetProjectId GetTypeOfStorage(ForgeTypeId) GetUnusedElements(ISet<ElementId>) Import(String, ImportOptions3DM, View) Import(String, STLImportOptions, View) Import(String, OBJImportOptions, View) Import(String, AXMImportOptions, View) Import(String, STEPImportOptions, View) IsValidVersionGUID(Document, Guid) Link(String, ImportOptions3DM, View) Link(String, OBJImportOptions, View) Link(String, STLImportOptions, View) Link(String, STEPImportOptions, View) ResetSharedCoordinates SaveAsCloudModel(Guid, Guid, String, String) CreationGUID

Missing in 2025 (only available in 2020)

Export(String, String, MassGBXMLExportOptions) Import(String, ImageImportOptions, View, Element%) NewFamilyInstance(XYZ, FamilySymbol, Level, StructuralType) NewFloor(CurveArray, FloorType, Level, Boolean) NewFloor(CurveArray, FloorType, Level, Boolean, XYZ) NewFloor(CurveArray, Boolean) NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ) NewSlab(CurveArray, Level, Line, Double, Boolean) SaveAsCloudModel(String, String)

Changed members

Document.GetDocumentPreviewSettings()
→ returns DocumentPreviewSettings The preview settings.
Document.GetUnits()
→ returns Units The Units object.
Document.NewAreaBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
hostElement Element A Wall, Slab or Slab Foundation to host the boundary conditions.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewAreaBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference The Geometry reference obtained from a Wall, Slab or Slab Foundation.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewFamilyInstance(XYZ, FamilySymbol, Element, Level, StructuralType)
location XYZ The physical location where the instance is to be placed on the specified level.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
host Element A host object into which the instance will be embedded
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFamilyInstance(Curve, FamilySymbol, Level, StructuralType)
curve Curve The curve where the instance is based.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, ReferenceArray)
FasciaType FasciaType The type of the fascia to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, Reference)
FasciaType FasciaType The type of the fascia to create
reference Reference A planar line or arc that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, ReferenceArray)
GutterType GutterType The type of the gutter to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, Reference)
GutterType GutterType The type of the gutter to create
reference Reference A planar line or arc that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewLineBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
hostElement Element A Beam.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewLineBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference The Geometry reference to a Beam's, Wall's, Wall Foundation's, Slab's or Slab Foundation's analytical line.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewPointBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference A Geometry reference to a Beam's, Brace's or Column's analytical line end.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring".
Y_Rotation TranslationRotationValue A value indicating the option for rotation about the Y axis.
Y_RotationSpringModulus Double Rotation Spring Modulus for Y axis. Ignored if Y_Rotation is not "Spring".
Z_Rotation TranslationRotationValue A value indicating the option for rotation about the Z axis.
Z_RotationSpringModulus Double Rotation Spring Modulus for Z axis. Ignored if Y_Rotation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewPointBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 0 - "Point". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewRoom(Phase)
phase Phase The phase in which the room is to exist.
→ returns Room→nullNothingnullptr If successful the new room , otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Room, PlanCircuit)
room Room The room which you want to locate in the circuit. Pass <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to create a new room.
circuit PlanCircuit The circuit in which you want to locate a room.
→ returns Room→nullNothingnullptr If successful the room is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Level, UV)
level Level The level on which the room is to exist.
point UV A 2D point that dictates the location of the room on that specified level.
→ returns Room→nullNothingnullptr If successful the new room will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRooms2(Level)
level Level The level from which the circuits are found.
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds which contains the rooms created should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoomTag(LinkElementId, UV, ElementId)
roomId LinkElementId The HostOrLinkElementId of the Room.
point UV A 2D point that defines the tag location on the level of the room.
viewId ElementId The id of the view where the tag will be shown. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> and the room in not in a Revit link, the view of the room will be used.
→ returns RoomTag→nullNothingnullptr If successful a RoomTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, ReferenceArray)
SlabEdgeType SlabEdgeType The type of the slab edge to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, Reference)
SlabEdgeType SlabEdgeType The type of the slab edge to create
reference Reference A planar line or arc that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, UV)
level Level The level on which the space is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful the new space element is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, Phase, UV)
level Level The level on which the room is to exist.
phase Phase The phase in which the room is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful a new Space element within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Phase)
phase Phase The phase in which the space is to exist.
→ returns Space→nullNothingnullptr If successful the new space should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaces2(Phase, Int32)
phase Phase The phase in which the spaces are to exist.
count Int32
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds of new unplaced spaces are be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaceTag(Space, UV, View)
space Space The Space which the tag refers.
point UV A 2D point that dictates the location on the level of the space.
view View The view where the tag will lie.
→ returns SpaceTag→nullNothingnullptr If successful a SpaceTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) . Suitable exceptions will be fired if the parameters are invalid.
Document.NewSpotCoordinate(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot coordinate is to be visible.
reference Reference The reference to which the spot coordinate is to be bound.
origin XYZ The point which the spot coordinate evaluate.
bend XYZ The bend point for the spot coordinate.
end XYZ The end point for the spot coordinate.
refPt XYZ The actual point on the reference which the spot coordinate evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpotElevation(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot elevation is to be visible.
reference Reference The reference to which the spot elevation is to be bound.
origin XYZ The point which the spot elevation evaluate.
bend XYZ The bend point for the spot elevation.
end XYZ The end point for the spot elevation.
refPt XYZ The actual point on the reference which the spot elevation evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewZone(Level, Phase)
level Level The level on which the Zone is to exist.
phase Phase The associative phase on which the Zone is to exist.
→ returns Zone→nullNothingnullptr If successful a new Zone element within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .

Changes in 2025.3 vs 2020 27 added 9 missing 28 changed

Flip API Versions →

Added in 2025.3 (new since 2020)

EraseSchemaAndAllEntities(Schema) Export(String, String, STLExportOptions) Export(String, IList<ElementId>, PDFExportOptions) Export(String, String, OBJExportOptions) Export(String, String, STEPExportOptions) GetAllUnusedElements(ISet<ElementId>) GetChangedElements(Guid) GetCloudFolderId(Boolean) GetCloudModelUrn GetHubId GetProjectId GetTypeOfStorage(ForgeTypeId) GetUnusedElements(ISet<ElementId>) Import(String, ImportOptions3DM, View) Import(String, STLImportOptions, View) Import(String, OBJImportOptions, View) Import(String, AXMImportOptions, View) Import(String, STEPImportOptions, View) IsInEditMode IsValidVersionGUID(Document, Guid) Link(String, ImportOptions3DM, View) Link(String, OBJImportOptions, View) Link(String, STLImportOptions, View) Link(String, STEPImportOptions, View) ResetSharedCoordinates SaveAsCloudModel(Guid, Guid, String, String) CreationGUID

Missing in 2025.3 (only available in 2020)

Export(String, String, MassGBXMLExportOptions) Import(String, ImageImportOptions, View, Element%) NewFamilyInstance(XYZ, FamilySymbol, Level, StructuralType) NewFloor(CurveArray, FloorType, Level, Boolean) NewFloor(CurveArray, FloorType, Level, Boolean, XYZ) NewFloor(CurveArray, Boolean) NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ) NewSlab(CurveArray, Level, Line, Double, Boolean) SaveAsCloudModel(String, String)

Changed members

Document.GetDocumentPreviewSettings()
→ returns DocumentPreviewSettings The preview settings.
Document.GetUnits()
→ returns Units The Units object.
Document.NewAreaBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
hostElement Element A Wall, Slab or Slab Foundation to host the boundary conditions.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewAreaBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference The Geometry reference obtained from a Wall, Slab or Slab Foundation.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewFamilyInstance(XYZ, FamilySymbol, Element, Level, StructuralType)
location XYZ The physical location where the instance is to be placed on the specified level.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
host Element A host object into which the instance will be embedded
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFamilyInstance(Curve, FamilySymbol, Level, StructuralType)
curve Curve The curve where the instance is based.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, ReferenceArray)
FasciaType FasciaType The type of the fascia to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, Reference)
FasciaType FasciaType The type of the fascia to create
reference Reference A planar line or arc that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, ReferenceArray)
GutterType GutterType The type of the gutter to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, Reference)
GutterType GutterType The type of the gutter to create
reference Reference A planar line or arc that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewLineBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
hostElement Element A Beam.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewLineBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference The Geometry reference to a Beam's, Wall's, Wall Foundation's, Slab's or Slab Foundation's analytical line.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewPointBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference A Geometry reference to a Beam's, Brace's or Column's analytical line end.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring".
Y_Rotation TranslationRotationValue A value indicating the option for rotation about the Y axis.
Y_RotationSpringModulus Double Rotation Spring Modulus for Y axis. Ignored if Y_Rotation is not "Spring".
Z_Rotation TranslationRotationValue A value indicating the option for rotation about the Z axis.
Z_RotationSpringModulus Double Rotation Spring Modulus for Z axis. Ignored if Y_Rotation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewPointBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 0 - "Point". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewRoom(Phase)
phase Phase The phase in which the room is to exist.
→ returns Room→nullNothingnullptr If successful the new room , otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Room, PlanCircuit)
room Room The room which you want to locate in the circuit. Pass <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to create a new room.
circuit PlanCircuit The circuit in which you want to locate a room.
→ returns Room→nullNothingnullptr If successful the room is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Level, UV)
level Level The level on which the room is to exist.
point UV A 2D point that dictates the location of the room on that specified level.
→ returns Room→nullNothingnullptr If successful the new room will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRooms2(Level)
level Level The level from which the circuits are found.
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds which contains the rooms created should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoomTag(LinkElementId, UV, ElementId)
roomId LinkElementId The HostOrLinkElementId of the Room.
point UV A 2D point that defines the tag location on the level of the room.
viewId ElementId The id of the view where the tag will be shown. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> and the room in not in a Revit link, the view of the room will be used.
→ returns RoomTag→nullNothingnullptr If successful a RoomTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, ReferenceArray)
SlabEdgeType SlabEdgeType The type of the slab edge to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, Reference)
SlabEdgeType SlabEdgeType The type of the slab edge to create
reference Reference A planar line or arc that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, UV)
level Level The level on which the space is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful the new space element is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, Phase, UV)
level Level The level on which the room is to exist.
phase Phase The phase in which the room is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful a new Space element within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Phase)
phase Phase The phase in which the space is to exist.
→ returns Space→nullNothingnullptr If successful the new space should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaces2(Phase, Int32)
phase Phase The phase in which the spaces are to exist.
count Int32
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds of new unplaced spaces are be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaceTag(Space, UV, View)
space Space The Space which the tag refers.
point UV A 2D point that dictates the location on the level of the space.
view View The view where the tag will lie.
→ returns SpaceTag→nullNothingnullptr If successful a SpaceTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) . Suitable exceptions will be fired if the parameters are invalid.
Document.NewSpotCoordinate(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot coordinate is to be visible.
reference Reference The reference to which the spot coordinate is to be bound.
origin XYZ The point which the spot coordinate evaluate.
bend XYZ The bend point for the spot coordinate.
end XYZ The end point for the spot coordinate.
refPt XYZ The actual point on the reference which the spot coordinate evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpotElevation(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot elevation is to be visible.
reference Reference The reference to which the spot elevation is to be bound.
origin XYZ The point which the spot elevation evaluate.
bend XYZ The bend point for the spot elevation.
end XYZ The end point for the spot elevation.
refPt XYZ The actual point on the reference which the spot elevation evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewZone(Level, Phase)
level Level The level on which the Zone is to exist.
phase Phase The associative phase on which the Zone is to exist.
→ returns Zone→nullNothingnullptr If successful a new Zone element within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .

Changes in 2026 vs 2020 28 added 9 missing 28 changed

Flip API Versions →

Added in 2026 (new since 2020)

EraseSchemaAndAllEntities(Schema) Export(String, String, STLExportOptions) Export(String, IList<ElementId>, PDFExportOptions) Export(String, String, OBJExportOptions) Export(String, String, STEPExportOptions) GetActiveEditMode GetAllUnusedElements(ISet<ElementId>) GetChangedElements(Guid) GetCloudFolderId(Boolean) GetCloudModelUrn GetHubId GetProjectId GetTypeOfStorage(ForgeTypeId) GetUnusedElements(ISet<ElementId>) Import(String, ImportOptions3DM, View) Import(String, STLImportOptions, View) Import(String, OBJImportOptions, View) Import(String, AXMImportOptions, View) Import(String, STEPImportOptions, View) IsInEditMode IsValidVersionGUID(Document, Guid) Link(String, ImportOptions3DM, View) Link(String, OBJImportOptions, View) Link(String, STLImportOptions, View) Link(String, STEPImportOptions, View) ResetSharedCoordinates SaveAsCloudModel(Guid, Guid, String, String) CreationGUID

Missing in 2026 (only available in 2020)

Export(String, String, MassGBXMLExportOptions) Import(String, ImageImportOptions, View, Element%) NewFamilyInstance(XYZ, FamilySymbol, Level, StructuralType) NewFloor(CurveArray, FloorType, Level, Boolean) NewFloor(CurveArray, FloorType, Level, Boolean, XYZ) NewFloor(CurveArray, Boolean) NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ) NewSlab(CurveArray, Level, Line, Double, Boolean) SaveAsCloudModel(String, String)

Changed members

Document.GetDocumentPreviewSettings()
→ returns DocumentPreviewSettings The preview settings.
Document.GetUnits()
→ returns Units The Units object.
Document.NewAreaBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
hostElement Element A Wall, Slab or Slab Foundation to host the boundary conditions.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewAreaBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference The Geometry reference obtained from a Wall, Slab or Slab Foundation.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewFamilyInstance(XYZ, FamilySymbol, Element, Level, StructuralType)
location XYZ The physical location where the instance is to be placed on the specified level.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
host Element A host object into which the instance will be embedded
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFamilyInstance(Curve, FamilySymbol, Level, StructuralType)
curve Curve The curve where the instance is based.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, ReferenceArray)
FasciaType FasciaType The type of the fascia to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, Reference)
FasciaType FasciaType The type of the fascia to create
reference Reference A planar line or arc that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, ReferenceArray)
GutterType GutterType The type of the gutter to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, Reference)
GutterType GutterType The type of the gutter to create
reference Reference A planar line or arc that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewLineBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
hostElement Element A Beam.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewLineBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference The Geometry reference to a Beam's, Wall's, Wall Foundation's, Slab's or Slab Foundation's analytical line.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewPointBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
reference Reference A Geometry reference to a Beam's, Brace's or Column's analytical line end.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring".
Y_Rotation TranslationRotationValue A value indicating the option for rotation about the Y axis.
Y_RotationSpringModulus Double Rotation Spring Modulus for Y axis. Ignored if Y_Rotation is not "Spring".
Z_Rotation TranslationRotationValue A value indicating the option for rotation about the Z axis.
Z_RotationSpringModulus Double Rotation Spring Modulus for Z axis. Ignored if Y_Rotation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewPointBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 0 - "Point". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewRoom(Phase)
phase Phase The phase in which the room is to exist.
→ returns Room→nullNothingnullptr If successful the new room , otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Room, PlanCircuit)
room Room The room which you want to locate in the circuit. Pass <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to create a new room.
circuit PlanCircuit The circuit in which you want to locate a room.
→ returns Room→nullNothingnullptr If successful the room is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Level, UV)
level Level The level on which the room is to exist.
point UV A 2D point that dictates the location of the room on that specified level.
→ returns Room→nullNothingnullptr If successful the new room will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRooms2(Level)
level Level The level from which the circuits are found.
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds which contains the rooms created should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoomTag(LinkElementId, UV, ElementId)
roomId LinkElementId The HostOrLinkElementId of the Room.
point UV A 2D point that defines the tag location on the level of the room.
viewId ElementId The id of the view where the tag will be shown. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> and the room in not in a Revit link, the view of the room will be used.
→ returns RoomTag→nullNothingnullptr If successful a RoomTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, ReferenceArray)
SlabEdgeType SlabEdgeType The type of the slab edge to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, Reference)
SlabEdgeType SlabEdgeType The type of the slab edge to create
reference Reference A planar line or arc that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, UV)
level Level The level on which the space is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful the new space element is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, Phase, UV)
level Level The level on which the room is to exist.
phase Phase The phase in which the room is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful a new Space element within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Phase)
phase Phase The phase in which the space is to exist.
→ returns Space→nullNothingnullptr If successful the new space should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaces2(Phase, Int32)
phase Phase The phase in which the spaces are to exist.
count Int32
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds of new unplaced spaces are be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaceTag(Space, UV, View)
space Space The Space which the tag refers.
point UV A 2D point that dictates the location on the level of the space.
view View The view where the tag will lie.
→ returns SpaceTag→nullNothingnullptr If successful a SpaceTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) . Suitable exceptions will be fired if the parameters are invalid.
Document.NewSpotCoordinate(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot coordinate is to be visible.
reference Reference The reference to which the spot coordinate is to be bound.
origin XYZ The point which the spot coordinate evaluate.
bend XYZ The bend point for the spot coordinate.
end XYZ The end point for the spot coordinate.
refPt XYZ The actual point on the reference which the spot coordinate evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpotElevation(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot elevation is to be visible.
reference Reference The reference to which the spot elevation is to be bound.
origin XYZ The point which the spot elevation evaluate.
bend XYZ The bend point for the spot elevation.
end XYZ The end point for the spot elevation.
refPt XYZ The actual point on the reference which the spot elevation evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewZone(Level, Phase)
No longer obsolete in 2020 (was obsolete in 2026)
level Level The level on which the Zone is to exist.
phase Phase The associative phase on which the Zone is to exist.
→ returns Zone→nullNothingnullptr If successful a new Zone element within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .

Changes in 2027 vs 2020 28 added 10 missing 27 changed

Flip API Versions →

Added in 2027 (new since 2020)

EraseSchemaAndAllEntities(Schema) Export(String, String, STLExportOptions) Export(String, IList<ElementId>, PDFExportOptions) Export(String, String, OBJExportOptions) Export(String, String, STEPExportOptions) GetActiveEditMode GetAllUnusedElements(ISet<ElementId>) GetChangedElements(Guid) GetCloudFolderId(Boolean) GetCloudModelUrn GetHubId GetProjectId GetTypeOfStorage(ForgeTypeId) GetUnusedElements(ISet<ElementId>) Import(String, ImportOptions3DM, View) Import(String, STLImportOptions, View) Import(String, OBJImportOptions, View) Import(String, AXMImportOptions, View) Import(String, STEPImportOptions, View) IsInEditMode IsValidVersionGUID(Document, Guid) Link(String, ImportOptions3DM, View) Link(String, OBJImportOptions, View) Link(String, STLImportOptions, View) Link(String, STEPImportOptions, View) ResetSharedCoordinates SaveAsCloudModel(Guid, Guid, String, String) CreationGUID

Missing in 2027 (only available in 2020)

Export(String, String, MassGBXMLExportOptions) Import(String, ImageImportOptions, View, Element%) NewFamilyInstance(XYZ, FamilySymbol, Level, StructuralType) NewFloor(CurveArray, FloorType, Level, Boolean) NewFloor(CurveArray, FloorType, Level, Boolean, XYZ) NewFloor(CurveArray, Boolean) NewFoundationSlab(CurveArray, FloorType, Level, Boolean, XYZ) NewSlab(CurveArray, Level, Line, Double, Boolean) NewZone(Level, Phase) SaveAsCloudModel(String, String)

Changed members

Document.GetDocumentPreviewSettings()
→ returns DocumentPreviewSettings The preview settings.
Document.GetUnits()
→ returns Units The Units object.
Document.NewAreaBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
No longer obsolete in 2020 (was obsolete in 2027)
hostElement Element A Wall, Slab or Slab Foundation to host the boundary conditions.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewAreaBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
No longer obsolete in 2020 (was obsolete in 2027)
reference Reference The Geometry reference obtained from a Wall, Slab or Slab Foundation.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewAreaBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 2 - "Area". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewFamilyInstance(XYZ, FamilySymbol, Element, Level, StructuralType)
location XYZ The physical location where the instance is to be placed on the specified level.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
host Element A host object into which the instance will be embedded
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFamilyInstance(Curve, FamilySymbol, Level, StructuralType)
curve Curve The curve where the instance is based.
symbol FamilySymbol A FamilySymbol object that represents the type of the instance that is to be inserted.
level Level A Level object that is used as the base level for the object.
structuralType StructuralType If structural then specify the type of the component.
→ returns FamilyInstance→nullNothingnullptr If creation was successful then an instance to the new object is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, ReferenceArray)
FasciaType FasciaType The type of the fascia to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewFascia(FasciaType, Reference)
FasciaType FasciaType The type of the fascia to create
reference Reference A planar line or arc that represents the place where you want to place the fascia.
→ returns Fascia→nullNothingnullptr If successful a new fascia object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, ReferenceArray)
GutterType GutterType The type of the gutter to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewGutter(GutterType, Reference)
GutterType GutterType The type of the gutter to create
reference Reference A planar line or arc that represents the place where you want to place the gutter.
→ returns Gutter→nullNothingnullptr If successful a new gutter object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewLineBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
No longer obsolete in 2020 (was obsolete in 2027)
hostElement Element A Beam.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewLineBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
No longer obsolete in 2020 (was obsolete in 2027)
reference Reference The Geometry reference to a Beam's, Wall's, Wall Foundation's, Slab's or Slab Foundation's analytical line.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"
→ returns BoundaryConditions→nullNothingnullptr If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewPointBoundaryConditions(Reference, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)
No longer obsolete in 2020 (was obsolete in 2027)
reference Reference A Geometry reference to a Beam's, Brace's or Column's analytical line end.
X_Translation TranslationRotationValue A value indicating the X axis translation option.
X_TranslationSpringModulus Double Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation TranslationRotationValue A value indicating the Y axis translation option.
Y_TranslationSpringModulus Double Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation TranslationRotationValue A value indicating the Z axis translation option.
Z_TranslationSpringModulus Double Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation TranslationRotationValue A value indicating the option for rotation about the X axis.
X_RotationSpringModulus Double Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring".
Y_Rotation TranslationRotationValue A value indicating the option for rotation about the Y axis.
Y_RotationSpringModulus Double Rotation Spring Modulus for Y axis. Ignored if Y_Rotation is not "Spring".
Z_Rotation TranslationRotationValue A value indicating the option for rotation about the Z axis.
Z_RotationSpringModulus Double Rotation Spring Modulus for Z axis. Ignored if Y_Rotation is not "Spring".
→ returns BoundaryConditions→nullNothingnullptr If successful, NewPointBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 0 - "Point". null Nothing nullptr a null reference ( Nothing in Visual Basic) is returned if the operation fails.
Document.NewRoom(Phase)
phase Phase The phase in which the room is to exist.
→ returns Room→nullNothingnullptr If successful the new room , otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Room, PlanCircuit)
room Room The room which you want to locate in the circuit. Pass <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> to create a new room.
circuit PlanCircuit The circuit in which you want to locate a room.
→ returns Room→nullNothingnullptr If successful the room is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoom(Level, UV)
level Level The level on which the room is to exist.
point UV A 2D point that dictates the location of the room on that specified level.
→ returns Room→nullNothingnullptr If successful the new room will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRooms2(Level)
level Level The level from which the circuits are found.
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds which contains the rooms created should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewRoomTag(LinkElementId, UV, ElementId)
roomId LinkElementId The HostOrLinkElementId of the Room.
point UV A 2D point that defines the tag location on the level of the room.
viewId ElementId The id of the view where the tag will be shown. If <span class="keyword">null</span><span class="nu">a null reference (<span class="keyword">Nothing</span> in Visual Basic)</span> and the room in not in a Revit link, the view of the room will be used.
→ returns RoomTag→nullNothingnullptr If successful a RoomTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, ReferenceArray)
SlabEdgeType SlabEdgeType The type of the slab edge to create
references ReferenceArray An array of planar lines and arcs that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSlabEdge(SlabEdgeType, Reference)
SlabEdgeType SlabEdgeType The type of the slab edge to create
reference Reference A planar line or arc that represents the place where you want to place the slab edge.
→ returns SlabEdge→nullNothingnullptr If successful a new slab edge object within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, UV)
level Level The level on which the space is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful the new space element is returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Level, Phase, UV)
level Level The level on which the room is to exist.
phase Phase The phase in which the room is to exist.
point UV A 2D point that dictates the location on that specified level.
→ returns Space→nullNothingnullptr If successful a new Space element within the project, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpace(Phase)
phase Phase The phase in which the space is to exist.
→ returns Space→nullNothingnullptr If successful the new space should be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaces2(Phase, Int32)
phase Phase The phase in which the spaces are to exist.
count Int32
→ returns ICollection→nullNothingnullptr If successful, a set of ElementIds of new unplaced spaces are be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpaceTag(Space, UV, View)
space Space The Space which the tag refers.
point UV A 2D point that dictates the location on the level of the space.
view View The view where the tag will lie.
→ returns SpaceTag→nullNothingnullptr If successful a SpaceTag object will be returned, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) . Suitable exceptions will be fired if the parameters are invalid.
Document.NewSpotCoordinate(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot coordinate is to be visible.
reference Reference The reference to which the spot coordinate is to be bound.
origin XYZ The point which the spot coordinate evaluate.
bend XYZ The bend point for the spot coordinate.
end XYZ The end point for the spot coordinate.
refPt XYZ The actual point on the reference which the spot coordinate evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .
Document.NewSpotElevation(View, Reference, XYZ, XYZ, XYZ, XYZ, Boolean)
view View The view in which the spot elevation is to be visible.
reference Reference The reference to which the spot elevation is to be bound.
origin XYZ The point which the spot elevation evaluate.
bend XYZ The bend point for the spot elevation.
end XYZ The end point for the spot elevation.
refPt XYZ The actual point on the reference which the spot elevation evaluate.
hasLeader Boolean Indicate if it has leader or not.
→ returns SpotDimension→nullNothingnullptr If successful a new spot dimension object, otherwise null Nothing nullptr a null reference ( Nothing in Visual Basic) .