Visio.Comment class

Chaîne indiquant le nom de l’auteur du commentaire.

author: string;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Chaîne spécifiant la date à laquelle le commentaire a été créé.

date: string;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Chaîne contenant le texte du commentaire.

text: string;

Valeur de propriété

Remarques

Jeu d’API : 1.1

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Visio.Interfaces.CommentLoadOptions): Visio.Comment;

Paramètres

Retours

Exemples

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));
    }
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.Comment;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Visio.Comment): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.Comment d’origine est un objet API, la méthode renvoie un objet JavaScript simple (dont le toJSON type Visio.Interfaces.CommentData) contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Visio.Interfaces.CommentData;

Retours