Word.DocumentCreated class

Obtient l’objet Body du document. Le corps est le texte qui exclut les en-têtes, les pieds de page, les notes de bas de page, les zones de texte, etc.

readonly body: Word.Body;

Valeur de la propriété

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.3 ]

Obtient la collection d’objets ContentControl dans le document. Cela inclut les contrôles de contenu dans le corps du document, les en-têtes, les pieds de page, les zones de texte, etc.

readonly contentControls: Word.ContentControlCollection;

Valeur de la propriété

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.3 ]

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 la propriété

Obtient les parties XML personnalisées dans le document.

readonly customXmlParts: Word.CustomXmlPartCollection;

Valeur de la propriété

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.4 ]

Obtient les propriétés du document.

readonly properties: Word.DocumentProperties;

Valeur de la propriété

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.3 ]

Indique si les modifications apportées au document ont été enregistrées. La valeur indique true que le document n’a pas changé depuis son enregistrement.

readonly saved: boolean;

Valeur de la propriété

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.3 ]

Obtient la collection d’objets Section dans le document.

readonly sections: Word.SectionCollection;

Valeur de la propriété

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.3 ]

Obtient les paramètres du complément dans le document.

readonly settings: Word.SettingCollection;

Valeur de la propriété

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.4 ]

Ajoute un style dans le document par nom et par type.

addStyle(name: string, type: Word.StyleType): Word.Style;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.5 ]

Ajoute un style dans le document par nom et par type.

addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.5 ]

Supprime un signet, s’il existe, du document.

deleteBookmark(name: string): void;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.4 ]

Obtient la plage d’un signet. Génère une ItemNotFound erreur si le signet n’existe pas.

getBookmarkRange(name: string): Word.Range;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.4 ]

Obtient la plage d’un signet. Si le signet n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getBookmarkRangeOrNullObject(name: string): Word.Range;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.4 ]

Obtient les contrôles de contenu actuellement pris en charge dans le document.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.5 ]

Important : si des types spécifiques sont fournis dans le paramètre options, seuls les contrôles de contenu des types pris en charge sont retournés. N’oubliez pas qu’une exception sera levée à l’aide de méthodes d’un Word générique. ContentControl qui ne sont pas pertinents pour le type spécifique. Avec le temps, d’autres types de contrôles de contenu peuvent être pris en charge. Par conséquent, votre complément doit demander et gérer des types spécifiques de contrôles de contenu.

Obtient un StyleCollection objet qui représente l’ensemble du jeu de styles du document.

getStyles(): Word.StyleCollection;

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.5 ]

Insère un document dans le document cible à un emplacement spécifique avec des propriétés supplémentaires. Les en-têtes, pieds de page, filigranes et autres propriétés de section sont copiés par défaut.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.5 ]

L’insertion n’est pas prise en charge si le document inséré contient un contrôle ActiveX (probablement dans un champ de formulaire). Envisagez de remplacer un tel champ de formulaire par un contrôle de contenu ou une autre option appropriée pour votre scénario.

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.DocumentCreatedLoadOptions): Word.DocumentCreated;

Paramètres

Retourne

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.DocumentCreated;

Paramètres

Retourne

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.DocumentCreated;

Paramètres

Retourne

Ouvre le document.

open(): void;

Retourne

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Create and open a new document in a new tab or window.
await Word.run(async (context) => {
    const externalDoc = context.application.createDocument();
    await context.sync();

    externalDoc.open();
    await context.sync();
});

Enregistre le document.

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.3 ]

Remarque : Les saveBehavior paramètres et fileName ont été introduits dans WordApiHiddenDocument 1.5.

Enregistre le document.

save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;

Paramètres

Retourne

Remarques

[ Ensemble d’API : WordApiHiddenDocument 1.3 ]

Remarque : Les saveBehavior paramètres et fileName ont été introduits dans WordApiHiddenDocument 1.5.

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

Paramètres

Retourne

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

set(properties: Word.DocumentCreated): void;

Paramètres

Retourne

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.DocumentCreated est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.DocumentCreatedDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.DocumentCreatedData;

Retourne

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.DocumentCreated;

Retourne

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.DocumentCreated;

Retourne