Excel.TableColumn class
Stellt eine Spalte in einer Tabelle dar.
- 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. |
| filter | Ruft den auf die Spalte angewendeten Filter ab. |
| id | Gibt einen eindeutigen Schlüssel an, der die Spalte in der Tabelle angibt. |
| index | Gibt die Indexnummer der Spalte in der Spaltenauflistung der Tabelle zurück. Nullindiziert. |
| name | Gibt den Namen der Tabellenspalte an. |
| values | Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel. |
| values |
Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenspalte. Im Gegensatz zu |
| values |
Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenspalte. Im Gegensatz zu |
Methoden
| delete() | Löscht die Spalte aus der Tabelle. |
| get |
Ruft das Bereichsobjekt ab, das mit dem Datenteil der Spalte verknüpft ist. |
| get |
Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Spalte verknüpft ist. |
| get |
Ruft das Bereichsobjekt ab, das mit der gesamten Spalte verknüpft ist. |
| get |
Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Spalte verknüpft ist. |
| 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
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
filter
Ruft den auf die Spalte angewendeten Filter ab.
readonly filter: Excel.Filter;Eigenschaftswert
Hinweise
id
Gibt einen eindeutigen Schlüssel an, der die Spalte in der Tabelle angibt.
readonly id: number;Eigenschaftswert
number
Hinweise
index
Gibt die Indexnummer der Spalte in der Spaltenauflistung der Tabelle zurück. Nullindiziert.
readonly index: number;Eigenschaftswert
number
Hinweise
name
Gibt den Namen der Tabellenspalte an.
name: string;Eigenschaftswert
string
Hinweise
[ API-Satz: ExcelApi 1.1 zum Abrufen des Namens; 1.4 zum Festlegen. ]
values
Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.
values: any[][];Eigenschaftswert
any[][]
Hinweise
valuesAsJson
Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenspalte. Im Gegensatz zu TableColumn.valuesunterstützt TableColumn.valuesAsJson alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten entsprechen immer dem Gebietsschema en-US. Verwenden Sie TableColumn.valuesAsJsonLocal, um Daten im Anzeigegebietsschema des Benutzers abzurufen.
valuesAsJson: CellValue[][];Eigenschaftswert
Excel.CellValue[][]
Hinweise
valuesAsJsonLocal
Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenspalte. Im Gegensatz zu TableColumn.valuesunterstützt TableColumn.valuesAsJsonLocal alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten sind immer am Anzeigegebietsschema des Benutzers ausgerichtet. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie TableColumn.valuesAsJson.
valuesAsJsonLocal: CellValue[][];Eigenschaftswert
Excel.CellValue[][]
Hinweise
Details zur Methode
delete()
Löscht die Spalte aus der Tabelle.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
column.delete();
await context.sync();
});
getDataBodyRange()
Ruft das Bereichsobjekt ab, das mit dem Datenteil der Spalte verknüpft ist.
getDataBodyRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const dataBodyRange = column.getDataBodyRange();
dataBodyRange.load('address');
await context.sync();
console.log(dataBodyRange.address);
});
getHeaderRowRange()
Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Spalte verknüpft ist.
getHeaderRowRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const headerRowRange = columns.getHeaderRowRange();
headerRowRange.load('address');
await context.sync();
console.log(headerRowRange.address);
});
getRange()
Ruft das Bereichsobjekt ab, das mit der gesamten Spalte verknüpft ist.
getRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const columnRange = columns.getRange();
columnRange.load('address');
await context.sync();
console.log(columnRange.address);
});
getTotalRowRange()
Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Spalte verknüpft ist.
getTotalRowRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const totalRowRange = columns.getTotalRowRange();
totalRowRange.load('address');
await context.sync();
console.log(totalRowRange.address);
});
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.TableColumnLoadOptions): Excel.TableColumn;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.TableColumn;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 tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItem(0);
column.load('index');
await context.sync();
console.log(column.index);
});
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.TableColumn;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
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.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.TableColumnUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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.TableColumn): void;Parameter
- properties
- Excel.TableColumn
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 das Objekt übergeben wird.) Während das ursprüngliche Excel.TableColumn-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TableColumnData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.TableColumnData;Gibt zurück
Office Add-ins