Word.DocumentProperties class

  • Referência
Pacote:
word

Representa as propriedades do documento.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.3 ]

Propriedades

applicationName

Obtém o nome do aplicativo do documento.
author

Especifica o autor do documento.
category

Especifica a categoria do documento.
comments

Especifica os comentários do documento.
company

Especifica a empresa do documento.
context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
creationDate

Obtém a data de criação do documento.
customProperties

Obtém a coleção de propriedades personalizadas do documento.
format

Especifica o formato do documento.
keywords

Especifica as palavras-chave do documento.
lastAuthor

Obtém o último autor do documento.
lastPrintDate

Obtém a data de impressão do documento.
lastSaveTime

Obtém a hora em que o documento foi salvo pela última vez.
manager

Especifica o gerente do documento.
revisionNumber

Obtém o número de revisão do documento.
security

Obtém as configurações de segurança do documento. Algumas são restrições de acesso no arquivo em disco. Outras são configurações de Proteção de Documentos. Alguns valores possíveis são 0 = Arquivo em disco é leitura/gravação; 1 = Proteger Documento: o arquivo é criptografado e requer uma senha para abrir; 2 = Proteger Documento: Sempre Aberto como Somente Leitura; 3 = Proteger Documento: #1 e #2; 4 = O arquivo em disco é somente leitura; 5 = #1 e #4; 6 = #2 e #4; 7 = Todos os #1, #2 e #4; 8 = Proteger Documento: restringir a edição somente para leitura; 9 = #1 e #8; 10 = #2 e #8; 11 = Todos os #1, #2 e #8; 12 = #4 e #8; 13 = Todos os #1, #4 e #8; 14 = Todos os #2, #4 e #8; 15 = Todos os #1, #2, #4 e #8.
subject

Especifica o assunto do documento.
template

Obtém o modelo do documento.
title

Especifica o título do 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.
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 DocumentProperties é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.DocumentPropertiesData) 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

applicationName

Obtém o nome do aplicativo do documento.

readonly applicationName: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

author

Especifica o autor do documento.

author: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

category

Especifica a categoria do documento.

category: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

comments

Especifica os comentários do documento.

comments: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

company

Especifica a empresa do documento.

company: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 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

creationDate

Obtém a data de criação do documento.

readonly creationDate: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: WordApi 1.3 ]

customProperties

Obtém a coleção de propriedades personalizadas do documento.

readonly customProperties: Word.CustomPropertyCollection;

Valor da propriedade

Word.CustomPropertyCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

format

Especifica o formato do documento.

format: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

keywords

Especifica as palavras-chave do documento.

keywords: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

lastAuthor

Obtém o último autor do documento.

readonly lastAuthor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

lastPrintDate

Obtém a data de impressão do documento.

readonly lastPrintDate: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: WordApi 1.3 ]

lastSaveTime

Obtém a hora em que o documento foi salvo pela última vez.

readonly lastSaveTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: WordApi 1.3 ]

manager

Especifica o gerente do documento.

manager: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

revisionNumber

Obtém o número de revisão do documento.

readonly revisionNumber: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

security

Obtém as configurações de segurança do documento. Algumas são restrições de acesso no arquivo em disco. Outras são configurações de Proteção de Documentos. Alguns valores possíveis são 0 = Arquivo em disco é leitura/gravação; 1 = Proteger Documento: o arquivo é criptografado e requer uma senha para abrir; 2 = Proteger Documento: Sempre Aberto como Somente Leitura; 3 = Proteger Documento: #1 e #2; 4 = O arquivo em disco é somente leitura; 5 = #1 e #4; 6 = #2 e #4; 7 = Todos os #1, #2 e #4; 8 = Proteger Documento: restringir a edição somente para leitura; 9 = #1 e #8; 10 = #2 e #8; 11 = Todos os #1, #2 e #8; 12 = #4 e #8; 13 = Todos os #1, #4 e #8; 14 = Todos os #2, #4 e #8; 15 = Todos os #1, #2, #4 e #8.

readonly security: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.3 ]

subject

Especifica o assunto do documento.

subject: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

template

Obtém o modelo do documento.

readonly template: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

title

Especifica o título do documento.

title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 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.DocumentPropertiesLoadOptions): Word.DocumentProperties;

Parâmetros

options
Word.Interfaces.DocumentPropertiesLoadOptions

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

Retornos

Word.DocumentProperties

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

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.DocumentProperties

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

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.DocumentProperties

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

Parâmetros

properties
Word.Interfaces.DocumentPropertiesUpdateData

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.DocumentProperties): void;

Parâmetros

properties
Word.DocumentProperties

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 DocumentProperties é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.DocumentPropertiesData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.DocumentPropertiesData;

Retornos

Word.Interfaces.DocumentPropertiesData

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

Retornos

Word.DocumentProperties

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

Retornos

Word.DocumentProperties