CustomDocumentProperty 类

定义

命名空间:

DocumentFormat.OpenXml.CustomProperties

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

自定义文件属性。

此类在 Office 2007 及更高版本中可用。

当对象序列化为 xml 时，其限定名称为 op：property。

public class CustomDocumentProperty : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CustomDocumentProperty = class
    inherit OpenXmlCompositeElement

Public Class CustomDocumentProperty
Inherits OpenXmlCompositeElement

继承

Object

OpenXmlElement

OpenXmlCompositeElement

CustomDocumentProperty

注解

[ISO/IEC 29500-1 第 1 版]

属性 (自定义文件属性)

此元素指定单个自定义文件属性。 自定义文件属性类型是通过文件属性变体类型命名空间中的子元素定义的。 可以通过设置适当的 Variant Type 子元素值来设置自定义文件属性值。

父元素
属性 (§22.3.2.1)

子元素	第
array (Array)	§22.4.2.1
blob (二进制 Blob)	§22.4.2.2
布尔 (布尔)	§22.4.2.3
bstr (基本字符串)	§22.4.2.4
clsid (类 ID)	§22.4.2.5
cy (Currency)	§22.4.2.6
date (日期和时间)	§22.4.2.7
decimal (Decimal)	§22.4.2.8
empty (empty)	§22.4.2.9
错误 (错误状态代码)	§22.4.2.10
filetime (文件时间)	§22.4.2.11
i1 (1 字节有符号整数)	§22.4.2.12
i2 (2 字节有符号整数)	§22.4.2.13
i4 (4 字节有符号整数)	§22.4.2.14
i8 (8 字节带符号整数)	§22.4.2.15
int (整数)	§22.4.2.16
lpstr (LPSTR)	§22.4.2.17
lpwstr (LPWSTR)	§22.4.2.18
null (Null)	§22.4.2.19
oblob (Binary Blob 对象)	§22.4.2.20
ostorage (二进制存储对象)	§22.4.2.21
ostream (二进制流对象)	§22.4.2.22
r4 (4 字节实数)	§22.4.2.23
r8 (8 字节实数)	§22.4.2.24
存储 (二进制存储)	§22.4.2.25
流 (二进制流)	§22.4.2.26
ui1 (1 字节无符号整数)	§22.4.2.27
ui2 (2 字节无符号整数)	§22.4.2.28
ui4 (4 字节无符号整数)	§22.4.2.29
ui8 (8 字节无符号整数)	§22.4.2.30
uint (无符号整数)	§22.4.2.31
矢量 (向量)	§22.4.2.33
vstream (二进制版本控制流)	§22.4.2.34

属性	说明
fmtid (格式 ID)	将自定义属性与 OLE 属性唯一关联。 此属性的值是 {HHHHHHHH-HHHH-HHHH-HHHH-HHHH-HHHHHHHH}形式的全局唯一标识符，其中每个 H 是一个十六进制。 此属性的可能值由 ST_Guid 简单类型 (§22.9.2.4) 定义。
linkTarget (书签链接目标)	指定 WordprocessingML) 当前文档中 (书签的名称，或者电子表格ML) 的表格或命名单元格 (，应从中提取此自定义文档属性的值。 如果存在此属性，则此元素下的任何值应被视为缓存，并替换为此书签的值 (（如果存在) 保存时）。 如果书签不存在，则此链接应被视为已断开，并且应保留缓存值。 此属性可能的值由 W3C XML 架构 string 数据类型定义。
name (自定义文件属性名称)	指定此自定义文件属性的名称。 此属性可能的值由 W3C XML 架构 string 数据类型定义。
pid (属性 ID)	将自定义属性与 OLE 属性唯一关联。 此属性的可能值由 W3C XML 架构 int 数据类型定义。

[注意：此元素的内容模型 (CT_Property) 的 W3C XML 架构定义位于 §A.6.3 中。 注释结束]

ISO/IEC29500：2008。

构造函数

CustomDocumentProperty()	初始化 CustomDocumentProperty 类的新实例。
CustomDocumentProperty(IEnumerable<OpenXmlElement>)	使用指定的子元素初始化 CustomDocumentProperty 类的新实例。
CustomDocumentProperty(OpenXmlElement[])	使用指定的子元素初始化 CustomDocumentProperty 类的新实例。
CustomDocumentProperty(String)	从外部 XML 初始化 CustomDocumentProperty 类的新实例。

属性

ChildElements	获取当前元素的所有子节点。 (继承自 OpenXmlElement)
ExtendedAttributes	获取当前元素的架构) 中未定义的所有扩展属性 (属性。 (继承自 OpenXmlElement)
Features	IFeatureCollection获取当前元素的 。 此功能集合将是只读的，但会从其父部件和包继承功能（如果可用）。 (继承自 OpenXmlElement)
FirstChild	获取当前 OpenXmlElement 元素的第一个子元素。 (继承自 OpenXmlCompositeElement)
FormatId	格式 ID 表示架构中的以下属性：fmtid
HasAttributes	获取一个值，该值指示当前元素是否具有任何属性。 (继承自 OpenXmlElement)
HasChildren	获取一个值，该值指示当前元素是否具有任何子元素。 (继承自 OpenXmlCompositeElement)
InnerText	获取或设置当前节点及其所有子节点的串联值。 (继承自 OpenXmlCompositeElement)
InnerXml	获取或设置仅表示当前节点的子节点的标记。 (继承自 OpenXmlCompositeElement)
LastChild	获取当前 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlCompositeElement)
LinkTarget	书签链接目标 表示架构中的以下属性：linkTarget
LocalName	获取当前元素的本地名称。 (继承自 OpenXmlElement)
MCAttributes	获取或设置标记兼容性属性。 如果未为当前元素定义标记兼容性属性，则返回 null。 (继承自 OpenXmlElement)
Name	自定义文件属性名称 表示架构中的以下属性：name
NamespaceDeclarations	获取在当前元素中定义的所有命名空间声明。 如果没有命名空间声明，则返回空枚举器。 (继承自 OpenXmlElement)
NamespaceUri	获取当前元素的命名空间 URI。 (继承自 OpenXmlElement)
OpenXmlElementContext	获取当前元素的 OpenXmlElementContext。 (继承自 OpenXmlElement)
OuterXml	获取表示当前元素及其所有子元素的标记。 (继承自 OpenXmlElement)
Parent	获取当前元素的父元素。 (继承自 OpenXmlElement)
Prefix	获取当前元素的命名空间前缀。 (继承自 OpenXmlElement)
PropertyId	属性 ID 表示架构中的以下属性：pid
VTArray	阵 列。 表示架构中的以下元素标记：vt：array。
VTBlob	二进制 Blob。 表示架构中的以下元素标记：vt：blob。
VTBool	布尔。 表示架构中的以下元素标记：vt：bool。
VTBString	基本字符串。 表示架构中的以下元素标记：vt：bstr。
VTByte	1 字节有符号整数。 表示架构中的以下元素标记：vt：i1。
VTClassId	类 ID。 表示架构中的以下元素标记：vt：clsid。
VTClipboardData	剪贴板数据。 表示架构中的以下元素标记：vt：cf。
VTCurrency	货币。 表示架构中的以下元素标记：vt：cy。
VTDate	日期和时间。 表示架构中的以下元素标记：vt：date。
VTDecimal	小数。 表示架构中的以下元素标记：vt：decimal。
VTDouble	8 字节实数。 表示架构中的以下元素标记：vt：r8。
VTEmpty	空。 表示架构中的以下元素标记：vt：empty。
VTError	错误状态代码。 表示架构中的以下元素标记：vt：error。
VTFileTime	文件时间。 表示架构中的以下元素标记：vt：filetime。
VTFloat	4 字节实数。 表示架构中的以下元素标记：vt：r4。
VTInt32	4 字节有符号整数。 表示架构中的以下元素标记：vt：i4。
VTInt64	8 字节带符号整数。 表示架构中的以下元素标记：vt：i8。
VTInteger	整数。 表示架构中的以下元素标记：vt：int。
VTLPSTR	LPSTR。 表示架构中的以下元素标记：vt：lpstr。
VTLPWSTR	LPWSTR。 表示架构中的以下元素标记：vt：lpwstr。
VTNull	空。 表示架构中的以下元素标记：vt：null。
VTOBlob	二进制 Blob 对象。 表示架构中的以下元素标记：vt：oblob。
VTOStorage	二进制存储对象。 表示架构中的以下元素标记：vt：ostorage。
VTOStreamData	二进制流对象。 表示架构中的以下元素标记：vt：ostream。
VTShort	2 字节有符号整数。 表示架构中的以下元素标记：vt：i2。
VTStorage	二进制存储。 表示架构中的以下元素标记：vt：storage。
VTStreamData	二进制流。 表示架构中的以下元素标记：vt：stream。
VTUnsignedByte	1 字节无符号整数。 表示架构中的以下元素标记：vt：ui1。
VTUnsignedInt32	4 字节无符号整数。 表示架构中的以下元素标记：vt：ui4。
VTUnsignedInt64	8 字节无符号整数。 表示架构中的以下元素标记：vt：ui8。
VTUnsignedInteger	无符号整数。 表示架构中的以下元素标记：vt：uint。
VTUnsignedShort	2 字节无符号整数。 表示架构中的以下元素标记：vt：ui2。
VTVector	向量。 表示架构中的以下元素标记：vt：vector。
VTVStreamData	二进制版本控制流。 表示架构中的以下元素标记：vt：vstream。
XmlQualifiedName	获取当前元素的限定名称。 (继承自 OpenXmlElement)
XName	获取当前元素的限定名称。 (继承自 OpenXmlElement)

