CommentAuthor Class

Comment Author.When the object is serialized out as xml, its qualified name is p:cmAuthor.

Namespace:  DocumentFormat.OpenXml.Presentation
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

[ChildElementInfoAttribute(typeof(ExtensionList))]
public class CommentAuthor : OpenXmlCompositeElement

The following table lists the possible child types:

  • ExtensionList <p:extLst>


[ISO/IEC 29500-1 1st Edition]

19.4.2 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show: