Excel.NoteCollection class
Représente une collection d’objets de note qui font partie du classeur.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.18 ]
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus 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 en fonction de son adresse de cellule. |
| get |
Obtient une note de la collection en fonction de sa position. |
| get |
Obtient une note en fonction de son adresse de cellule. Si l’objet note n’existe pas, cette méthode retourne un objet avec sa |
| 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 . Cela connecte le processus du complément au processus 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 Range objet ou d’une chaîne telle que « A1 ». Si la chaîne n’est pas valide ou si la plage n’est pas une seule cellule, une InvalidCellAddress erreur est générée.
- content
-
any
Texte de la note.
Retours
Remarques
getCount()
Obtient le nombre de notes dans la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(key)
Obtient une note en fonction de 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 aucune note avec l’adresse de cellule donnée, l’erreur ItemNotFound est levée.
Remarques
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
getItemOrNullObject(key)
Obtient une note en fonction de son adresse de cellule. Si l’objet note n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés 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 qui spécifient 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 brut (typé en tant Excel.Interfaces.NoteCollectionDataque ) qui 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;