Excel.DocumentProperties class

Pacote:

excel

Representa propriedades da pasta de trabalho.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

author	O autor da pasta de trabalho.
category	A categoria da pasta de trabalho.
comments	Os comentários da pasta de trabalho.
company	A empresa da pasta de trabalho.
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 da pasta de trabalho.
custom	Obtém a coleção de propriedades personalizadas da pasta de trabalho.
keywords	As palavras-chave da pasta de trabalho.
lastAuthor	Obtém o último autor da pasta de trabalho.
manager	O gerente da pasta de trabalho.
revisionNumber	Obtém o número de revisão da pasta de trabalho.
subject	O assunto da pasta de trabalho.
title	O título da pasta de trabalho.

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

Detalhes da propriedade

author

O autor da pasta de trabalho.

author: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

category

A categoria da pasta de trabalho.

category: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

comments

Os comentários da pasta de trabalho.

comments: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

company

A empresa da pasta de trabalho.

company: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Excel.RequestContext

creationDate

Obtém a data de criação da pasta de trabalho.

readonly creationDate: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

custom

Obtém a coleção de propriedades personalizadas da pasta de trabalho.

readonly custom: Excel.CustomPropertyCollection;

Valor da propriedade

Excel.CustomPropertyCollection

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 da pasta de trabalho.

keywords: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

lastAuthor

Obtém o último autor da pasta de trabalho.

readonly lastAuthor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

manager

O gerente da pasta de trabalho.

manager: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

revisionNumber

Obtém o número de revisão da pasta de trabalho.

revisionNumber: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

subject

O assunto da pasta de trabalho.

subject: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

title

O título da pasta de trabalho.

title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

options

Excel.Interfaces.DocumentPropertiesLoadOptions

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

Retornos

Excel.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[]): Excel.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

Excel.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;
        }): Excel.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

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

Excel.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: 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DocumentProperties original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DocumentPropertiesData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.DocumentPropertiesData;

Retornos

Excel.Interfaces.DocumentPropertiesData