Word.Application class
Représente l’objet d’application.
- Extends
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
create |
Crée un document à l’aide d’un fichier .docx encodé en Base64 facultatif. |
new |
Créez une instance de Word. Objet Application |
retrieve |
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 |
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é
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
Facultatif. Fichier .docx encodé en Base64. La valeur par défaut est null.
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 = context.application.createDocument(externalDocument);
await context.sync();
const externalDocBody = 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 = context.document.body;
currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
await context.sync();
});
newObject(context)
Créez une instance de Word. Objet Application
static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;
Paramètres
Retours
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.stringify
appelle à son tour la toJSON
méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet Application est un objet API. La toJSON
méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ApplicationData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): {
[key: string]: string;
};
Retours
{ [key: string]: string; }
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour