Word.DocumentCreated class

Pacote:

word

O objeto DocumentCreated é o objeto de nível superior criado por Application.CreateDocument. Um objeto DocumentCreated é um objeto Document especial.

Extends

OfficeExtension.ClientObject

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.
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.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
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.

Métodos

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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
open()	Abre o documento.
save(saveBehavior, fileName)	Salva o documento.
save(saveBehaviorString, fileName)	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 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.
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.
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.

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

Word.Body

Comentários

[ Conjunto de API: WordApiHiddenDocument 1.3 ]

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

Word.ContentControlCollection

Comentários

[ Conjunto de API: WordApiHiddenDocument 1.3 ]

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

Word.RequestContext

properties

Obtém as propriedades do documento.

readonly properties: Word.DocumentProperties;

Valor da propriedade

Word.DocumentProperties

Comentários

[ Conjunto de API: WordApiHiddenDocument 1.3 ]

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

[ Conjunto de API: WordApiHiddenDocument 1.3 ]

sections

Obtém a coleção de objetos de seção no documento.

readonly sections: Word.SectionCollection;

Valor da propriedade

Word.SectionCollection

Comentários

[ Conjunto de API: WordApiHiddenDocument 1.3 ]

Detalhes do método

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

options

Word.Interfaces.DocumentCreatedLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.DocumentCreated

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

Word.DocumentCreated

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

Word.DocumentCreated

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

Word.Interfaces.DocumentCreatedData

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

Word.DocumentCreated

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

Word.DocumentCreated