CommentAuthor.ColorIndex Property

Comment Author Color Index.Represents the attribte in schema: clrIdx

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

Syntax

'Declaration
<SchemaAttrAttribute(, "clrIdx")> _
Public Property ColorIndex As UInt32Value
    Get
    Set
'Usage
Dim instance As CommentAuthor
Dim value As UInt32Value

value = instance.ColorIndex

instance.ColorIndex = value
[SchemaAttrAttribute(, "clrIdx")]
public UInt32Value ColorIndex { get; set; }

Property Value

Type: DocumentFormat.OpenXml.UInt32Value
Returns UInt32Value.

Remarks

The following information from the ECMA International Standard ECMA-376 can be useful when working with this class.

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.

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 will be used when rendering comments on a slide surface.

The possible values for this attribute are defined by the XML Schema unsignedInt datatype.

See Also

Reference

CommentAuthor Class

CommentAuthor Members

DocumentFormat.OpenXml.Presentation Namespace