CustomDocumentProperty Class

Definition

Namespace:

DocumentFormat.OpenXml.CustomProperties

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Custom File Property.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is op:property.

public class CustomDocumentProperty : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CustomDocumentProperty = class
    inherit OpenXmlCompositeElement

Public Class CustomDocumentProperty
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

CustomDocumentProperty

Remarks

[ISO/IEC 29500-1 1st Edition]

property (Custom File Property)

This element specifies a single custom file property. Custom file property type is defined through child elements in the File Properties Variant Type namespace. Custom file property value can be set by setting the appropriate Variant Type child element value.

Parent Elements
Properties (§22.3.2.1)

Child Elements	Subclause
array (Array)	§22.4.2.1
blob (Binary Blob)	§22.4.2.2
bool (Boolean)	§22.4.2.3
bstr (Basic String)	§22.4.2.4
clsid (Class ID)	§22.4.2.5
cy (Currency)	§22.4.2.6
date (Date and Time)	§22.4.2.7
decimal (Decimal)	§22.4.2.8
empty (Empty)	§22.4.2.9
error (Error Status Code)	§22.4.2.10
filetime (File Time)	§22.4.2.11
i1 (1-Byte Signed Integer)	§22.4.2.12
i2 (2-Byte Signed Integer)	§22.4.2.13
i4 (4-Byte Signed Integer)	§22.4.2.14
i8 (8-Byte Signed Integer)	§22.4.2.15
int (Integer)	§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 Object)	§22.4.2.20
ostorage (Binary Storage Object)	§22.4.2.21
ostream (Binary Stream Object)	§22.4.2.22
r4 (4-Byte Real Number)	§22.4.2.23
r8 (8-Byte Real Number)	§22.4.2.24
storage (Binary Storage)	§22.4.2.25
stream (Binary Stream)	§22.4.2.26
ui1 (1-Byte Unsigned Integer)	§22.4.2.27
ui2 (2-Byte Unsigned Integer)	§22.4.2.28
ui4 (4-Byte Unsigned Integer)	§22.4.2.29
ui8 (8-Byte Unsigned Integer)	§22.4.2.30
uint (Unsigned Integer)	§22.4.2.31
vector (Vector)	§22.4.2.33
vstream (Binary Versioned Stream)	§22.4.2.34

Attributes	Description
fmtid (Format ID)	Uniquely relates a custom property with an OLE property. The value of this attribute is a Globally Unique Identifier in the form of {HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHH} where each H is a hexidecimal. The possible values for this attribute are defined by the ST_Guid simple type (§22.9.2.4).
linkTarget (Bookmark Link Target)	Specifies the name of a bookmark in the current document (for WordprocessingML), or a table or named cell (for SpreadsheetML) from which the value of this custom document property should be extracted. If this attribute is present, then any value under this element shall be considered a cache and replaced with the value of this bookmark (if present) on save. If the bookmark is not present, then this link shall be considered broken and the cached value shall be retained. The possible values for this attribute are defined by the W3C XML Schema string datatype.
name (Custom File Property Name)	Specifies the name of this custom file property. The possible values for this attribute are defined by the W3C XML Schema string datatype.
pid (Property ID)	Uniquely relates a custom property with an OLE property. The possible values for this attribute are defined by the W3C XML Schema int datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_Property) is located in §A.6.3. end note]

� ISO/IEC29500: 2008.

Constructors

CustomDocumentProperty()	Initializes a new instance of the CustomDocumentProperty class.
CustomDocumentProperty(IEnumerable<OpenXmlElement>)	Initializes a new instance of the CustomDocumentProperty class with the specified child elements.
CustomDocumentProperty(OpenXmlElement[])	Initializes a new instance of the CustomDocumentProperty class with the specified child elements.
CustomDocumentProperty(String)	Initializes a new instance of the CustomDocumentProperty class from outer XML.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FormatId	Format ID Represents the following attribute in the schema: fmtid
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LinkTarget	Bookmark Link Target Represents the following attribute in the schema: linkTarget
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
Name	Custom File Property Name Represents the following attribute in the schema: name
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PropertyId	Property ID Represents the following attribute in the schema: pid
VTArray	Array. Represents the following element tag in the schema: vt:array.
VTBlob	Binary Blob. Represents the following element tag in the schema: vt:blob.
VTBool	Boolean. Represents the following element tag in the schema: vt:bool.
VTBString	Basic String. Represents the following element tag in the schema: vt:bstr.
VTByte	1-Byte Signed Integer. Represents the following element tag in the schema: vt:i1.
VTClassId	Class ID. Represents the following element tag in the schema: vt:clsid.
VTClipboardData	Clipboard Data. Represents the following element tag in the schema: vt:cf.
VTCurrency	Currency. Represents the following element tag in the schema: vt:cy.
VTDate	Date and Time. Represents the following element tag in the schema: vt:date.
VTDecimal	Decimal. Represents the following element tag in the schema: vt:decimal.
VTDouble	8-Byte Real Number. Represents the following element tag in the schema: vt:r8.
VTEmpty	Empty. Represents the following element tag in the schema: vt:empty.
VTError	Error Status Code. Represents the following element tag in the schema: vt:error.
VTFileTime	File Time. Represents the following element tag in the schema: vt:filetime.
VTFloat	4-Byte Real Number. Represents the following element tag in the schema: vt:r4.
VTInt32	4-Byte Signed Integer. Represents the following element tag in the schema: vt:i4.
VTInt64	8-Byte Signed Integer. Represents the following element tag in the schema: vt:i8.
VTInteger	Integer. Represents the following element tag in the schema: vt:int.
VTLPSTR	LPSTR. Represents the following element tag in the schema: vt:lpstr.
VTLPWSTR	LPWSTR. Represents the following element tag in the schema: vt:lpwstr.
VTNull	Null. Represents the following element tag in the schema: vt:null.
VTOBlob	Binary Blob Object. Represents the following element tag in the schema: vt:oblob.
VTOStorage	Binary Storage Object. Represents the following element tag in the schema: vt:ostorage.
VTOStreamData	Binary Stream Object. Represents the following element tag in the schema: vt:ostream.
VTShort	2-Byte Signed Integer. Represents the following element tag in the schema: vt:i2.
VTStorage	Binary Storage. Represents the following element tag in the schema: vt:storage.
VTStreamData	Binary Stream. Represents the following element tag in the schema: vt:stream.
VTUnsignedByte	1-Byte Unsigned Integer. Represents the following element tag in the schema: vt:ui1.
VTUnsignedInt32	4-Byte Unsigned Integer. Represents the following element tag in the schema: vt:ui4.
VTUnsignedInt64	8-Byte Unsigned Integer. Represents the following element tag in the schema: vt:ui8.
VTUnsignedInteger	Unsigned Integer. Represents the following element tag in the schema: vt:uint.
VTUnsignedShort	2-Byte Unsigned Integer. Represents the following element tag in the schema: vt:ui2.
VTVector	Vector. Represents the following element tag in the schema: vt:vector.
VTVStreamData	Binary Versioned Stream. Represents the following element tag in the schema: vt:vstream.
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)