Word.DocumentCreated class
O objeto DocumentCreated é o objeto de nível superior criado por Application.CreateDocument. Um objeto DocumentCreated é um objeto Document 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 = 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();
});
Propriedades
| body | Obtém o objeto body 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 controle de conteúdo no documento. Isso inclui controles de conteúdo no corpo do documento, cabeçalhos, rodapés, caixas de texto etc. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 seção no documento. |
| settings | Obtém as configuraçõ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 |
Exclui um indicador, se ele existir, do documento. |
| get |
Obtém o intervalo de um indicador. Gerará um |
| get |
Obtém o intervalo de um indicador. Se o indicador não existir, esse método retornará um objeto com sua |
| get |
Obtém os controles de conteúdo com suporte no momento 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 em um local específico com propriedades adicionais. Cabeçalhos, rodapés, marcas d'água e outras propriedades de seção são copiados por padrã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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um 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. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar |
Detalhes da propriedade
body
Obtém o objeto body 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 controle de conteúdo no documento. Isso inclui controles 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 seção no documento.
readonly sections: Word.SectionCollection;Valor da propriedade
Comentários
settings
Obtém as configuraçõ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 de caracteres que representa o nome do estilo.
- type
- Word.StyleType
Obrigatório. O tipo de estilo, incluindo caractere, 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 de caracteres que representa o nome do estilo.
- typeString
-
"Character" | "List" | "Paragraph" | "Table"
Obrigatório. O tipo de estilo, incluindo caractere, lista, parágrafo ou tabela.
Retornos
Comentários
deleteBookmark(name)
Exclui um indicador, se ele existir, do documento.
deleteBookmark(name: string): void;Parâmetros
- name
-
string
Obrigatório. O nome do indicador insensibilidade de maiúsculas de maiúsculas de minúsculas.
Retornos
void
Comentários
getBookmarkRange(name)
Obtém o intervalo de um indicador. Gerará um ItemNotFound erro se o indicador não existir.
getBookmarkRange(name: string): Word.Range;Parâmetros
- name
-
string
Obrigatório. O nome do indicador insensibilidade de maiúsculas de maiúsculas de minúsculas.
Retornos
Comentários
getBookmarkRangeOrNullObject(name)
Obtém o intervalo de um indicador. Se o indicador não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getBookmarkRangeOrNullObject(name: string): Word.Range;Parâmetros
- name
-
string
Obrigatório. O nome do indicador insensibilidade de maiúsculas de maiúsculas de minúsculas. Há suporte apenas para caracteres alfanuméricos e sublinhados. Ele deve começar com uma letra, mas se você quiser marcar o indicador como oculto, inicie o nome com um caractere sublinhado. Os nomes não podem ter mais de 40 caracteres.
Retornos
Comentários
getContentControls(options)
Obtém os controles de conteúdo com suporte no momento no documento.
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;Parâmetros
- options
- Word.ContentControlOptions
Opcional. Opções que definem quais controles de conteúdo são retornados.
Retornos
Comentários
[ Conjunto de API: WordApiHiddenDocument 1.5 ]
Importante: se tipos específicos forem fornecidos no parâmetro de opções, somente os controles de conteúdo dos tipos com suporte serão retornados. Lembre-se de que uma exceção será gerada no uso de métodos de uma Word genérica. ContentControl que não são relevantes para o tipo específico. Com o tempo, podem ser suportados tipos adicionais de controles de conteúdo. Portanto, seu suplemento deve solicitar e manipular tipos específicos de controles 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 em um local específico com propriedades adicionais. Cabeçalhos, rodapés, marcas d'água e outras propriedades de seção são copiados por padrã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 arquivo .docx.
Obrigatório. O valor deve ser 'Replace', 'Start' ou 'End'.
- 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 ]
Observação: não há suporte para inserção se o documento inserido contiver um controle ActiveX (provavelmente em um campo de formulário). Considere substituir esse campo de formulário por um controle de conteúdo ou outra opção apropriada para 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
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. DocumentCreated só dá suporte a 'Salvar'.
- fileName
-
string
Opcional. O nome do arquivo (excluir extensão de arquivo). Só entra em vigor para um novo documento.
Retornos
void
Comentários
[ Conjunto de API: WordApiHiddenDocument 1.3 ]
Observação: 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. DocumentCreated só dá suporte a 'Salvar'.
- fileName
-
string
Opcional. O nome do arquivo (excluir extensão de arquivo). Só entra em vigor para um novo documento.
Retornos
void
Comentários
[ Conjunto de API: WordApiHiddenDocument 1.3 ]
Observação: 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. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. Objeto DocumentCreated é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.DocumentCreatedData) que contém cópias rasas de quaisquer propriedades filho 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. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
track(): Word.DocumentCreated;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.
untrack(): Word.DocumentCreated;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de