CommentAuthor Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Comment Author.
This class is available in Office 2007 and above.
When the object is serialized out as xml, it's qualified name is p:cmAuthor.
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Presentation.CommentAuthorExtensionList))]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(24, "cmAuthor")]
public class CommentAuthor : DocumentFormat.OpenXml.OpenXmlCompositeElementpublic class CommentAuthor : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.SchemaAttr(24, "cmAuthor")]
public class CommentAuthor : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.SchemaAttr("p:cmAuthor")]
public class CommentAuthor : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.SchemaAttr("p:cmAuthor")]
public class CommentAuthor : DocumentFormat.OpenXml.TypedOpenXmlCompositeElement[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Presentation.CommentAuthorExtensionList))]
public class CommentAuthor : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Presentation.CommentAuthorExtensionList))]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class CommentAuthor : DocumentFormat.OpenXml.OpenXmlCompositeElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Presentation.CommentAuthorExtensionList))>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(24, "cmAuthor")>]
type CommentAuthor = class
inherit OpenXmlCompositeElementtype CommentAuthor = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.SchemaAttr(24, "cmAuthor")>]
type CommentAuthor = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.SchemaAttr("p:cmAuthor")>]
type CommentAuthor = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.SchemaAttr("p:cmAuthor")>]
type CommentAuthor = class
inherit TypedOpenXmlCompositeElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Presentation.CommentAuthorExtensionList))>]
type CommentAuthor = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Presentation.CommentAuthorExtensionList))>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type CommentAuthor = class
inherit OpenXmlCompositeElementPublic Class CommentAuthor
Inherits OpenXmlCompositeElementPublic Class CommentAuthor
Inherits TypedOpenXmlCompositeElement- Inheritance
- Inheritance
- Attributes
Remarks
[ISO/IEC 29500-1 1st Edition]
cmAuthor (Comment Author)
This element specifies a single author with comments in the document. It contains a unique author ID, the author's name and initials, the index of the author's last comment, and the index of a color associated with the author.
[Example:
<p:cmAuthor id="0" name="Julie Lee" initials="JL" lastIdx="1" clrIdx="0"/>
end example]
| Parent Elements |
|---|
| cmAuthorLst (§19.4.3) |
| Child Elements | Subclause |
|---|---|
| extLst (Extension List) | §19.2.1.12 |
| Attributes | Description |
|---|---|
| clrIdx (Comment Author Color Index) | This attribute specifies an index into the generating application's comments color table to allow for visual (color) differentiation of different author's comments. This color is used for all comments by this author. If more authors exist than there are entries in the color table, the color index wraps around to the beginning of the table. [Note: It is left entirely up to the generating application to determine the amount of colors used in the comments color table and in what order these are used when rendering comments on a slide surface. end note] The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
| id (Comment Author ID) | This attribute specifies a unique (within the document) zero-based identifier that refers to a single comment author. [Note: The method of generating an author id is determined by the application and need not be sequential, provided each id is unique within the list of comment authors for the document. end note] The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
| initials (Comment Author Initials) | This attribute specifies a string that represents the initials of this particular author. The value is not necessarily unique. It is intended for use by the application as an abbreviated version of the comment author's name. The possible values for this attribute are defined by the ST_Name simple type (§19.7.5). |
| lastIdx (Index of Comment Author's last comment) | Index of the last comment added to this document by this author. New comments by this author are counted starting with the value one greater than this index. [Note: The index of a deleted comment is not reused; therefore, this value is not an accurate count of the total number of comments by the author. end note] The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
| name (Comment Author Name) | This attribute specifies the full name of this particular author. As a string, it has no security or authentication data. This value is not guaranteed to be unique across all document authors. The possible values for this attribute are defined by the ST_Name simple type (§19.7.5). |
[Note: The W3C XML Schema definition of this element’s content model (CT_CommentAuthor) is located in §A.3. end note]
� ISO/IEC29500: 2008.
Constructors
| CommentAuthor() |
Initializes a new instance of the CommentAuthor class. |
| CommentAuthor(IEnumerable<OpenXmlElement>) |
Initializes a new instance of the CommentAuthor class with the specified child elements. |
| CommentAuthor(OpenXmlElement[]) |
Initializes a new instance of the CommentAuthor class with the specified child elements. |
| CommentAuthor(String) |
Initializes a new instance of the CommentAuthor class from outer XML. |
Properties
| ChildElements |
Gets all the child nodes of the current element. (Inherited from OpenXmlElement) |
| ColorIndex |
clrIdx Represents the following attribute in the schema: clrIdx |
| CommentAuthorExtensionList |
CommentAuthorExtensionList. Represents the following element tag in the schema: p:extLst. |
| 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) |
| 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) |
| Id |
id Represents the following attribute in the schema: id |
| Initials |
initials Represents the following attribute in the schema: initials |
| 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) |
| LastIndex |
lastIdx Represents the following attribute in the schema: lastIdx |
| LocalName | |
| 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 |
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) |
| 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) |