ExcelScript.DocumentProperties interface

Pacote:

ExcelScript

Representa propriedades da pasta de trabalho.

Comentários

Exemplos

/**
 * This script creates a new worksheet that displays some of the document properties.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the document properties.
    const properties: ExcelScript.DocumentProperties = workbook.getProperties();

    // Create a new worksheet called "Metadata".
    const newWorksheet = workbook.addWorksheet("Metadata");
    
    // Create an array to store the string values of properties to save.
    let values: string[][] = [];
    values.push(["Creation Date", properties.getCreationDate().toString()]);
    values.push(["Author", properties.getAuthor()]);
    values.push(["Last Edited By", properties.getLastAuthor()]);
    
    // Set the property values to a range on the new worksheet.
    newWorksheet.getRange("A1:B3").setValues(values);
}

Métodos

addCustomProperty(key, value)	Cria uma nova propriedade personalizada ou define uma existente.
deleteAllCustomProperties()	Exclui todas as propriedades personalizadas nesta coleção.
getAuthor()	O autor da pasta de trabalho.
getCategory()	A categoria da pasta de trabalho.
getComments()	Os comentários da pasta de trabalho.
getCompany()	A empresa da pasta de trabalho.
getCreationDate()	Obtém a data de criação da pasta de trabalho.
getCustom()	Obtém a coleção de propriedades personalizadas da pasta de trabalho.
getCustomProperty(key)	Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada não existir, esse método retornará undefined.
getKeywords()	As palavras-chave da pasta de trabalho.
getLastAuthor()	Obtém o último autor da pasta de trabalho.
getManager()	O gerente da pasta de trabalho.
getRevisionNumber()	Obtém o número de revisão da pasta de trabalho.
getSubject()	O assunto da pasta de trabalho.
getTitle()	O título da pasta de trabalho.
setAuthor(author)	O autor da pasta de trabalho.
setCategory(category)	A categoria da pasta de trabalho.
setComments(comments)	Os comentários da pasta de trabalho.
setCompany(company)	A empresa da pasta de trabalho.
setKeywords(keywords)	As palavras-chave da pasta de trabalho.
setManager(manager)	O gerente da pasta de trabalho.
setRevisionNumber(revisionNumber)	Obtém o número de revisão da pasta de trabalho.
setSubject(subject)	O assunto da pasta de trabalho.
setTitle(title)	O título da pasta de trabalho.

Detalhes do método

addCustomProperty(key, value)

Cria uma nova propriedade personalizada ou define uma existente.

addCustomProperty(key: string, value: any): CustomProperty;

Parâmetros

key

string

Obrigatório. A chave da propriedade personalizada, que é insensibilidade de maiúsculas de minúsculas. A chave é limitada a 255 caracteres fora de Excel na Web (chaves maiores são cortadas automaticamente para 255 caracteres em outras plataformas).

value

any

Obrigatório. O valor da propriedade personalizada. O valor é limitado a 255 caracteres fora do Excel na Web (valores maiores são cortados automaticamente para 255 caracteres em outras plataformas).

Retornos

ExcelScript.CustomProperty

Exemplos

/**
 * This script adds a workbook-level custom property.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the property collection.
  const properties = workbook.getProperties();

  // Add a new property called "Project" with the value "FA".
  properties.addCustomProperty("Project", "FA");
}

deleteAllCustomProperties()

Exclui todas as propriedades personalizadas nesta coleção.

deleteAllCustomProperties(): void;

Retornos

void

getAuthor()

O autor da pasta de trabalho.

getAuthor(): string;

Retornos

string

getCategory()

A categoria da pasta de trabalho.

getCategory(): string;

Retornos

string

getComments()

Os comentários da pasta de trabalho.

getComments(): string;

Retornos

string

getCompany()

A empresa da pasta de trabalho.

getCompany(): string;

Retornos

string

getCreationDate()

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

getCreationDate(): Date;

Retornos

Date

getCustom()

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

getCustom(): CustomProperty[];

Retornos

ExcelScript.CustomProperty[]

getCustomProperty(key)

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada não existir, esse método retornará undefined.

getCustomProperty(key: string): CustomProperty | undefined;

Parâmetros

key

string

Obrigatório. A chave que identifica o objeto de propriedade personalizado.

Retornos

ExcelScript.CustomProperty | undefined

Exemplos

/**
 * This script gets a workbook-level custom property called "Project".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the property collection.
  const properties = workbook.getProperties();

  // Get the "Project" property.
  const project = properties.getCustomProperty("Project");

  // Show the property value in the console.
  console.log(project.getValue());
}

getKeywords()

As palavras-chave da pasta de trabalho.

getKeywords(): string;

Retornos

string

getLastAuthor()

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

getLastAuthor(): string;

Retornos

string

getManager()

O gerente da pasta de trabalho.

getManager(): string;

Retornos

string

getRevisionNumber()

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

getRevisionNumber(): number;

Retornos

number

getSubject()

O assunto da pasta de trabalho.

getSubject(): string;

Retornos

string

getTitle()

O título da pasta de trabalho.

getTitle(): string;

Retornos

string

setAuthor(author)

O autor da pasta de trabalho.

setAuthor(author: string): void;

Parâmetros

author

string

Retornos

void

setCategory(category)

A categoria da pasta de trabalho.

setCategory(category: string): void;

Parâmetros

category

string

Retornos

void

setComments(comments)

Os comentários da pasta de trabalho.

setComments(comments: string): void;

Parâmetros

comments

string

Retornos

void

setCompany(company)

A empresa da pasta de trabalho.

setCompany(company: string): void;

Parâmetros

company

string

Retornos

void

setKeywords(keywords)

As palavras-chave da pasta de trabalho.

setKeywords(keywords: string): void;

Parâmetros

keywords

string

Retornos

void

setManager(manager)

O gerente da pasta de trabalho.

setManager(manager: string): void;

Parâmetros

manager

string

Retornos

void

setRevisionNumber(revisionNumber)

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

setRevisionNumber(revisionNumber: number): void;

Parâmetros

revisionNumber

number

Retornos

void

setSubject(subject)

O assunto da pasta de trabalho.

setSubject(subject: string): void;

Parâmetros

subject

string

Retornos

void

setTitle(title)

O título da pasta de trabalho.

setTitle(title: string): void;

Parâmetros

title

string

Retornos

void