Id

StructuredDocumentTag.Id property

指定一个唯一的只读持久数字 ID特殊和差别待遇。

public int Id { get; }

评论

Id属性应遵循以下规则：

  • 仅当整个文档被克隆时，文档才应保留 SDT IDClone。
  • 期间ImportNode如果导入不会与目标文档中的其他 SDT Id 发生冲突，则应保留 Id。
  • 如果多个 SDT 节点为 Id 属性指定相同的十进制数值， 则文档中的第一个 SDT 应维护此原始 Id， 并且所有后续 SDT 节点都应在加载文档时分配新的标识符。
  • 在独立 SDT 期间INodeCloningListener)操作将为克隆的SDT节点生成新的唯一ID。
  • 如果源文档中未指定 Id，则在加载文档时，SDT 节点应分配一个新的唯一标识符。

例子

展示如何在纯文本框中创建结构化文档标签并修改其外观。

Document doc = new Document();

// 创建一个包含纯文本的结构化文档标签。
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline);

// 设置当鼠标悬停在 Microsoft Word 中的结构化文档标签上时出现的框架的标题和颜色。
tag.Title = "My plain text";
tag.Color = Color.Magenta;

// 为该结构化文档标签设置一个标签，该标签可获取
// 作为名为“tag”的 XML 元素，其“@val”属性中包含以下字符串。
tag.Tag = "MyPlainTextSDT";

// 每个结构化文档标签都有一个随机的唯一ID。
Assert.IsTrue(tag.Id > 0);

// 设置结构化文档标签内的文本的字体。
tag.ContentsFont.Name = "Arial";

// 设置结构化文档标签末尾文本的字体。
// 使用箭头键移出标签后，我们在文档正文中输入的任何文本都将使用此字体。
tag.EndCharacterFont.Name = "Arial Black";

// 默认情况下，这是错误的，并且在结构化文档标签内按回车键不会执行任何操作。
// 当设置为 true 时，我们的结构化文档标签可以有多行。

// 将“Multiline”属性设置为“false”以仅允许内容
// 此结构化文档标签跨越一行。
// 将“Multiline”属性设置为“true”以允许标签包含多行内容。
tag.Multiline = true;

// 将“Appearance”属性设置为“SdtAppearance.Tags”以显示内容周围的标签。
 // 默认情况下，结构化文档标签显示为 BoundingBox。
tag.Appearance = SdtAppearance.Tags;

DocumentBuilder builder = new DocumentBuilder(doc);
builder.InsertNode(tag);

// 在新段落中插入结构化文档标签的克隆。
StructuredDocumentTag tagClone = (StructuredDocumentTag)tag.Clone(true);
builder.InsertParagraph();
builder.InsertNode(tagClone);

// 使用“RemoveSelfOnly”方法删除结构化文档标签，同时保留其在文档中的内容。
tagClone.RemoveSelfOnly();

doc.Save(ArtifactsDir + "StructuredDocumentTag.PlainText.docx");

也可以看看

StructuredDocumentTag.FullDate StructuredDocumentTag.IsShowingPlaceholderText