ExcelScript.DocumentProperties interface

Пакет:

ExcelScript

Представляет свойства книги.

Комментарии

Примеры

/**
 * 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);
}

Методы

addCustomProperty(key, value)	Создает или задает настраиваемое свойство.
deleteAllCustomProperties()	Удаляет все настраиваемые свойства в коллекции.
getAuthor()	Автор книги.
getCategory()	Категория книги.
getComments()	Комментарии книги.
getCompany()	Компания книги.
getCreationDate()	Получает дату создания книги.
getCustom()	Получает коллекцию настраиваемых свойств книги.
getCustomProperty(key)	Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательское свойство не существует, этот метод возвращает undefined.
getKeywords()	Ключевые слова книги.
getLastAuthor()	Получает последнего автора книги.
getManager()	Диспетчер книги.
getRevisionNumber()	Получает номер редакции книги.
getSubject()	Тема книги.
getTitle()	Название книги.
setAuthor(author)	Автор книги.
setCategory(category)	Категория книги.
setComments(comments)	Комментарии книги.
setCompany(company)	Компания книги.
setKeywords(keywords)	Ключевые слова книги.
setManager(manager)	Диспетчер книги.
setRevisionNumber(revisionNumber)	Получает номер редакции книги.
setSubject(subject)	Тема книги.
setTitle(title)	Название книги.

Сведения о методе

addCustomProperty(key, value)

Создает или задает настраиваемое свойство.

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

Параметры

key

string

Обязательно. Ключ настраиваемого свойства, который не учитывает регистр. Клавиша ограничена 255 символами за пределами Excel в Интернете (более крупные клавиши автоматически обрезаются до 255 символов на других платформах).

value

any

Обязательно. Значение настраиваемого свойства. Значение ограничено 255 символами за пределами Excel в Интернете (на других платформах значения большего размера автоматически обрезаются до 255 символов).

Возвращаемое значение

ExcelScript.CustomProperty

Примеры

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

Удаляет все настраиваемые свойства в коллекции.

deleteAllCustomProperties(): void;

Возвращаемое значение

void

getAuthor()

Автор книги.

getAuthor(): string;

Возвращаемое значение

string

getCategory()

Категория книги.

getCategory(): string;

Возвращаемое значение

string

getComments()

Комментарии книги.

getComments(): string;

Возвращаемое значение

string

getCompany()

Компания книги.

getCompany(): string;

Возвращаемое значение

string

getCreationDate()

Получает дату создания книги.

getCreationDate(): Date;

Возвращаемое значение

Date

getCustom()

Получает коллекцию настраиваемых свойств книги.

getCustom(): CustomProperty[];

Возвращаемое значение

ExcelScript.CustomProperty[]

getCustomProperty(key)

Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательское свойство не существует, этот метод возвращает undefined.

getCustomProperty(key: string): CustomProperty | undefined;

Параметры

key

string

Обязательно. Ключ, идентифицирующий объект пользовательского свойства.

Возвращаемое значение

ExcelScript.CustomProperty | undefined

Примеры

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

Ключевые слова книги.

getKeywords(): string;

Возвращаемое значение

string

getLastAuthor()

Получает последнего автора книги.

getLastAuthor(): string;

Возвращаемое значение

string

getManager()

Диспетчер книги.

getManager(): string;

Возвращаемое значение

string

getRevisionNumber()

Получает номер редакции книги.

getRevisionNumber(): number;

Возвращаемое значение

number

getSubject()

Тема книги.

getSubject(): string;

Возвращаемое значение

string

getTitle()

Название книги.

getTitle(): string;

Возвращаемое значение

string

setAuthor(author)

Автор книги.

setAuthor(author: string): void;

Параметры

author

string

Возвращаемое значение

void

setCategory(category)

Категория книги.

setCategory(category: string): void;

Параметры

category

string

Возвращаемое значение

void

setComments(comments)

Комментарии книги.

setComments(comments: string): void;

Параметры

comments

string

Возвращаемое значение

void

setCompany(company)

Компания книги.

setCompany(company: string): void;

Параметры

company

string

Возвращаемое значение

void

setKeywords(keywords)

Ключевые слова книги.

setKeywords(keywords: string): void;

Параметры

keywords

string

Возвращаемое значение

void

setManager(manager)

Диспетчер книги.

setManager(manager: string): void;

Параметры

manager

string

Возвращаемое значение

void

setRevisionNumber(revisionNumber)

Получает номер редакции книги.

setRevisionNumber(revisionNumber: number): void;

Параметры

revisionNumber

number

Возвращаемое значение

void

setSubject(subject)

Тема книги.

setSubject(subject: string): void;

Параметры

subject

string

Возвращаемое значение

void

setTitle(title)

Название книги.

setTitle(title: string): void;

Параметры

title

string

Возвращаемое значение

void