Excel.NoteCollection class
Stellt eine Auflistung von Notizobjekten dar, die Teil der Arbeitsmappe sind.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(cell |
Fügt eine neue Notiz mit dem angegebenen Inhalt der angegebenen Zelle hinzu. |
| get |
Ruft die Anzahl der Notizen in der Auflistung ab. |
| get |
Ruft eine Notiz anhand ihrer Zelladresse ab. |
| get |
Ruft eine Notiz aus der Auflistung basierend auf ihrer Position ab. |
| get |
Ruft eine Notiz anhand ihrer Zelladresse ab. Wenn das Notizobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.Note[];Eigenschaftswert
Details zur Methode
add(cellAddress, content)
Fügt eine neue Notiz mit dem angegebenen Inhalt der angegebenen Zelle hinzu.
add(cellAddress: Range | string, content: any): Excel.Note;Parameter
- cellAddress
-
Excel.Range | string
Die Zelle, der die Notiz hinzugefügt wird. Dies kann ein Range Objekt oder eine Zeichenfolge wie "A1" sein. Wenn die Zeichenfolge ungültig ist oder der Bereich keine einzelne Zelle ist, wird ein InvalidCellAddress Fehler ausgelöst.
- content
-
any
Der Text der Notiz.
Gibt zurück
Hinweise
getCount()
Ruft die Anzahl der Notizen in der Auflistung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItem(key)
Ruft eine Notiz anhand ihrer Zelladresse ab.
getItem(key: string): Excel.Note;Parameter
- key
-
string
Die Zelladresse der Notiz.
Gibt zurück
Der Hinweis mit der angegebenen Zelladresse. Wenn keine Notiz mit der angegebenen Zelladresse vorhanden ist, wird der ItemNotFound Fehler ausgelöst.
Hinweise
getItemAt(index)
Ruft eine Notiz aus der Auflistung basierend auf ihrer Position ab.
getItemAt(index: number): Excel.Note;Parameter
- index
-
number
Der Indexwert der abzurufenden Notiz. Nullindiziert.
Gibt zurück
Hinweise
getItemOrNullObject(key)
Ruft eine Notiz anhand ihrer Zelladresse ab. Wenn das Notizobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(key: string): Excel.Note;Parameter
- key
-
string
Die Zelladresse der Notiz.
Gibt zurück
Die Notiz mit der angegebenen Zelladresse oder dem ANGEGEBENEN NULL-Objekt.
Hinweise
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.NoteCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NoteCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.NoteCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NoteCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Excel.Interfaces.NoteCollectionData;Gibt zurück
Office Add-ins