Visio.Comment class

Paquet:

visio

Représente le commentaire.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : 1.1 ]

Propriétés

author	Chaîne indiquant le nom de l’auteur du commentaire.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
date	Chaîne spécifiant la date à laquelle le commentaire a été créé.
text	Chaîne contenant le texte du commentaire.

Méthodes

load(options)	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)	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)	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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Visio.Comment d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Visio.Interfaces.CommentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

author

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

author: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Visio.RequestContext

date

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

date: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

text

Chaîne contenant le texte du commentaire.

text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : 1.1 ]

Détails de la méthode

load(options)

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

options

Visio.Interfaces.CommentLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Visio.Comment

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

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Visio.Comment

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Visio.Comment

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties

Visio.Interfaces.CommentUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

properties

Visio.Comment

Retours

void

toJSON()

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

toJSON(): Visio.Interfaces.CommentData;

Retours

Visio.Interfaces.CommentData