Visio.CommentCollection class

Paquete:

visio

Representa el elemento CommentCollection de una forma determinada.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: 1.1 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

getCount()	Obtiene el número de comentarios.
getItem(key)	Obtiene el comentario por medio de su nombre.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Visio.CommentCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.CommentCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Visio.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Visio.Comment[];

Valor de propiedad

Visio.Comment[]

Detalles del método

getCount()

Obtiene el número de comentarios.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: 1.1 ]

getItem(key)

Obtiene el comentario por medio de su nombre.

getItem(key: string): Visio.Comment;

Parámetros

key

string

"Key" corresponde al nombre del comentario que se va a recuperar.

Devoluciones

Visio.Comment

Comentarios

[ Conjunto de API: 1.1 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Visio.Interfaces.CommentCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.CommentCollection;

Parámetros

options

Visio.Interfaces.CommentCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Visio.CommentCollection

Ejemplos

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)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Visio.CommentCollection;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Visio.CommentCollection

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.CommentCollection;

Parámetros

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Visio.CommentCollection

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Visio.CommentCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.CommentCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Visio.Interfaces.CommentCollectionData;

Devoluciones

Visio.Interfaces.CommentCollectionData