ExcelScript.DocumentProperties interface
Représente les propriétés du classeur.
Remarques
Exemples
/**
* 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éthodes
add |
Crée une nouvelle propriété personnalisée ou en définit une existante. |
delete |
Supprime toutes les propriétés personnalisées de cette collection. |
get |
Auteur du classeur. |
get |
Catégorie du classeur. |
get |
Commentaires du classeur. |
get |
Société du classeur. |
get |
Obtient la date de création du classeur. |
get |
Obtient la collection de propriétés personnalisées du classeur. |
get |
Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Si la propriété personnalisée n’existe pas, cette méthode retourne |
get |
Mots clés du classeur. |
get |
Obtient ou définit le dernier auteur du classeur. |
get |
Gestionnaire du classeur. |
get |
Obtient le numéro de révision du classeur. |
get |
Objet du classeur. |
get |
Titre du classeur. |
set |
Auteur du classeur. |
set |
Catégorie du classeur. |
set |
Commentaires du classeur. |
set |
Société du classeur. |
set |
Mots clés du classeur. |
set |
Gestionnaire du classeur. |
set |
Obtient le numéro de révision du classeur. |
set |
Objet du classeur. |
set |
Titre du classeur. |
Détails de la méthode
addCustomProperty(key, value)
Crée une nouvelle propriété personnalisée ou en définit une existante.
addCustomProperty(key: string, value: any): CustomProperty;
Paramètres
- key
-
string
Obligatoire. Clé de la propriété personnalisée, qui ne respecte pas la casse. La clé est limitée à 255 caractères en dehors de Excel sur le Web (les touches plus grandes sont automatiquement réduites à 255 caractères sur d’autres plateformes).
- value
-
any
Obligatoire. Valeur de la propriété personnalisée. La valeur est limitée à 255 caractères en dehors de Excel sur le Web (les valeurs plus grandes sont automatiquement réduites à 255 caractères sur d’autres plateformes).
Retours
Exemples
/**
* 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()
Supprime toutes les propriétés personnalisées de cette collection.
deleteAllCustomProperties(): void;
Retours
void
getAuthor()
Auteur du classeur.
getAuthor(): string;
Retours
string
getCategory()
Catégorie du classeur.
getCategory(): string;
Retours
string
getComments()
Commentaires du classeur.
getComments(): string;
Retours
string
getCompany()
Société du classeur.
getCompany(): string;
Retours
string
getCreationDate()
Obtient la date de création du classeur.
getCreationDate(): Date;
Retours
Date
getCustom()
Obtient la collection de propriétés personnalisées du classeur.
getCustom(): CustomProperty[];
Retours
getCustomProperty(key)
Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Si la propriété personnalisée n’existe pas, cette méthode retourne undefined
.
getCustomProperty(key: string): CustomProperty | undefined;
Paramètres
- key
-
string
Obligatoire. Clé qui identifie l’objet de propriété personnalisé.
Retours
ExcelScript.CustomProperty | undefined
Exemples
/**
* 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()
Mots clés du classeur.
getKeywords(): string;
Retours
string
getLastAuthor()
Obtient ou définit le dernier auteur du classeur.
getLastAuthor(): string;
Retours
string
getManager()
Gestionnaire du classeur.
getManager(): string;
Retours
string
getRevisionNumber()
Obtient le numéro de révision du classeur.
getRevisionNumber(): number;
Retours
number
getSubject()
Objet du classeur.
getSubject(): string;
Retours
string
getTitle()
Titre du classeur.
getTitle(): string;
Retours
string
setAuthor(author)
Auteur du classeur.
setAuthor(author: string): void;
Paramètres
- author
-
string
Retours
void
setCategory(category)
Catégorie du classeur.
setCategory(category: string): void;
Paramètres
- category
-
string
Retours
void
setComments(comments)
Commentaires du classeur.
setComments(comments: string): void;
Paramètres
- comments
-
string
Retours
void
setCompany(company)
Société du classeur.
setCompany(company: string): void;
Paramètres
- company
-
string
Retours
void
setKeywords(keywords)
Mots clés du classeur.
setKeywords(keywords: string): void;
Paramètres
- keywords
-
string
Retours
void
setManager(manager)
Gestionnaire du classeur.
setManager(manager: string): void;
Paramètres
- manager
-
string
Retours
void
setRevisionNumber(revisionNumber)
Obtient le numéro de révision du classeur.
setRevisionNumber(revisionNumber: number): void;
Paramètres
- revisionNumber
-
number
Retours
void
setSubject(subject)
Objet du classeur.
setSubject(subject: string): void;
Paramètres
- subject
-
string
Retours
void
setTitle(title)
Titre du classeur.
setTitle(title: string): void;
Paramètres
- title
-
string
Retours
void