Word.Editor class

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

Obtém o identificador do Editor objeto quando o documento pai é salvo como uma página da Web.

readonly id: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Obtém o nome do editor.

readonly name: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Obtém um Range objeto que representa o próximo intervalo que o editor tem permissão para modificar.

readonly nextRange: Word.Range;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Obtém um Range objeto que representa a parte do documento contida no Editor objeto.

readonly range: Word.Range;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Exclui o Editor objeto.

delete(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4

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.EditorLoadOptions): Word.Editor;

Parâmetros

Retornos

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.Editor;

Parâmetros

Retornos

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.Editor;

Parâmetros

Retornos

Remove todas as permissões de edição no documento para o editor. O editor será excluído na próxima vez que o documento for aberto.

removeAllPermissions(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Seleciona todas as formas no documento que foram inseridas ou editadas pelo editor.

selectAllShapes(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4

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.EditorUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Editor): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Editor é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.EditorData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.EditorData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de 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, 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.Editor;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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á ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Editor;

Retornos