Autodesk.Revit.DB Document

表示打开的 Autodesk Revit 项目的对象。

语法

public class Document : IDisposable

附注

Document 对象表示 Autodesk Revit 项目。Revit 可以打开多个项目，并打开这些项目的多个视图。活动视图或最顶层视图将是活动项目，因此是可从 Application 对象获得的活动文档。

继承层次结构

• System Object
• Autodesk.Revit.DB Document
• Autodesk.Revit.DB.Macros DocumentEntryPoint

方法

AcquireCoordinates

• 不知道是啥，API没给描述

AutoJoinElements

• 强制 Revit 文档中的图元在适当的情况下自动连接到其相邻图元。

CanEnableWorksharing

• 检查是否可以在文档中启用工作共享。

Close

• 关闭文档，保存更改（如果有）。

Close(Boolean)

• 关闭文档，并带有保存选项。

CombineElements

• 将一组可组合元素组合成一个几何组合。

ConvertDetailToModelCurves

• 将一组 DetailCurves（细节曲线）转换为等效的 ModelCurves（模型曲线）。

ConvertModelToDetailCurves

• 将一组 ModelCurves（模型曲线）转换为等效的 DetailCurves（细节曲线）。

ConvertModelToSymbolicCurves

• 将一组 ModelCurves 转换为等效的 SymbolicCurves。

ConvertSymbolicToModelCurves

• 将一组 SymbolicCurves 转换为等效的 ModelCurves。

Delete(ElementId)

• 从文档中删除给定该元素 id 的元素。

Delete(ICollection ElementId )

• 从文档中删除一组元素。

Dispose

EditFamily

• 获取要编辑的载入族的文档。

EnableWorksharing

• 在文档中启用工作共享。

Export(String, String, MassGBXMLExportOptions)

• 从体量模型文档导出 gbXML 文件。

Export(String, String, GBXMLExportOptions)

• 以 gbXML（绿色建筑）格式导出模型。

xport(String, String, IFCExportOptions)

• 将文档导出为行业标准类 （IFC） 格式。

Export(String, String, NavisworksExportOptions)

• 将 Revit 项目导出为 Navisworks .nwc 格式。

Export(String, String, ViewSet, DWFExportOptions)

• 以 DWF 格式导出当前视图或选定的视图。

Export(String, String, ViewSet, DWFXExportOptions)

• 以 DWFX 格式导出当前视图或所选视图。

Export(String, String, ViewSet, FBXExportOptions)

• 以 3D-Studio Max （FBX） 格式导出文档。

Export(String, String, ICollection ElementId , DGNExportOptions)

• 以 DGN 格式导出所选视图。

Export(String, String, ICollection ElementId , DWGExportOptions)

• 以 DWG 格式导出所选视图。

Export(String, String, ICollection ElementId , DXFExportOptions)

• 以 DXF 格式导出所选视图。

Export(String, String, ICollection ElementId , SATExportOptions)

• 以 SAT 格式导出当前视图或所选视图。

Export(String, String, View3D, ViewPlan, BuildingSiteExportOptions)

• 以 Civil Engineering 设计应用程序的格式导出文档。

ExportImage

• 将一个视图或一组视图导出到图像文件中。

GetDefaultElementTypeId

• 获取具有给定 DefaultElementType ID 的默认元素类型 ID。

GetDefaultFamilyTypeId

• 获取具有给定族类别 ID 的默认族类型 ID。

GetDocumentPreviewSettings

• 返回给定文档的预览设置。

GetDocumentVersion

• 获取与文档对应的 DocumentVersion。

GetElement(String)

• 获取唯一 id 字符串引用的 Element。

GetElement(ElementId)

• 获取输入字符串名称引用的 Element。

GetElement(Reference)

• 获取输入引用引用的 Element。

GetPaintedMaterial

• 获取在元素面上绘制的材质。如果未绘制面部，则返回 invalidElementId。

GetPrintSettingIds

• 检索当前项目的所有打印设置。

GetRoomAtPoint(XYZ)

• 获取包含点的 room。

GetRoomAtPoint(XYZ, Phase)

• Gets a room containing the point.

GetSpaceAtPoint(XYZ)

• 获取包含点的空间。

GetSpaceAtPoint(XYZ, Phase)

• 获取包含点的空间。

GetSubelement(String)

• 获取唯一 ID 字符串引用的子元素。

GetSubelement(Reference)

• 获取输入引用引用的子元素。

