Excel.NamedItem class
Stellt einen definierten Namen für einen Zellbereich oder einen Wert dar. Namen können einfache benannte Objekte (wie im folgenden Typ zu sehen), Bereichsobjekte oder ein Verweis auf einen Bereich sein. Dieses Objekt kann zum Abrufen des mit Namen verknüpften Bereichsobjekts verwendet werden.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
// Log all the named items in the active worksheet.
const namedItems = context.workbook.worksheets.getActiveWorksheet().names.load();
await context.sync();
console.log("This worksheet contains " + namedItems.items.length + " named items.");
for (let i = 0; i < namedItems.items.length; i++) {
const namedItem : Excel.NamedItem = namedItems.items[i];
console.log(JSON.stringify(namedItem)) + "\n";
}
await context.sync();
});
Eigenschaften
| array |
Gibt ein Objekt mit Werten und Typen des benannten Elements zurück. |
| comment | Gibt den mit diesem Namen verbundenen Kommentar an. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| formula | Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("="). |
| name | Der Name des Objekts. |
| scope | Gibt an, ob der Name auf die Arbeitsmappe oder ein bestimmtes Arbeitsblatt beschränkt ist. Mögliche Werte sind: Arbeitsblatt, Arbeitsmappe. |
| type | Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen findest du hier |
| value | Stellt den Wert dar, der von der Formel des Namens berechnet wurde. Für einen benannten Bereich wird die Bereichsadresse zurückgegeben. Diese API gibt die #VALUE zurück! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist. |
| value |
Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz |
| value |
Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz |
| visible | Gibt an, ob das Objekt sichtbar ist. |
| worksheet | Gibt das Arbeitsblatt zurück, auf dessen Bereich das benannte Element beschränkt ist. Gibt einen Fehler aus, wenn das Element stattdessen auf die Arbeitsmappe beschränkt ist. |
| worksheet |
Gibt das Arbeitsblatt zurück, auf das das benannte Element eingegrenzt ist. Wenn das Element stattdessen auf die Arbeitsmappe beschränkt ist, gibt diese Methode ein Objekt zurück, dessen |
Methoden
| delete() | Löscht den angegebenen Namen. |
| get |
Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Gibt einen Fehler zurück, wenn der Typ des benannten Elements kein Bereich ist. |
| get |
Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Wenn der Typ des benannten Elements kein Bereich ist, dann 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 " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
arrayValues
Gibt ein Objekt mit Werten und Typen des benannten Elements zurück.
readonly arrayValues: Excel.NamedItemArrayValues;Eigenschaftswert
Hinweise
comment
Gibt den mit diesem Namen verbundenen Kommentar an.
comment: string;Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
formula
Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("=").
formula: any;Eigenschaftswert
any
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/update-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// Get the named item
const myNamedItem = sheet.names.getItemOrNullObject("MyRange");
myNamedItem.load("name, formula");
await context.sync();
if (myNamedItem.isNullObject) {
console.log(`There is no named item. Create it with "Add named item for a range" first.`);
} else {
// Update named item to point to the second range
myNamedItem.formula = "=Sample!$B$10:$D$14";
sheet.getRange("B10:D14").select();
await context.sync();
console.log(`Just updated the named item "${myNamedItem.name}" -- it's now located here: ${myNamedItem.formula}`);
}
});
name
Der Name des Objekts.
readonly name: string;Eigenschaftswert
string
Hinweise
scope
Gibt an, ob der Name auf die Arbeitsmappe oder ein bestimmtes Arbeitsblatt beschränkt ist. Mögliche Werte sind: Arbeitsblatt, Arbeitsmappe.
readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook";Eigenschaftswert
Excel.NamedItemScope | "Worksheet" | "Workbook"
Hinweise
type
Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen findest du hier Excel.NamedItemType .
readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";Eigenschaftswert
Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"
Hinweise
API-Satz: ExcelApi 1.1 für Zeichenfolge,Ganzzahl,Double,Boolescher,Bereich,Fehler; 1.7 für Array
value
Stellt den Wert dar, der von der Formel des Namens berechnet wurde. Für einen benannten Bereich wird die Bereichsadresse zurückgegeben. Diese API gibt die #VALUE zurück! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist.
readonly value: any;Eigenschaftswert
any
Hinweise
valueAsJson
Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz NamedItem.valuezu unterstützt unterstützt dies alle Datentypen, NamedItem.valueAsJson die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie NamedItem.valueAsJsonLocal.
readonly valueAsJson: CellValue | string;Eigenschaftswert
Excel.CellValue | string
Hinweise
valueAsJsonLocal
Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz NamedItem.valuezu unterstützt unterstützt dies alle Datentypen, NamedItem.valueAsJsonLocal die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie NamedItem.valueAsJson.
readonly valueAsJsonLocal: CellValue | string;Eigenschaftswert
Excel.CellValue | string
Hinweise
visible
Gibt an, ob das Objekt sichtbar ist.
visible: boolean;Eigenschaftswert
boolean
Hinweise
worksheet
Gibt das Arbeitsblatt zurück, auf dessen Bereich das benannte Element beschränkt ist. Gibt einen Fehler aus, wenn das Element stattdessen auf die Arbeitsmappe beschränkt ist.
readonly worksheet: Excel.Worksheet;Eigenschaftswert
Hinweise
worksheetOrNullObject
Gibt das Arbeitsblatt zurück, auf das das benannte Element eingegrenzt ist. Wenn das Element stattdessen auf die Arbeitsmappe beschränkt ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
readonly worksheetOrNullObject: Excel.Worksheet;Eigenschaftswert
Hinweise
Details zur Methode
delete()
Löscht den angegebenen Namen.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const totalName = sheet.names.getItemOrNullObject("TotalAmount");
totalName.load();
await context.sync();
if (totalName.value) {
totalName.delete();
// Replace the named item (TotalAmount) with the actual formula for TotalAmount to avoid displaying #NAME in the cell.
sheet.getRange("D11").values = [["=SUM(ExpensesTable[AMOUNT])"]];
} else {
console.log("No named item created for the formula.");
}
await context.sync();
});
getRange()
Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Gibt einen Fehler zurück, wenn der Typ des benannten Elements kein Bereich ist.
getRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
// Returns the Range object that is associated with the name.
// Returns `null` if the name is not of type Range.
// Note: This API currently supports only the Workbook scoped items.
await Excel.run(async (context) => {
const names = context.workbook.names;
const range = names.getItem('MyRange').getRange();
range.load('address');
await context.sync();
console.log(range.address);
});
getRangeOrNullObject()
Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Wenn der Typ des benannten Elements kein Bereich ist, dann gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getRangeOrNullObject(): Excel.Range;Gibt zurück
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.NamedItemLoadOptions): Excel.NamedItem;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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.NamedItem;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
await Excel.run(async (context) => {
const names = context.workbook.names;
const namedItem = names.getItem('MyRange');
namedItem.load('type');
await context.sync();
console.log(namedItem.type);
});
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?: {
select?: string;
expand?: string;
}): Excel.NamedItem;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.NamedItemUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.NamedItem): void;Parameter
- properties
- Excel.NamedItem
Gibt zurück
void
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 sie übergeben wird.) Während das ursprüngliche Excel.NamedItem Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.NamedItemData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.NamedItemData;