方法

AddAnnotation(Object)	将 对象添加到当前 OpenXmlElement 元素的批注列表中。 (继承自 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	如果指定元素是已知的子元素，则将其添加到 元素。 这会根据架构将 元素添加到正确的位置。 (继承自 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	将命名空间声明添加到当前节点。 (继承自 OpenXmlElement)
Ancestors()	枚举当前元素的所有上级。 (继承自 OpenXmlElement)
Ancestors<T>()	仅枚举具有指定类型的当前元素的上级。 (继承自 OpenXmlElement)
Annotation(Type)	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotation<T>()	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotations(Type)	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Annotations<T>()	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	将元素列表中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
Append(OpenXmlElement[])	将元素数组中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
AppendChild<T>(T)	将指定的元素追加到当前元素的子节点列表的末尾。 (继承自 OpenXmlCompositeElement)
ClearAllAttributes()	清除所有属性，包括已知属性和扩展属性。 (继承自 OpenXmlElement)
Clone()	创建当前节点的副本。 (继承自 OpenXmlElement)
CloneNode(Boolean)	创建此节点的副本。
Descendants()	枚举当前元素的所有后代。 (继承自 OpenXmlElement)
Descendants<T>()	枚举类型为 T 的当前元素的所有后代。 (继承自 OpenXmlElement)
Elements()	枚举当前元素的所有子元素。 (继承自 OpenXmlElement)
Elements<T>()	仅枚举具有指定类型的当前元素的子元素。 (继承自 OpenXmlElement)
ElementsAfter()	枚举与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
ElementsBefore()	枚举当前元素之前且具有与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
GetAttribute(String, String)	获取具有指定标记名称和命名空间 URI 的 Open XML 属性。 (继承自 OpenXmlElement)
GetAttributes()	获取一个列表，该列表包含所有属性的副本。 (继承自 OpenXmlElement)
GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)
GetFirstChild<T>()	查找类型 T 中的第一个子元素。 (继承自 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	在指定的引用元素之后立即插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	在当前元素之后立即插入指定的元素。 (继承自 OpenXmlElement)
InsertAt<T>(T, Int32)	在当前元素的子元素的指定索引处插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	将指定的元素紧接在指定的引用元素之前。 (继承自 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	将指定的元素紧接在当前元素的前面。 (继承自 OpenXmlElement)
IsAfter(OpenXmlElement)	确定当前元素是否以文档顺序显示在指定元素之后。 (继承自 OpenXmlElement)
IsBefore(OpenXmlElement)	确定当前元素是否按文档顺序显示在指定元素之前。 (继承自 OpenXmlElement)
LookupNamespace(String)	解析当前节点上下文中的命名空间前缀。 (继承自 OpenXmlElement)
LookupPrefix(String)	查找当前元素范围内命名空间 URI 的相应前缀。 (继承自 OpenXmlElement)
NextSibling()	获取紧跟在当前 OpenXmlElement 元素后面的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
NextSibling<T>()	获取具有当前 OpenXmlElement 元素后面的指定类型的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
PrependChild<T>(T)	在当前元素的子节点列表的开头插入指定的元素。 (继承自 OpenXmlCompositeElement)
PreviousSibling()	获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic ) 中 Nothing。 (继承自 OpenXmlElement)
PreviousSibling<T>()	获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
Remove()	从其父元素中删除当前元素。 (继承自 OpenXmlElement)
RemoveAllChildren()	删除当前元素的所有子元素。 (继承自 OpenXmlCompositeElement)
RemoveAllChildren<T>()	删除类型为 T 的当前元素的所有子元素。 (继承自 OpenXmlElement)
RemoveAnnotations(Type)	从当前 OpenXmlElement 元素中删除指定类型的注释。 (继承自 OpenXmlElement)
RemoveAnnotations<T>()	从当前 OpenXmlElement 元素中删除具有指定类型的批注。 (继承自 OpenXmlElement)
RemoveAttribute(String, String)	从当前元素中删除 属性。 (继承自 OpenXmlElement)
RemoveChild<T>(T)	删除指定的子元素。 (继承自 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	删除指定前缀的命名空间声明。 如果没有前缀，则不删除任何内容。 (继承自 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	将当前元素的子元素之一替换为另一个 OpenXmlElement 元素。 (继承自 OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	将特性设置为指定的元素。 如果该属性是已知属性，则设置该特性的值。 如果该属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	设置元素的多个属性。 如果属性是已知属性，则会设置该属性的值。 如果属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
WriteTo(XmlWriter)	将当前节点保存到指定的 XmlWriter。 (继承自 OpenXmlElement)

显式接口实现

IEnumerable.GetEnumerator()	自定义文件属性。 此类在 Office 2007 及更高版本中可用。 当对象序列化为 xml 时，其限定名称为 op：property。 (继承自 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)