ExcelScript.DocumentProperties interface

Paquete:

ExcelScript

Representa las propiedades del libro.

Comentarios

Ejemplos

/**
 * 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)	Crea una nueva propiedad personalizada o establece una existente.
deleteAllCustomProperties()	Elimina todas las propiedades personalizadas de la colección.
getAuthor()	Autor del libro.
getCategory()	Categoría del libro.
getComments()	Campo de comentario en los metadatos del libro. No tienen ninguna conexión con los comentarios de los usuarios realizados en el libro.
getCompany()	La empresa del libro.
getCreationDate()	Obtiene la fecha de creación del libro.
getCustom()	Obtiene la colección de propiedades personalizadas del libro.
getCustomProperty(key)	Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Si la propiedad personalizada no existe, este método devuelve undefined.
getKeywords()	Palabras clave del libro.
getLastAuthor()	Obtiene el último autor del libro.
getManager()	Administrador del libro.
getRevisionNumber()	Obtiene el número de revisión del libro.
getSubject()	Asunto del libro.
getTitle()	Título del libro.
setAuthor(author)	Autor del libro.
setCategory(category)	Categoría del libro.
setComments(comments)	Campo de comentario en los metadatos del libro. No tienen ninguna conexión con los comentarios de los usuarios realizados en el libro.
setCompany(company)	La empresa del libro.
setKeywords(keywords)	Palabras clave del libro.
setManager(manager)	Administrador del libro.
setRevisionNumber(revisionNumber)	Obtiene el número de revisión del libro.
setSubject(subject)	Asunto del libro.
setTitle(title)	Título del libro.

Detalles del método

addCustomProperty(key, value)

Crea una nueva propiedad personalizada o establece una existente.

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

Parámetros

key

string

Obligatorio. Clave de la propiedad personalizada, que no distingue mayúsculas de minúsculas. La clave está limitada a 255 caracteres fuera de Excel en la Web (las teclas más grandes se recortan automáticamente a 255 caracteres en otras plataformas).

value

any

Obligatorio. Valor de la propiedad personalizada. El valor está limitado a 255 caracteres fuera de Excel en la Web (los valores más grandes se recortan automáticamente a 255 caracteres en otras plataformas).

Devoluciones

ExcelScript.CustomProperty

Ejemplos

/**
 * 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()

Elimina todas las propiedades personalizadas de la colección.

deleteAllCustomProperties(): void;

Devoluciones

void

getAuthor()

Autor del libro.

getAuthor(): string;

Devoluciones

string

getCategory()

Categoría del libro.

getCategory(): string;

Devoluciones

string

getComments()

Campo de comentario en los metadatos del libro. No tienen ninguna conexión con los comentarios de los usuarios realizados en el libro.

getComments(): string;

Devoluciones

string

getCompany()

La empresa del libro.

getCompany(): string;

Devoluciones

string

getCreationDate()

Obtiene la fecha de creación del libro.

getCreationDate(): Date;

Devoluciones

Date

getCustom()

Obtiene la colección de propiedades personalizadas del libro.

getCustom(): CustomProperty[];

Devoluciones

ExcelScript.CustomProperty[]

getCustomProperty(key)

Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Si la propiedad personalizada no existe, este método devuelve undefined.

getCustomProperty(key: string): CustomProperty | undefined;

Parámetros

key

string

Obligatorio. Clave que identifica el objeto de propiedad personalizada.

Devoluciones

ExcelScript.CustomProperty | undefined

Ejemplos

/**
 * 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()

Palabras clave del libro.

getKeywords(): string;

Devoluciones

string

getLastAuthor()

Obtiene el último autor del libro.

getLastAuthor(): string;

Devoluciones

string

getManager()

Administrador del libro.

getManager(): string;

Devoluciones

string

getRevisionNumber()

Obtiene el número de revisión del libro.

getRevisionNumber(): number;

Devoluciones

number

getSubject()

Asunto del libro.

getSubject(): string;

Devoluciones

string

getTitle()

Título del libro.

getTitle(): string;

Devoluciones

string

setAuthor(author)

Autor del libro.

setAuthor(author: string): void;

Parámetros

author

string

Devoluciones

void

setCategory(category)

Categoría del libro.

setCategory(category: string): void;

Parámetros

category

string

Devoluciones

void

setComments(comments)

Campo de comentario en los metadatos del libro. No tienen ninguna conexión con los comentarios de los usuarios realizados en el libro.

setComments(comments: string): void;

Parámetros

comments

string

Devoluciones

void

setCompany(company)

La empresa del libro.

setCompany(company: string): void;

Parámetros

company

string

Devoluciones

void

setKeywords(keywords)

Palabras clave del libro.

setKeywords(keywords: string): void;

Parámetros

keywords

string

Devoluciones

void

setManager(manager)

Administrador del libro.

setManager(manager: string): void;

Parámetros

manager

string

Devoluciones

void

setRevisionNumber(revisionNumber)

Obtiene el número de revisión del libro.

setRevisionNumber(revisionNumber: number): void;

Parámetros

revisionNumber

number

Devoluciones

void

setSubject(subject)

Asunto del libro.

setSubject(subject: string): void;

Parámetros

subject

string

Devoluciones

void

setTitle(title)

Título del libro.

setTitle(title: string): void;

Parámetros

title

string

Devoluciones

void