Word.DocumentCreated class
O objeto DocumentCreated é o objeto de nível superior criado por Application.CreateDocument. Um objeto DocumentCreated é um objeto de Documento especial.
- 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();
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
| body | Obtém o objeto do corpo do documento. O corpo é o texto que exclui cabeçalhos, rodapés, notas de rodapé, caixas de texto, etc. |
| content |
Obtém a coleção de objetos de controlo de conteúdo no documento. Isto inclui controlos de conteúdo no corpo do documento, cabeçalhos, rodapés, caixas de texto, etc. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| custom |
Obtém as partes XML personalizadas no documento. |
| properties | Obtém as propriedades do documento. |
| saved | Indica se as alterações do documento foram salvas. Um valor true indica que o documento não foi alterado desde que foi salvo. |
| sections | Obtém a coleção de objetos de secção no documento. |
| settings | Obtém as definições do suplemento no documento. |
Métodos
| add |
Adiciona um estilo ao documento por nome e tipo. |
| add |
Adiciona um estilo ao documento por nome e tipo. |
| delete |
Elimina um marcador, se existir, do documento. |
| get |
Obtém o intervalo de um marcador. Gera um |
| get |
Obtém o intervalo de um marcador. Se o marcador não existir, este método devolverá um objeto com a respetiva |
| get |
Obtém os controlos de conteúdo atualmente suportados no documento. |
| get |
Obtém um objeto StyleCollection que representa todo o conjunto de estilos do documento. |
| insert |
Insere um documento no documento de destino numa localização específica com propriedades adicionais. Os cabeçalhos, rodapés, marcas d'água e outras propriedades de secção são copiados por predefinição. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| open() | Abre o documento. |
| save(save |
Salva o documento. |
| save(save |
Salva o documento. |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar |
Detalhes da propriedade
body
Obtém o objeto do corpo do documento. O corpo é o texto que exclui cabeçalhos, rodapés, notas de rodapé, caixas de texto, etc.
readonly body: Word.Body;Valor da propriedade
Comentários
contentControls
Obtém a coleção de objetos de controlo de conteúdo no documento. Isto inclui controlos de conteúdo no corpo do documento, cabeçalhos, rodapés, caixas de texto, etc.
readonly contentControls: Word.ContentControlCollection;Valor da propriedade
Comentários
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
customXmlParts
Obtém as partes XML personalizadas no documento.
readonly customXmlParts: Word.CustomXmlPartCollection;Valor da propriedade
Comentários
properties
Obtém as propriedades do documento.
readonly properties: Word.DocumentProperties;Valor da propriedade
Comentários
saved
Indica se as alterações do documento foram salvas. Um valor true indica que o documento não foi alterado desde que foi salvo.
readonly saved: boolean;Valor da propriedade
boolean
Comentários
sections
Obtém a coleção de objetos de secção no documento.
readonly sections: Word.SectionCollection;Valor da propriedade
Comentários
settings
Obtém as definições do suplemento no documento.
readonly settings: Word.SettingCollection;Valor da propriedade
Comentários
Detalhes do método
addStyle(name, type)
Adiciona um estilo ao documento por nome e tipo.
addStyle(name: string, type: Word.StyleType): Word.Style;Parâmetros
- name
-
string
Obrigatório. Uma cadeia que representa o nome do estilo.
- type
- Word.StyleType
Obrigatório. O tipo de estilo, incluindo caráter, lista, parágrafo ou tabela.
Retornos
Comentários
addStyle(name, typeString)
Adiciona um estilo ao documento por nome e tipo.
addStyle(name: string, typeString: "Character" | "List" | "Paragraph" | "Table"): Word.Style;Parâmetros
- name
-
string
Obrigatório. Uma cadeia que representa o nome do estilo.
- typeString
-
"Character" | "List" | "Paragraph" | "Table"
Obrigatório. O tipo de estilo, incluindo caráter, lista, parágrafo ou tabela.
Retornos
Comentários
deleteBookmark(name)
Elimina um marcador, se existir, do documento.
deleteBookmark(name: string): void;Parâmetros
- name
-
string
Obrigatório. O nome do marcador não sensível a maiúsculas e minúsculas.
Retornos
void
Comentários
getBookmarkRange(name)
Obtém o intervalo de um marcador. Gera um ItemNotFound erro se o marcador não existir.
getBookmarkRange(name: string): Word.Range;Parâmetros
- name
-
string
Obrigatório. O nome do marcador não sensível a maiúsculas e minúsculas.
Retornos
Comentários
getBookmarkRangeOrNullObject(name)
Obtém o intervalo de um marcador. Se o marcador não existir, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getBookmarkRangeOrNullObject(name: string): Word.Range;Parâmetros
- name
-
string
Obrigatório. O nome do marcador não sensível a maiúsculas e minúsculas. Apenas são suportados carateres alfanuméricos e de sublinhado. Tem de começar com uma letra, mas se quiser marcar o marcador como oculto, inicie o nome com um caráter de sublinhado. Os nomes não podem ter mais de 40 carateres.
Retornos
Comentários
getContentControls(options)
Obtém os controlos de conteúdo atualmente suportados no documento.
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;Parâmetros
- options
- Word.ContentControlOptions
Opcional. Opções que definem os controlos de conteúdo que são devolvidos.
Retornos
Comentários
[ Conjunto de API: WordApiHiddenDocument 1.5 ]
Importante: se forem fornecidos tipos específicos no parâmetro de opções, apenas são devolvidos controlos de conteúdo de tipos suportados. Tenha em atenção que será gerada uma exceção através de métodos de um Word genérico. ContentControl que não são relevantes para o tipo específico. Com o tempo, podem ser suportados tipos adicionais de controlos de conteúdo. Por conseguinte, o suplemento deve pedir e processar tipos específicos de controlos de conteúdo.
getStyles()
Obtém um objeto StyleCollection que representa todo o conjunto de estilos do documento.
getStyles(): Word.StyleCollection;Retornos
Comentários
insertFileFromBase64(base64File, insertLocation, insertFileOptions)
Insere um documento no documento de destino numa localização específica com propriedades adicionais. Os cabeçalhos, rodapés, marcas d'água e outras propriedades de secção são copiados por predefinição.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;Parâmetros
- base64File
-
string
Obrigatório. O conteúdo codificado em Base64 de um ficheiro .docx.
Obrigatório. O valor tem de ser "Substituir", "Iniciar" ou "Terminar".
- insertFileOptions
- Word.InsertFileOptions
Opcional. As propriedades adicionais que devem ser importadas para o documento de destino.
Retornos
Comentários
[ Conjunto de API: WordApiHiddenDocument 1.5 ]
Nota: a inserção não é suportada se o documento que está a ser inserido contiver um controlo ActiveX (provavelmente num campo de formulário). Considere substituir tal campo de formulário por um controlo de conteúdo ou outra opção adequada para o seu cenário.
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Word.DocumentCreated;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.DocumentCreated;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
open()
Abre o documento.
open(): void;Retornos
void
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// 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();
});
save(saveBehavior, fileName)
Salva o documento.
save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;Parâmetros
- saveBehavior
- Word.SaveBehavior
Opcional. O DocumentCreated só suporta "Guardar".
- fileName
-
string
Opcional. O nome do ficheiro (exclua a extensão de ficheiro). Só tem efeito para um novo documento.
Retornos
void
Comentários
[ Conjunto de API: WordApiHiddenDocument 1.3 ]
Nota: os saveBehavior parâmetros e fileName foram introduzidos no WordApiHiddenDocument 1.5.
save(saveBehaviorString, fileName)
Salva o documento.
save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;Parâmetros
- saveBehaviorString
-
"Save" | "Prompt"
Opcional. O DocumentCreated só suporta "Guardar".
- fileName
-
string
Opcional. O nome do ficheiro (exclua a extensão de ficheiro). Só tem efeito para um novo documento.
Retornos
void
Comentários
[ Conjunto de API: WordApiHiddenDocument 1.3 ]
Nota: os saveBehavior parâmetros e fileName foram introduzidos no WordApiHiddenDocument 1.5.
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Word.Interfaces.DocumentCreatedUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.DocumentCreated): void;Parâmetros
- properties
- Word.DocumentCreated
Retornos
void
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.DocumentCreated é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.DocumentCreatedData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.DocumentCreatedData;Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
track(): Word.DocumentCreated;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.
untrack(): Word.DocumentCreated;