Visio.Comment class

Package:

visio

Represents the Comment.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: 1.1 ]

Properties

author	A string that specifies the name of the author of the comment.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
date	A string that specifies the date when the comment was created.
text	A string that contains the comment text.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
setMockData(data)	Set mock data
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.Comment object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.CommentData) that contains shallow copies of any loaded child properties from the original object.

Property Details

author

A string that specifies the name of the author of the comment.

author: string;

Property Value

string

Remarks

[ API set: 1.1 ]

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

Visio.RequestContext

date

A string that specifies the date when the comment was created.

date: string;

Property Value

string

Remarks

[ API set: 1.1 ]

text

A string that contains the comment text.

text: string;

Property Value

string

Remarks

[ API set: 1.1 ]

Method Details

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.CommentLoadOptions): Visio.Comment;

Parameters

options

Visio.Interfaces.CommentLoadOptions

Provides options for which properties of the object to load.

Returns

Visio.Comment

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.Comment;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Visio.Comment

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?: {
            select?: string;
            expand?: string;
        }): Visio.Comment;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

Visio.Comment

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Visio.Interfaces.CommentUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Visio.Comment): void;

Parameters

properties

Visio.Comment

Returns

void

setMockData(data)

Set mock data

setMockData(data: Visio.Interfaces.CommentData): void;

Parameters

data

Visio.Interfaces.CommentData

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.Comment object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.CommentData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Visio.Interfaces.CommentData;

Returns

Visio.Interfaces.CommentData