Word.Editor class

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é

Obtient l’identifiant de l’objet Editor lorsque le document parent est enregistré en tant que page web.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Récupère le nom de l’éditeur.

readonly name: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient un Range objet qui représente la plage suivante que l’éditeur est autorisé à modifier.

readonly nextRange: Word.Range;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient un Range objet qui représente la partie du document contenue dans l’objet Editor .

readonly range: Word.Range;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime l’objet Editor .

delete(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

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.EditorLoadOptions): Word.Editor;

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(propertyNames?: string | string[]): Word.Editor;

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

Paramètres

Retours

Supprime toutes les autorisations de modification du document pour l’éditeur. L’éditeur sera supprimé lors de la prochaine ouverture du document.

removeAllPermissions(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Sélectionne toutes les formes du document qui ont été insérées ou modifiées par l’éditeur.

selectAllShapes(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

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.EditorUpdateData, 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: Word.Editor): 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 d’origine Word.Editor est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.EditorDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.EditorData;

Retours

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 entre 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 suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Editor;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 libération de mémoire prenne effet.

untrack(): Word.Editor;

Retours