GetUnits

• 获取 Units 对象。

GetWarnings

• 返回从文档中累积的持续 （可审阅） 警告生成的失败消息列表。

GetWorksetId

• 获取拥有该元素的工作集的 ID。

GetWorksetTable

• 获取此文档的 WorksetTable。

GetWorksharingCentralModelPath

• 获取工作共享模型的中心模型路径。

HasAllChangesFromCentral

• 返回当前会话中的模型是否与 central 保持同步。

Import(String, GBXMLImportOptions)

• 将 Green-Building XML 文件导入到文档中。

Import(String, SATImportOptions, View)

• 将 SAT 文件导入到文档中。

Import(String, SKPImportOptions, View)

• 将 SKP 文件导入到文档中。

Import(String, DGNImportOptions, View, ElementId )

• 将 DGN 文件导入到文档中。

Import(String, DWGImportOptions, View, ElementId )

• 将 DWG 或 DXF 文件导入到文档中。

Import(String, ImageImportOptions, View, Element )

• 将图像（位图）导入到文档中。

IsDefaultElementTypeIdValid

• 检查元素类型 id 是否对给定的 DefaultElmentType id 有效。

IsDefaultFamilyTypeIdValid

• 检查族类型 ID 是否对给定的family 类别有效。

IsPainted

• 检查元素的表面是否使用材质绘制。

Link(String, DWFImportOptions)

• 将 DWF 文件中的标记链接到文档。

Link(String, SATImportOptions, View)

• 将 SAT 文件链接到文档中。

Link(String, SKPImportOptions, View)

• 将 SKP 文件链接到文档中。

Link(String, DGNImportOptions, View, ElementId )

• 将 DGN 文件链接到文档。

Link(String, DWGImportOptions, View, ElementId )

• 将 DWG 或 DXF 文件链接到文档。

LoadFamily(String)

• 将整个族及其所有类型/符号加载到文档中。

LoadFamily(Document)

• 将此族文档的内容加载到另一个文档中。

LoadFamily(String, Family )

• 将整个族及其所有类型/符号加载到文档中，并提供对载入族的引用。

LoadFamily(Document, IFamilyLoadOptions)

• 将此族文档的内容加载到另一个文档中。

LoadFamily(String, IFamilyLoadOptions, Family )

• 将整个族及其所有类型/符号加载到文档中，并提供对载入族的引用。

LoadFamilySymbol(String, String)

• 仅将指定的族类型/符号从族文件加载到文档中。

LoadFamilySymbol(String, String, FamilySymbol )

• 仅将指定的族类型/符号从族文件加载到文档中，并提供对载入的族符号的引用。

LoadFamilySymbol(String, String, IFamilyLoadOptions, FamilySymbol )

• 仅将指定的族类型/符号从族文件加载到文档中，并提供对载入的族符号的引用。

MakeTransientElements

• 此方法封装了在文档中创建临时元素的过程。

Paint(ElementId, Face, ElementId)

• 使用指定的材质绘制元素的面。

Paint(ElementId, Face, FamilyParameter)

• 使用指定的材质绘制元素的表面。

PostFailure

• 将失败发布，以便在事务结束时向用户显示。

Print(ViewSet)

• 使用默认视图样板和默认打印设置打印一组视图。

Print(ViewSet, View)

• 使用指定的视图样板和默认打印设置打印一组视图。

Print(ViewSet, Boolean)

• 使用默认视图样板和默认打印设置打印一组视图。

Print(ViewSet, View, Boolean)

• 使用指定的视图样板和默认打印设置打印一组视图。

PublishCoordinates

• 将坐标发布到链接实例的指定 ProjectLocation。

Regenerate

• 更新 Revit 文档中的图元以反映所有更改。

ReloadLatest

• 从 central 获取更改 （由于与 central 的一个或多个同步） 并将它们合并到当前会话中。

RemovePaint

• 删除在元素面上绘制的材质。如果表面当前未上绘制，则不会执行任何操作。

Save

• 保存文档。

Save(SaveOptions)

• 保存文档。

SaveAs(String)

• 将文档保存到给定的文件路径。

SaveAs(String, SaveAsOptions)

• 将文档保存到给定的文件路径。

SaveAs(ModelPath, SaveAsOptions)

• 将文档保存到给定路径。

SaveToProjectAsImage

• 从当前活动视图创建图像视图。

SeparateElements

• 将一组可组合元素从它们当前属于的组合中分离出来。

