Autodesk.Revit.DB.ExtensibleStorage.Entity

Autodesk.Revit.DB.ExtensibleStorage.Entity是Revit API中的一个类，用于管理和维护可扩展存储中的实体数据。

概述

可扩展存储是Revit API中的一个功能，它允许开发人员将自定义数据附加到Revit中的几乎任何对象上。这种数据是通过实体(Entity)来表示和组织的，每个实体都具有唯一的标识符，并可以包含一组属性(Property)。

Autodesk.Revit.DB.ExtensibleStorage.Entity就是用于表示这些实体的，它提供了一组方法来创建、查询、更新实体及其属性。

构造函数

Autodesk.Revit.DB.ExtensibleStorage.Entity有两个构造函数：

• Entity(Guid id)
  • 参数：id，一个128位的全局唯一标识符（GUID），用于标识实体。
  • 描述：创建一个新的实体对象，并分配一个唯一的GUID作为其标识符。
• Entity(Guid id, Schema schema)
  • 参数：id，一个128位的全局唯一标识符（GUID），用于标识实体。
  • 参数：schema，一个Schema对象，用于定义实体的属性结构。
  • 描述：创建一个新的实体对象，并分配一个唯一的GUID作为其标识符。同时，将由Schema定义的属性结构与实体关联起来。

方法

Autodesk.Revit.DB.ExtensibleStorage.Entity提供了一组用于管理实体及其属性的方法，如下：

• Guid Get<Entity>Id()
  • 描述：获取实体的唯一标识符。
• Entity SetValue<T>(string name, T value)
  • 参数：name，要设置的属性的名称。
  • 参数：value，要设置的属性的值。
  • 描述：将属性名称为name的值设置为value。
• T GetValue<T>(string name, T defaultValue)
  • 参数：name，要获取的属性的名称。
  • 参数：defaultValue，如果属性不存在，则返回的默认值。
  • 描述：获取属性名称为name的值，如果不存在，则返回defaultValue。
• bool Contains(string name)
  • 参数：name，要查询的属性的名称。
  • 描述：确定属性名称为name的属性是否存在。
• void Delete(string name)
  • 参数：name，要删除的属性的名称。
  • 描述：删除属性名称为name的属性。
• Schema GetSchema()
  • 描述：获取与实体关联的Schema对象。
• bool IsValid()
  • 描述：确定实体是否有效。
• Entity Clone()
  • 描述：创建一个实体的副本。

示例

以下示例演示了如何使用Autodesk.Revit.DB.ExtensibleStorage.Entity创建和读取一个实体：

// 为实体定义一个Schema
Guid schemaGuid = new Guid("3a6bfb81-51eb-4e62-95d2-6db43380623a");
SchemaBuilder schemaBuilder = new SchemaBuilder(schemaGuid);
schemaBuilder.SetReadAccessLevel(AccessLevel.Public);
schemaBuilder.SetWriteAccessLevel(AccessLevel.Append);
schemaBuilder.AddSimpleField("Name", typeof(string));
Schema schema = schemaBuilder.Finish();

// 创建一个新实体
Entity entity = new Entity(Guid.NewGuid(), schema);
entity.SetValue("Name", "My entity");

// 写入实体到文档
Document document = uidoc.Document;
ElementId elementId = document.Create.NewFamilyInstance(XYZ.Zero, FamilySymbol);
Autodesk.Revit.DB.ExtensibleStorage.Entity.Save(document, elementId, entity);

// 从文档读取实体
Entity loadedEntity = Autodesk.Revit.DB.ExtensibleStorage.Entity.Load(document, elementId);
string entityName = loadedEntity.GetValue<string>("Name", string.Empty);

这个示例创建一个简单的Schema，它定义了一个名称为“Name”的字符串属性。然后，它创建一个新的实体，为其设置名称并将其保存到Revit文档中。最后，它从文档中读取实体，并获取其名称属性的值。