ExcelScript.DocumentProperties interface

Paket:

ExcelScript

Stellt Arbeitsmappeneigenschaften dar.

Hinweise

Beispiele

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

Methoden

addCustomProperty(key, value)	Erstellt eine neue benutzerdefinierte Eigenschaft oder legt eine vorhandene fest.
deleteAllCustomProperties()	Löscht alle benutzerdefinierten Eigenschaften in dieser Sammlung.
getAuthor()	Der Autor der Arbeitsmappe.
getCategory()	Die Kategorie der Arbeitsmappe.
getComments()	Die Kommentare der Arbeitsmappe.
getCompany()	Das Unternehmen der Arbeitsmappe.
getCreationDate()	Ruft das Erstellungsdatum der Arbeitsmappe ab.
getCustom()	Ruft die Sammlung der benutzerdefinierten Eigenschaften der Arbeitsmappe ab.
getCustomProperty(key)	Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist, gibt diese Methode zurück undefined.
getKeywords()	Die Schlüsselwörter der Arbeitsmappe.
getLastAuthor()	Ruft den letzten Autor der Arbeitsmappe ab.
getManager()	Der Manager der Arbeitsmappe.
getRevisionNumber()	Ruft die Revisionsnummer der Arbeitsmappe ab.
getSubject()	Der Betreff der Arbeitsmappe.
getTitle()	Der Titel der Arbeitsmappe.
setAuthor(author)	Der Autor der Arbeitsmappe.
setCategory(category)	Die Kategorie der Arbeitsmappe.
setComments(comments)	Die Kommentare der Arbeitsmappe.
setCompany(company)	Das Unternehmen der Arbeitsmappe.
setKeywords(keywords)	Die Schlüsselwörter der Arbeitsmappe.
setManager(manager)	Der Manager der Arbeitsmappe.
setRevisionNumber(revisionNumber)	Ruft die Revisionsnummer der Arbeitsmappe ab.
setSubject(subject)	Der Betreff der Arbeitsmappe.
setTitle(title)	Der Titel der Arbeitsmappe.

Details zur Methode

addCustomProperty(key, value)

Erstellt eine neue benutzerdefinierte Eigenschaft oder legt eine vorhandene fest.

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

Parameter

key

string

Erforderlich. Der Schlüssel der benutzerdefinierten Eigenschaft, bei dem die Groß-/Kleinschreibung nicht beachtet wird. Der Schlüssel ist auf 255 Zeichen außerhalb von Excel im Web beschränkt (größere Tasten werden auf anderen Plattformen automatisch auf 255 Zeichen gekürzt).

value

any

Erforderlich. Der Wert der benutzerdefinierten Eigenschaft. Der Wert ist auf 255 Zeichen außerhalb von Excel im Web beschränkt (größere Werte werden auf anderen Plattformen automatisch auf 255 Zeichen gekürzt).

Gibt zurück

ExcelScript.CustomProperty

Beispiele

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

Löscht alle benutzerdefinierten Eigenschaften in dieser Sammlung.

deleteAllCustomProperties(): void;

Gibt zurück

void

getAuthor()

Der Autor der Arbeitsmappe.

getAuthor(): string;

Gibt zurück

string

getCategory()

Die Kategorie der Arbeitsmappe.

getCategory(): string;

Gibt zurück

string

getComments()

Die Kommentare der Arbeitsmappe.

getComments(): string;

Gibt zurück

string

getCompany()

Das Unternehmen der Arbeitsmappe.

getCompany(): string;

Gibt zurück

string

getCreationDate()

Ruft das Erstellungsdatum der Arbeitsmappe ab.

getCreationDate(): Date;

Gibt zurück

Date

getCustom()

Ruft die Sammlung der benutzerdefinierten Eigenschaften der Arbeitsmappe ab.

getCustom(): CustomProperty[];

Gibt zurück

ExcelScript.CustomProperty[]

getCustomProperty(key)

Ruft ein Objekt für benutzerdefinierte Eigenschaften über seinen Schlüssel ab, bei dem Groß-/Kleinschreibung nicht beachtet wird. Wenn die benutzerdefinierte Eigenschaft nicht vorhanden ist, gibt diese Methode zurück undefined.

getCustomProperty(key: string): CustomProperty | undefined;

Parameter

key

string

Erforderlich. Der Schlüssel, der das benutzerdefinierte Eigenschaftenobjekt identifiziert.

Gibt zurück

ExcelScript.CustomProperty | undefined

Beispiele

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

Die Schlüsselwörter der Arbeitsmappe.

getKeywords(): string;

Gibt zurück

string

getLastAuthor()

Ruft den letzten Autor der Arbeitsmappe ab.

getLastAuthor(): string;

Gibt zurück

string

getManager()

Der Manager der Arbeitsmappe.

getManager(): string;

Gibt zurück

string

getRevisionNumber()

Ruft die Revisionsnummer der Arbeitsmappe ab.

getRevisionNumber(): number;

Gibt zurück

number

getSubject()

Der Betreff der Arbeitsmappe.

getSubject(): string;

Gibt zurück

string

getTitle()

Der Titel der Arbeitsmappe.

getTitle(): string;

Gibt zurück

string

setAuthor(author)

Der Autor der Arbeitsmappe.

setAuthor(author: string): void;

Parameter

author

string

Gibt zurück

void

setCategory(category)

Die Kategorie der Arbeitsmappe.

setCategory(category: string): void;

Parameter

category

string

Gibt zurück

void

setComments(comments)

Die Kommentare der Arbeitsmappe.

setComments(comments: string): void;

Parameter

comments

string

Gibt zurück

void

setCompany(company)

Das Unternehmen der Arbeitsmappe.

setCompany(company: string): void;

Parameter

company

string

Gibt zurück

void

setKeywords(keywords)

Die Schlüsselwörter der Arbeitsmappe.

setKeywords(keywords: string): void;

Parameter

keywords

string

Gibt zurück

void

setManager(manager)

Der Manager der Arbeitsmappe.

setManager(manager: string): void;

Parameter

manager

string

Gibt zurück

void

setRevisionNumber(revisionNumber)

Ruft die Revisionsnummer der Arbeitsmappe ab.

setRevisionNumber(revisionNumber: number): void;

Parameter

revisionNumber

number

Gibt zurück

void

setSubject(subject)

Der Betreff der Arbeitsmappe.

setSubject(subject: string): void;

Parameter

subject

string

Gibt zurück

void

setTitle(title)

Der Titel der Arbeitsmappe.

setTitle(title: string): void;

Parameter

title

string

Gibt zurück

void