SetDefaultElementTypeId

• 设置给定 DefaultElementType ID 的默认元素类型 ID。

SetDefaultFamilyTypeId

• 设置给定族类别的默认族类型 ID。

SetUnits

• 设置单位。

SynchronizeWithCentral

• 执行 reload latest 直到当前会话中的模型是最新的，然后将更改保存回中心。即使未进行任何更改，也会执行保存到中心。

UnpostFailure

• 删除与给定 FailureMessageKey 关联的已发布失败消息。

属性

ActiveProjectLocation

• 检索活动项目位置。

ActiveView

• 文档的活动视图。

Application

• 返回 Document 所在的 Application。

Create

• 可用于在项目中创建 Autodesk Revit API 元素的新实例的对象。

DisplayUnitSystem

• 提供对文档中 的显示单位类型的访问。

FamilyCreate

• 可用于在族文档中创建 Autodesk Revit API 元素的新实例的对象。

FamilyManager

• 族管理器对象提供对族类型和参数的访问。

IsDetached

• 标识工作共享文档是否已分离。另请参阅 IsWorkshared

IsFamilyDocument

• 标识当前文档是否为族文档。

IsLinked

• 标识文档是否为链接的 RVT。

IsModifiable

• 文档的可修改性状态。

IsModified

• 对文档所做更改的状态。

IsReadOnly

• 标识文档是只读的还是可以修改的。

IsReadOnlyFile

• 指示文档是否从只读文件打开。

IsValidObject

• 指定 .NET 对象是否表示有效的 Revit 实体。

IsWorkshared

• 标识是否已在文档中启用工作共享（即编辑权限和多个工作集）。另请参阅 IsDetached

MassDisplayTemporaryOverride

• 此设置控制在具有质量类别或子类别的对象的视图中的临时显示。

MullionTypes

• 此属性用于检索当前系统中的所有竖梃类型。

OwnerFamily

• 获取此族文档的 Family 。

PanelTypes

• 检索一组 PanelType 对象，其中包含当前加载到项目中的所有面板类型。

ParameterBindings

• 检索可从中找到参数定义和类别之间的映射的对象。

PathName

• 文档磁盘文件的完全限定路径。

Phases

• 检索表示项目中阶段的所有对象。

PlanTopologies

• 获取最后阶段当前项目的 PlanTopologies。

PlanTopologies Phase

• 获取给定阶段中当前项目的 PlanTopologies。

PlanTopology Level

• 在最后阶段获取给定级别的 PlanTopology。

PlanTopology Level, Phase

• 获取给定阶段中给定级别的 PlanTopology。

PrintManager

• 检索当前项目的 PrintManager。

ProjectInformation

• 返回当前项目的 Project Information。

ProjectLocations

• 检索与此工程关联的所有工程位置

ReactionsAreUpToDate

• 报告分析模型是否已在具有反作用载荷的文档中重新生成。

Settings

• 提供对常规应用程序设置（如 Categories）的访问。

SiteLocation

• 返回站点位置信息。

Title

• 文档的标题。

TypeOfStorage

• 获取指定 BuiltInParameter 的存储类型。

WorksharingCentralGUID

• 基于服务器的模型的中心 GUID。

事件

DocumentClosing

• 订阅 DocumentClosing 事件，以便在 Revit 即将关闭文档时收到通知。

DocumentPrinted

• 订阅 DocumentPrinted 事件，以便在 Revit 打印完文档的视图或 ViewSet 后立即收到通知。

DocumentPrinting

• 订阅 DocumentPrinting 事件，以便在 Revit 即将打印文档的视图或 ViewSet 时收到通知。

DocumentSaved

• 订阅 DocumentSaved 事件，以便在 Revit 完成保存文档后立即收到通知。

DocumentSavedAs

• 订阅 DocumentSavedAs 事件，以便在 Revit 使用新文件名完成保存文档后立即收到通知。

DocumentSaving

• 订阅 DocumentSaving 事件，以便在 Revit 即将保存文档时收到通知。

DocumentSavingAs

• 订阅 DocumentSavingAs 事件，以便在 Revit 即将使用新文件名保存文档时收到通知。

ViewPrinted

• 订阅 ViewPrinted 事件，以便在 Revit 打印完文档视图后立即收到通知。

ViewPrinting

• 订阅 ViewPrinting 事件，以便在 Revit 即将打印文档视图时收到通知。

注：翻译自Revit Api docs 2018