Word.Application class

Paquet:

word

Représente l’objet d’application.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Propriétés

context

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

Méthodes

createDocument(base64File)	Crée un document à l’aide d’un fichier .docx encodé en Base64 facultatif.
newObject(context)	Créez une instance de l’objet Word.Application .
openDocument(filePath)	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
retrieveStylesFromBase64(base64File)	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.
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 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.

Détails de la propriété

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

Détails de la méthode

createDocument(base64File)

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

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

Paramètres

base64File

string

Optional. Fichier .docx encodé en Base64. La valeur par défaut est null.

Retours

Word.DocumentCreated

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

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

newObject(context)

Créez une instance de l’objet Word.Application .

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

Paramètres

context

OfficeExtension.ClientRequestContext

Retours

Word.Application

openDocument(filePath)

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

filePath

string

Obligatoire. Chemin d’accès absolu du fichier .docx. Word sur le web prend uniquement en charge les emplacements distants (cloud), tandis que Word sur Windows, Mac et iOS prennent en charge les emplacements locaux et distants.

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.6 ]

retrieveStylesFromBase64(base64File)

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

base64File

string

Obligatoire. Fichier de modèle.

Retours

OfficeExtension.ClientResult<string>

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

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 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(): {
            [key: string]: string;
        };

Retours

{ [key: string]: string; }