Word.DocumentProperties class
Representa as propriedades do documento.
- Extends
[ Conjunto de API: WordApi 1.3 ]
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml
await Word.run(async (context) => {
const builtInProperties: Word.DocumentProperties = context.document.properties;
builtInProperties.load("*"); // Let's get all!
await context.sync();
console.log(JSON.stringify(builtInProperties, null, 4));
});
application |
Obtém o nome do aplicativo do documento. |
author | Especifica o autor do documento. |
category | Especifica a categoria do documento. |
comments | Especifica o campo Comentários nos metadados do documento. Estes não têm qualquer ligação aos comentários dos utilizadores efetuados no documento. |
company | Especifica a empresa do documento. |
context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
creation |
Obtém a data de criação do documento. |
custom |
Obtém a coleção de propriedades personalizadas do documento. |
format | Especifica o formato do documento. |
keywords | Especifica as palavras-chave do documento. |
last |
Obtém o último autor do documento. |
last |
Obtém a data de impressão do documento. |
last |
Obtém a hora em que o documento foi salvo pela última vez. |
manager | Especifica o gestor do documento. |
revision |
Obtém o número de revisão do documento. |
security | Obtém as definições de segurança do documento. Algumas são restrições de acesso ao ficheiro no disco. Outras são definições de Proteção de Documentos. Alguns valores possíveis são 0 = O ficheiro no disco é de leitura/escrita; 1 = Proteger Documento: o ficheiro é encriptado e requer uma palavra-passe para abrir; 2 = Proteger Documento: Abrir Sempre como Só de Leitura; 3 = Proteger Documento: n.º 1 e 2; 4 = O ficheiro no disco é só de leitura; 5 = N.º 1 e 4; 6 = N.º 2 e 4; 7 = Todos os n.º 1, 2 e 4; 8 = Proteger Documento: Restringir a Edição ao só de leitura; 9 = N.º 1 e 8; 10 = N.º 2 e 8; 11 = Todos os n.º 1, 2 e 8; 12 = N.º 4 e 8; 13 = Todos os n.º 1, 4 e 8; 14 = Todos os n.º 2, 4 e 8; 15 = Todos os n.º 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. |
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 |
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 |
Obtém o nome do aplicativo do documento.
readonly applicationName: string;
Valor da propriedade
string
Comentários
Especifica o autor do documento.
author: string;
Valor da propriedade
string
Comentários
Especifica a categoria do documento.
category: string;
Valor da propriedade
string
Comentários
Especifica o campo Comentários nos metadados do documento. Estes não têm qualquer ligação aos comentários dos utilizadores efetuados no documento.
comments: string;
Valor da propriedade
string
Comentários
Especifica a empresa do documento.
company: string;
Valor da propriedade
string
Comentários
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
Obtém a data de criação do documento.
readonly creationDate: Date;
Valor da propriedade
Date
Comentários
Obtém a coleção de propriedades personalizadas do documento.
readonly customProperties: Word.CustomPropertyCollection;
Valor da propriedade
Comentários
Especifica o formato do documento.
format: string;
Valor da propriedade
string
Comentários
Especifica as palavras-chave do documento.
keywords: string;
Valor da propriedade
string
Comentários
Obtém o último autor do documento.
readonly lastAuthor: string;
Valor da propriedade
string
Comentários
Obtém a data de impressão do documento.
readonly lastPrintDate: Date;
Valor da propriedade
Date
Comentários
Obtém a hora em que o documento foi salvo pela última vez.
readonly lastSaveTime: Date;
Valor da propriedade
Date
Comentários
Especifica o gestor do documento.
manager: string;
Valor da propriedade
string
Comentários
Obtém o número de revisão do documento.
readonly revisionNumber: string;
Valor da propriedade
string
Comentários
Obtém as definições de segurança do documento. Algumas são restrições de acesso ao ficheiro no disco. Outras são definições de Proteção de Documentos. Alguns valores possíveis são 0 = O ficheiro no disco é de leitura/escrita; 1 = Proteger Documento: o ficheiro é encriptado e requer uma palavra-passe para abrir; 2 = Proteger Documento: Abrir Sempre como Só de Leitura; 3 = Proteger Documento: n.º 1 e 2; 4 = O ficheiro no disco é só de leitura; 5 = N.º 1 e 4; 6 = N.º 2 e 4; 7 = Todos os n.º 1, 2 e 4; 8 = Proteger Documento: Restringir a Edição ao só de leitura; 9 = N.º 1 e 8; 10 = N.º 2 e 8; 11 = Todos os n.º 1, 2 e 8; 12 = N.º 4 e 8; 13 = Todos os n.º 1, 4 e 8; 14 = Todos os n.º 2, 4 e 8; 15 = Todos os n.º 1, 2, 4 e 8.
readonly security: number;
Valor da propriedade
number
Comentários
Especifica o assunto do documento.
subject: string;
Valor da propriedade
string
Comentários
Obtém o modelo do documento.
readonly template: string;
Valor da propriedade
string
Comentários
Especifica o título do documento.
title: string;
Valor da propriedade
string
Comentários
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
Fornece opções para as propriedades do objeto a carregar.
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.DocumentProperties;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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.DocumentProperties;
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
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.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.DocumentPropertiesUpdateData
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
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.DocumentProperties): void;
Parâmetros
- properties
- Word.DocumentProperties
Retornos
void
Substitui o método JavaScript toJSON()
para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que lhe é transmitido.) Enquanto o objeto original Word.DocumentProperties
é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Word.Interfaces.DocumentPropertiesData
) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.DocumentPropertiesData;
Retornos
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.DocumentProperties;
Retornos
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.DocumentProperties;
Retornos
Comentários do Office Add-ins
O Office Add-ins é um projeto código aberto. Selecione um link para fornecer comentários: