Word.Application class

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é

Crée un document à l’aide d’un fichier .docx encodé en Base64 facultatif.

createDocument(base64File?: string): Word.DocumentCreated;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  const externalDoc: Word.DocumentCreated = context.application.createDocument(externalDocument);
  await context.sync();

  if (!Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.3")) {
    console.warn("The WordApiHiddenDocument 1.3 requirement set isn't supported on this client so can't proceed. Try this action on a platform that supports this requirement set.");
    return;
  }

  const externalDocBody: Word.Body = externalDoc.body;
  externalDocBody.load("text");
  await context.sync();

  // Insert the external document's text at the beginning of the current document's body.
  const externalDocBodyText = externalDocBody.text;
  const currentDocBody: Word.Body = context.document.body;
  currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
  await context.sync();
});

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.ApplicationLoadOptions): Word.Application;

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

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

Paramètres

Retours

Créez une instance de l’objetWord.Application.

static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;

Paramètres

Retours

Ouvre un document et l’affiche dans un nouvel onglet ou une nouvelle fenêtre. Voici des exemples pour les différents clients et plateformes pris en charge.

• Exemple d’emplacement distant ou cloud : https://microsoft.sharepoint.com/some/path/Document.docx

• Exemples d’emplacement local pour Windows : C:\\Users\\Someone\\Documents\\Document.docx (inclut les barres obliques inverses d’échappement requises), file://mycomputer/myfolder/Document.docx

• Exemple d’emplacement local pour Mac et iOS : /User/someone/document.docx

openDocument(filePath: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Analysez les styles à partir du fichier Base64 du modèle et retournez le format JSON des styles récupérés sous forme de chaîne.

retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/get-external-styles.yaml

// Gets style info from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  const retrievedStyles = context.application.retrieveStylesFromBase64(externalDocument);
  await context.sync();

  console.log("Styles from the other document:", retrievedStyles.value);
});

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

toJSON(): Word.Interfaces.ApplicationData;

Retours