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