Edit

Share via

Visio.Interfaces.CommentCollectionLoadOptions interface

  • Reference
Package:
visio

Represents the CommentCollection for a given Shape.

Remarks

[ API set: 1.1 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
author

For EACH ITEM in the collection: A string that specifies the name of the author of the comment.
date

For EACH ITEM in the collection: A string that specifies the date when the comment was created.
text

For EACH ITEM in the collection: A string that contains the comment text.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

author

For EACH ITEM in the collection: A string that specifies the name of the author of the comment.

author?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

date

For EACH ITEM in the collection: A string that specifies the date when the comment was created.

date?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

text

For EACH ITEM in the collection: A string that contains the comment text.

text?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]