Properties Class

Definition

Namespace:

DocumentFormat.OpenXml.ExtendedProperties

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Application Specific File Properties.

This class is available in Office 2007 and above.

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

public class Properties : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Properties = class
    inherit OpenXmlPartRootElement

Public Class Properties
Inherits OpenXmlPartRootElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Properties

Remarks

[ISO/IEC 29500-1 1st Edition]

Properties (Application Specific File Properties)

This element specifies the application properties of a document. For properties of type string, escape format (_xHHHH_) is used for any invalid XML characters.

Parent Elements
Root element of Shared Extended File Properties part

Child Elements	Subclause
Application (Application Name)	§22.2.2.1
AppVersion (Application Version)	§22.2.2.2
Characters (Total Number of Characters)	§22.2.2.3
CharactersWithSpaces (Number of Characters (With Spaces))	§22.2.2.4
Company (Name of Company)	§22.2.2.5
DigSig (Digital Signature)	§22.2.2.6
DocSecurity (Document Security)	§22.2.2.7
HeadingPairs (Heading Pairs)	§22.2.2.8
HiddenSlides (Number of Hidden Slides)	§22.2.2.9
HLinks (Hyperlink List)	§22.2.2.10
HyperlinkBase (Relative Hyperlink Base)	§22.2.2.11
HyperlinksChanged (Hyperlinks Changed)	§22.2.2.12
Lines (Number of Lines)	§22.2.2.13
LinksUpToDate (Links Up-to-Date)	§22.2.2.14
Manager (Name of Manager)	§22.2.2.15
MMClips (Total Number of Multimedia Clips)	§22.2.2.16
Notes (Number of Slides Containing Notes)	§22.2.2.17
Pages (Total Number of Pages)	§22.2.2.18
Paragraphs (Total Number of Paragraphs)	§22.2.2.19
PresentationFormat (Intended Format of Presentation)	§22.2.2.20
ScaleCrop (Thumbnail Display Mode)	§22.2.2.22
SharedDoc (Shared Document)	§22.2.2.23
Slides (Slides Metadata Element)	§22.2.2.24
Template (Name of Document Template)	§22.2.2.25
TitlesOfParts (Part Titles)	§22.2.2.26
TotalTime (Total Edit Time Metadata Element)	§22.2.2.27
Words (Word Count)	§22.2.2.28

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

Application	Application Name. Represents the following element tag in the schema: ap:Application.
ApplicationVersion	Application Version. Represents the following element tag in the schema: ap:AppVersion.
Characters	Total Number of Characters. Represents the following element tag in the schema: ap:Characters.
CharactersWithSpaces	Number of Characters (With Spaces). Represents the following element tag in the schema: ap:CharactersWithSpaces.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Company	Name of Company. Represents the following element tag in the schema: ap:Company.
DigitalSignature	Digital Signature. Represents the following element tag in the schema: ap:DigSig.
DocumentSecurity	Document Security. Represents the following element tag in the schema: ap:DocSecurity.
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
ExtendedFilePropertiesPart	Gets the ExtendedFilePropertiesPart associated with this element.
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)
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)
HeadingPairs	Heading Pairs. Represents the following element tag in the schema: ap:HeadingPairs.
HiddenSlides	Number of Hidden Slides. Represents the following element tag in the schema: ap:HiddenSlides.
HyperlinkBase	Relative Hyperlink Base. Represents the following element tag in the schema: ap:HyperlinkBase.
HyperlinkList	Hyperlink List. Represents the following element tag in the schema: ap:HLinks.
HyperlinksChanged	Hyperlinks Changed. Represents the following element tag in the schema: ap:HyperlinksChanged.
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)
Lines	Number of Lines. Represents the following element tag in the schema: ap:Lines.
LinksUpToDate	Links Up-to-Date. Represents the following element tag in the schema: ap:LinksUpToDate.
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
Manager	Name of Manager. Represents the following element tag in the schema: ap:Manager.
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MultimediaClips	Total Number of Multimedia Clips. Represents the following element tag in the schema: ap:MMClips.
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)
Notes	Number of Slides Containing Notes. Represents the following element tag in the schema: ap:Notes.
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OpenXmlPart	Gets the part that is associated with the DOM tree. It returns null when the DOM tree is not associated with a part. (Inherited from OpenXmlPartRootElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Pages	Total Number of Pages. Represents the following element tag in the schema: ap:Pages.
Paragraphs	Total Number of Paragraphs. Represents the following element tag in the schema: ap:Paragraphs.
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PresentationFormat	Intended Format of Presentation. Represents the following element tag in the schema: ap:PresentationFormat.
ScaleCrop	Thumbnail Display Mode. Represents the following element tag in the schema: ap:ScaleCrop.
SharedDocument	Shared Document. Represents the following element tag in the schema: ap:SharedDoc.
Slides	Slides Metadata Element. Represents the following element tag in the schema: ap:Slides.
Template	Name of Document Template. Represents the following element tag in the schema: ap:Template.
TitlesOfParts	Part Titles. Represents the following element tag in the schema: ap:TitlesOfParts.
TotalTime	Total Edit Time Metadata Element. Represents the following element tag in the schema: ap:TotalTime.
Words	Word Count. Represents the following element tag in the schema: ap:Words.
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)
Load(ExtendedFilePropertiesPart)	Loads the DOM from the ExtendedFilePropertiesPart
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)
Reload()	Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement)
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)
Save()	Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement)
Save(ExtendedFilePropertiesPart)	Saves the DOM into the ExtendedFilePropertiesPart.
Save(Stream)	Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement)
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 OpenXmlPartRootElement)

Explicit Interface Implementations

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