Word.CommentContentRange class

Paquet:

word

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Propriétés

bold	Spécifie une valeur qui indique si le texte du commentaire est en gras.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
hyperlink	Obtient le premier lien hypertexte de la plage ou définit un lien hypertexte sur la plage. Tous les liens hypertexte de la plage sont supprimés lorsque vous définissez un nouveau lien hypertexte sur celle-ci.
isEmpty	Vérifie si la longueur de la plage est zéro.
italic	Spécifie une valeur qui indique si le texte du commentaire est en italique.
strikeThrough	Spécifie une valeur qui indique si le texte du commentaire a un barré.
text	Obtient le texte de la plage de commentaires.
underline	Spécifie une valeur qui indique le type de soulignement du texte du commentaire. ' None' si le texte du commentaire n’est pas souligné.

Méthodes

insertText(text, insertLocation)	Insère du texte dans à l’emplacement spécifié. Remarque : Pour le commentaire moderne, la plage de contenu suivie dans le contexte devient vide si une révision du commentaire est publiée via l’interface utilisateur.
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 le Word d’origine. L’objet CommentContentRange est un objet API. La toJSON méthode renvoie un objet JavaScript brut (tapé en tant Word.Interfaces.CommentContentRangeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()	Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

bold

Spécifie une valeur qui indique si le texte du commentaire est en gras.

bold: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.4 ]

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é

Word.RequestContext

hyperlink

Obtient le premier lien hypertexte de la plage ou définit un lien hypertexte sur la plage. Tous les liens hypertexte de la plage sont supprimés lorsque vous définissez un nouveau lien hypertexte sur celle-ci.

hyperlink: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.4 ]

isEmpty

Vérifie si la longueur de la plage est zéro.

readonly isEmpty: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.4 ]

italic

Spécifie une valeur qui indique si le texte du commentaire est en italique.

italic: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.4 ]

strikeThrough

Spécifie une valeur qui indique si le texte du commentaire a un barré.

strikeThrough: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.4 ]

text

Obtient le texte de la plage de commentaires.

readonly text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.4 ]

underline

Spécifie une valeur qui indique le type de soulignement du texte du commentaire. ' None' si le texte du commentaire n’est pas souligné.

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

Valeur de propriété

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Détails de la méthode

insertText(text, insertLocation)

Insère du texte dans à l’emplacement spécifié. Remarque : Pour le commentaire moderne, la plage de contenu suivie dans le contexte devient vide si une révision du commentaire est publiée via l’interface utilisateur.

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;

Paramètres

text

string

Obligatoire. Texte à insérer dans le CommentContentRange.

insertLocation

Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatoire. La valeur doit être « Replace », « Start », « End », « Before » ou « After ».

Retours

Word.CommentContentRange

Remarques

[ Ensemble d’API : WordApi 1.4 ]

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?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;

Paramètres

options

Word.Interfaces.CommentContentRangeLoadOptions

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

Retours

Word.CommentContentRange

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[]): Word.CommentContentRange;

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

Word.CommentContentRange

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;
        }): Word.CommentContentRange;

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

Word.CommentContentRange

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.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Word.Interfaces.CommentContentRangeUpdateData

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: Word.CommentContentRange): void;

Paramètres

properties

Word.CommentContentRange

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 le Word d’origine. L’objet CommentContentRange est un objet API. La toJSON méthode renvoie un objet JavaScript brut (tapé en tant Word.Interfaces.CommentContentRangeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.CommentContentRangeData;

Retours

Word.Interfaces.CommentContentRangeData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.CommentContentRange;

Retours

Word.CommentContentRange

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.CommentContentRange;

Retours

Word.CommentContentRange