Excel.NoteCollection class
Représente une collection d’objets de note faisant partie du classeur.
- Extends
Remarques
Utilisateur
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function adds a note to the selected cell.
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
// Note that an InvalidArgument error is thrown if multiple cells are selected.
context.workbook.notes.add(selectedRange, "The first note.");
await context.sync();
});
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(cell |
Ajoute une nouvelle note avec le contenu donné sur la cellule donnée. |
| get |
Obtient le nombre de notes dans la collection. |
| get |
Obtient une note par son adresse de cellule. |
| get |
Obtient une note de la collection en fonction de sa position. |
| get |
Obtient une note par son adresse de cellule. Si l’objet note n’existe pas, cette méthode renvoie un objet dont la |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.Note[];Valeur de propriété
Détails de la méthode
add(cellAddress, content)
Ajoute une nouvelle note avec le contenu donné sur la cellule donnée.
add(cellAddress: Range | string, content: any): Excel.Note;Paramètres
- cellAddress
-
Excel.Range | string
Cellule à laquelle la note est ajoutée. Il peut s’agir d’un objet ou d’une Range chaîne telle que « A1 ». Si la chaîne n’est pas valide ou si la plage n’est pas une cellule unique, une InvalidCellAddress erreur est générée.
- content
-
any
Texte de la note.
Retours
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function adds a note to the selected cell.
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
// Note that an InvalidArgument error is thrown if multiple cells are selected.
context.workbook.notes.add(selectedRange, "The first note.");
await context.sync();
});
getCount()
Obtient le nombre de notes dans la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(key)
Obtient une note par son adresse de cellule.
getItem(key: string): Excel.Note;Paramètres
- key
-
string
Adresse de cellule de la note.
Retours
Note avec l’adresse de cellule donnée. S’il n’y a pas de note avec l’adresse de cellule donnée, alors l’erreur ItemNotFound est générée.
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function sets the note on cell A1 to visible.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const firstNote = sheet.notes.getItem("A1");
firstNote.load();
await context.sync();
firstNote.visible = true;
});
getItemAt(index)
Obtient une note de la collection en fonction de sa position.
getItemAt(index: number): Excel.Note;Paramètres
- index
-
number
Valeur d’index de la note à récupérer. Avec indice zéro.
Retours
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the content in the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.content = "Changing the content of the first note.";
await context.sync();
});
getItemOrNullObject(key)
Obtient une note par son adresse de cellule. Si l’objet note n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemOrNullObject(key: string): Excel.Note;Paramètres
- key
-
string
Adresse de cellule de la note.
Retours
Note avec l’adresse de cellule ou l’objet null donné.
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.NoteCollection;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NoteCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.NoteCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.NoteCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.NoteCollectionData;