Word.Application class
Representa o objeto da aplicação.
- Extends
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// 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();
});
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
Métodos
| create |
Cria um novo documento com um ficheiro de .docx codificado em Base64 opcional. |
| new |
Crie uma nova instância do |
| open |
Abre um documento e apresenta-o num novo separador ou janela. Seguem-se exemplos para os vários clientes e plataformas suportados.
|
| retrieve |
Analise os estilos do ficheiro Base64 do modelo e devolva o formato JSON dos estilos obtidos como uma cadeia. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
Detalhes do método
createDocument(base64File)
Cria um novo documento com um ficheiro de .docx codificado em Base64 opcional.
createDocument(base64File?: string): Word.DocumentCreated;Parâmetros
- base64File
-
string
Opcional. O ficheiro de .docx codificado com Base64. O valor padrão é nulo.
Retornos
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// 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();
});
newObject(context)
Crie uma nova instância do Word.Application objeto.
static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;Parâmetros
Retornos
openDocument(filePath)
Abre um documento e apresenta-o num novo separador ou janela. Seguem-se exemplos para os vários clientes e plataformas suportados.
Exemplo de localização remota ou na cloud:
https://microsoft.sharepoint.com/some/path/Document.docxExemplos de localização local para o Windows:
C:\\Users\\Someone\\Documents\\Document.docx(inclui barras invertidas escapadas necessárias),file://mycomputer/myfolder/Document.docxExemplo de localização local para Mac e iOS:
/User/someone/document.docx
openDocument(filePath: string): void;Parâmetros
- filePath
-
string
Obrigatório. O caminho absoluto do ficheiro .docx. Word na Web suportam apenas localizações remotas (na nuvem), enquanto Word no Windows, no Mac e no iOS suportam localizações locais e remotas.
Retornos
void
Comentários
retrieveStylesFromBase64(base64File)
Analise os estilos do ficheiro Base64 do modelo e devolva o formato JSON dos estilos obtidos como uma cadeia.
retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;Parâmetros
- base64File
-
string
Obrigatório. O ficheiro de modelo.
Retornos
OfficeExtension.ClientResult<string>
Comentários
[ Conjunto de API: WordApi 1.5 ]
Exemplos
// 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()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Application é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): {
[key: string]: string;
};Retornos
{ [key: string]: string; }