Visio.CommentCollection class
Represents the CommentCollection for a given Shape.
- Extends
Remarks
[ API set: 1.1 ]
Properties
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
items | Gets the loaded child items in this collection. |
Methods
get |
Gets the number of Comments. |
get |
Gets the Comment using its name. |
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
set |
Set mock data |
toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Property Value
items
Gets the loaded child items in this collection.
readonly items: Visio.Comment[];
Property Value
Method Details
getCount()
Gets the number of Comments.
getCount(): OfficeExtension.ClientResult<number>;
Returns
OfficeExtension.ClientResult<number>
Remarks
[ API set: 1.1 ]
getItem(key)
Gets the Comment using its name.
getItem(key: string): Visio.Comment;
Parameters
- key
-
string
Key is the name of the Comment to be retrieved.
Returns
Remarks
[ API set: 1.1 ]
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(options?: Visio.Interfaces.CommentCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.CommentCollection;
Parameters
Provides options for which properties of the object to load.
Returns
Examples
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shapeName = "Position Belt.41";
const shape = activePage.shapes.getItem(shapeName);
const shapeComments= shape.comments;
shapeComments.load(["author", "text"]);
return ctx.sync().then(function () {
for (let i = 0; i < shapeComments.items.length; i++)
{
const comment = shapeComments.items[i];
console.log("comment Author: " + comment.author);
console.log("Comment Text: " + comment.text);
console.log("Date " + comment.date);
}
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNames?: string | string[]): Visio.CommentCollection;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.CommentCollection;
Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand
is a comma-delimited string that specifies the navigation properties to load.
Returns
setMockData(data)
Set mock data
setMockData(data: Visio.Interfaces.CommentCollectionData): void;
Parameters
Returns
void
toJSON()
Overrides the JavaScript toJSON()
method in order to provide more useful output when an API object is passed to JSON.stringify()
. (JSON.stringify
, in turn, calls the toJSON
method of the object that is passed to it.) Whereas the original Visio.CommentCollection
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Visio.Interfaces.CommentCollectionData
) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Visio.Interfaces.CommentCollectionData;
Returns
Office Add-ins