Excel.DocumentProperties class
Representa as propriedades do livro.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Propriedades
| author | O autor do livro. |
| category | A categoria do livro. |
| comments | O campo Comentários nos metadados do livro. Estes não têm qualquer ligação aos comentários dos utilizadores efetuados no livro. |
| company | A empresa do livro. |
| 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 da pasta de trabalho. |
| custom | Obtém a coleção de propriedades personalizadas da pasta de trabalho. |
| keywords | As palavras-chave do livro. |
| last |
Obtém o último autor da pasta de trabalho. |
| manager | O gestor do livro. |
| revision |
Obtém o número de revisão da pasta de trabalho. |
| subject | O assunto do livro. |
| title | O título do livro. |
Métodos
| 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 |
Detalhes da propriedade
author
O autor do livro.
author: string;Valor da propriedade
string
Comentários
category
A categoria do livro.
category: string;Valor da propriedade
string
Comentários
comments
O campo Comentários nos metadados do livro. Estes não têm qualquer ligação aos comentários dos utilizadores efetuados no livro.
comments: string;Valor da propriedade
string
Comentários
company
A empresa do livro.
company: string;Valor da propriedade
string
Comentários
context
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
creationDate
Obtém a data de criação da pasta de trabalho.
readonly creationDate: Date;Valor da propriedade
Date
Comentários
custom
Obtém a coleção de propriedades personalizadas da pasta de trabalho.
readonly custom: Excel.CustomPropertyCollection;Valor da propriedade
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Load the keys and values of all custom properties.
const customDocProperties = context.workbook.properties.custom;
customDocProperties.load(["key", "value"]);
await context.sync();
// Log each custom property to the console.
// Note that your document may have more properties than those you have set using this snippet.
customDocProperties.items.forEach((property) => {
console.log(`${property.key}:${property.value}`);
});
});
keywords
As palavras-chave do livro.
keywords: string;Valor da propriedade
string
Comentários
lastAuthor
Obtém o último autor da pasta de trabalho.
readonly lastAuthor: string;Valor da propriedade
string
Comentários
manager
O gestor do livro.
manager: string;Valor da propriedade
string
Comentários
revisionNumber
Obtém o número de revisão da pasta de trabalho.
revisionNumber: number;Valor da propriedade
number
Comentários
subject
O assunto do livro.
subject: string;Valor da propriedade
string
Comentários
title
O título do livro.
title: string;Valor da propriedade
string
Comentários
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?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties;Parâmetros
Fornece opções para as propriedades do objeto a 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[]): Excel.DocumentProperties;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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;
}): Excel.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
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: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
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
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Excel.DocumentProperties): void;Parâmetros
- properties
- Excel.DocumentProperties
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.DocumentProperties é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DocumentPropertiesData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.DocumentPropertiesData;