Office.TableBinding interface

Paket:

office

Stellt eine Bindung in zwei Dimensionen von Zeilen und Spalten dar, optional mit Kopfzeilen.

Extends

Office.Binding

Hinweise

Das TableBinding-Objekt erbt die id Eigenschaft, type die Eigenschaft, getDataAsync die Methode und setDataAsync die Methode vom Office.Binding-Objekt .

Beachten Sie für Excel, dass nach dem Einrichten einer Tabellenbindung jede neue Zeile, die ein Benutzer der Tabelle hinzufügt, automatisch in die Bindung einbezogen wird und rowCount zunimmt.

Eigenschaften

columnCount	Ruft die Anzahl der Spalten in tableBinding als ganzzahligen Wert ab.
hasHeaders	True, wenn die Tabelle Überschriften enthält; andernfalls false.
rowCount	Ruft die Anzahl der Zeilen in TableBinding als ganzzahligen Wert ab.

Methoden

addColumnsAsync(tableData, options, callback)	Fügt der Tabelle die angegebenen Daten als zusätzliche Spalten hinzu.
addColumnsAsync(tableData, callback)	Fügt der Tabelle die angegebenen Daten als zusätzliche Spalten hinzu.
addRowsAsync(rows, options, callback)	Fügt der Tabelle die angegebenen Daten als zusätzliche Zeilen hinzu.
addRowsAsync(rows, callback)	Fügt der Tabelle die angegebenen Daten als zusätzliche Zeilen hinzu.
clearFormatsAsync(options, callback)	Löscht Formatierung der gebundenen Tabelle.
clearFormatsAsync(callback)	Löscht Formatierung der gebundenen Tabelle.
deleteAllDataValuesAsync(options, callback)	Löscht alle Zeilen ohne Kopfzeilen und deren Werte in der Tabelle und wird entsprechend für die Office-Anwendung verschoben.
deleteAllDataValuesAsync(callback)	Löscht alle Zeilen ohne Kopfzeilen und deren Werte in der Tabelle und wird entsprechend für die Office-Anwendung verschoben.
getFormatsAsync(cellReference, formats, options, callback)	Ruft die Formatierung für angegebene Elemente in der Tabelle ab.
getFormatsAsync(cellReference, formats, callback)	Ruft die Formatierung für angegebene Elemente in der Tabelle ab.
setFormatsAsync(cellFormat, options, callback)	Legt die Formatierung für angegebene Elemente und Daten in der Tabelle fest.
setFormatsAsync(cellFormat, callback)	Legt die Formatierung für angegebene Elemente und Daten in der Tabelle fest.
setTableOptionsAsync(tableOptions, options, callback)	Aktualisiert Tabellenformatierungsoptionen für die gebundene Tabelle.
setTableOptionsAsync(tableOptions, callback)	Aktualisiert Tabellenformatierungsoptionen für die gebundene Tabelle.

Details zur Eigenschaft

columnCount

Ruft die Anzahl der Spalten in tableBinding als ganzzahligen Wert ab.

columnCount: number;

Eigenschaftswert

number

Beispiele

function showBindingColumnCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Column: " + asyncResult.value.columnCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

hasHeaders

True, wenn die Tabelle Überschriften enthält; andernfalls false.

hasHeaders: boolean;

Eigenschaftswert

boolean

Beispiele

function showBindingHasHeaders() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Binding has headers: " + asyncResult.value.hasHeaders);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

rowCount

Ruft die Anzahl der Zeilen in TableBinding als ganzzahligen Wert ab.

rowCount: number;

Eigenschaftswert

number

Hinweise

Wenn Sie eine leere Tabelle einfügen, indem Sie eine einzelne Zeile in Excel auf dem Desktop und Excel im Web (mithilfe von Tabelle auf der Registerkarte Einfügen) auswählen, erstellen beide Office-Anwendungen eine einzelne Zeile mit Kopfzeilen gefolgt von einer einzelnen leeren Zeile. Wenn das Skript Ihres Add-Ins jedoch eine Bindung für diese neu eingefügte Tabelle erstellt (z. B. mithilfe der Office.Bindings.addFromSelectionAsync-Methode) und dann den Wert der rowCount-Eigenschaft überprüft, unterscheidet sich der zurückgegebene Wert je nachdem, ob das Arbeitsblatt in Excel auf dem Desktop oder Excel im Web geöffnet ist.

• In Excel auf dem Desktop (d. h. Windows und Mac) gibt rowCount 0 zurück (die leere Zeile nach den Kopfzeilen wird nicht gezählt).

• In Excel im Web gibt rowCount 1 zurück (die leere Zeile nach den Headern wird gezählt).

Sie können diesen Unterschied in Ihrem Skript umgehen, indem Sie prüfen, ob rowCount == 1 und falls dem so ist, prüfen Sie, ob die Zeile alle leeren Zeichenfolgen enthält.

Beispiele

function showBindingRowCount() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        write("Rows: " + asyncResult.value.rowCount);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Details zur Methode

addColumnsAsync(tableData, options, callback)

Fügt der Tabelle die angegebenen Daten als zusätzliche Spalten hinzu.

addColumnsAsync(tableData: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

tableData

Office.TableData | any[][]

Ein Array von Arrays ("Matrix") oder ein TableData-Objekt, das eine oder mehrere Datenspalten enthält, die der Tabelle hinzugefügt werden sollen. Erforderlich.

options

Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Um eine oder mehrere Spalten hinzuzufügen, die die Werte der Daten und Header angeben, übergeben Sie ein TableData-Objekt als Datenparameter. Wenn eine oder mehrere Spalten hinzugefügt werden sollen, die nur die Daten angeben, übergeben Sie ein Array von Arrays ("Matrix") als data-Parameter.

Der Erfolg oder Fehler eines addColumnsAsync-Vorgangs ist atomisch. Dies bedeutet, dass der gesamte Vorgang zum Hinzufügen von Spalten erfolgreich sein muss, andernfalls wird er vollständig rückgängig gemacht (und die an den Rückruf zurückgegebene AsyncResult.status-Eigenschaft meldet einen Fehler):

• Jede Zeile im Array, die Sie als Argument data übergeben, muss die gleiche Anzahl von Zeilen aufweisen wie die tabelle, die aktualisiert wird. Wenn dies nicht der Fall ist, tritt bei dem Vorgang ein Fehler auf.

• Jede Zeile und Zelle im Array muss diese Zeile oder Zelle erfolgreich der Tabelle in den neu hinzugefügten Spalten hinzufügen. Wenn eine Zeile oder Zelle aus irgendeinem Grund nicht festgelegt werden kann, schlägt der gesamte Vorgang fehl.

• Wenn Sie ein TableData-Objekt als Datenargument übergeben, muss die Anzahl der Headerzeilen mit der der Tabelle übereinstimmen, die aktualisiert wird.

Zusätzliche Anmerkung für Excel im Web: Die Gesamtzahl der Zellen im TableData-Objekt, die an den data-Parameter übergeben wird, darf 20.000 in einem einzelnen Aufruf dieser Methode nicht überschreiten.

Beispiele

// The following example adds a single column with three rows to a bound table with the id "myTable"
// by passing a TableData object as the data argument of the addColumnsAsync method. To succeed,
// the table being updated must have three rows.

// Add a column to a binding of type table by passing a TableData object.
function addColumns() {
    const myTable = new Office.TableData();
    myTable.headers = [["Cities"]];
    myTable.rows = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

// The following example adds a single column with three rows to a bound table with the id myTable
// by passing an array of arrays ("matrix") as the data argument of the addColumnsAsync method.
// To succeed, the table being updated must have three rows.

// Add a column to a binding of type table by passing an array of arrays.
function addColumns() {
    const myTable = [["Berlin"], ["Roma"], ["Tokyo"]];

    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addColumnsAsync(myTable);
    });
}

addColumnsAsync(tableData, callback)

Fügt der Tabelle die angegebenen Daten als zusätzliche Spalten hinzu.

addColumnsAsync(tableData: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

Parameter

tableData

Office.TableData | any[][]

Ein Array von Arrays ("Matrix") oder ein TableData-Objekt, das eine oder mehrere Datenspalten enthält, die der Tabelle hinzugefügt werden sollen. Erforderlich.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Um eine oder mehrere Spalten hinzuzufügen, die die Werte der Daten und Header angeben, übergeben Sie ein TableData-Objekt als Datenparameter. Wenn eine oder mehrere Spalten hinzugefügt werden sollen, die nur die Daten angeben, übergeben Sie ein Array von Arrays ("Matrix") als data-Parameter.

Der Erfolg oder Fehler eines addColumnsAsync-Vorgangs ist atomisch. Dies bedeutet, dass der gesamte Vorgang zum Hinzufügen von Spalten erfolgreich sein muss, andernfalls wird er vollständig rückgängig gemacht (und die an den Rückruf zurückgegebene AsyncResult.status-Eigenschaft meldet einen Fehler):

• Jede Zeile im Array, die Sie als Argument data übergeben, muss die gleiche Anzahl von Zeilen aufweisen wie die tabelle, die aktualisiert wird. Wenn dies nicht der Fall ist, tritt bei dem Vorgang ein Fehler auf.

• Jede Zeile und Zelle im Array muss diese Zeile oder Zelle erfolgreich der Tabelle in den neu hinzugefügten Spalten hinzufügen. Wenn eine Zeile oder Zelle aus irgendeinem Grund nicht festgelegt werden kann, schlägt der gesamte Vorgang fehl.

• Wenn Sie ein TableData-Objekt als Datenargument übergeben, muss die Anzahl der Headerzeilen mit der der Tabelle übereinstimmen, die aktualisiert wird.

Zusätzliche Anmerkung für Excel im Web: Die Gesamtzahl der Zellen im TableData-Objekt, die an den data-Parameter übergeben wird, darf 20.000 in einem einzelnen Aufruf dieser Methode nicht überschreiten.

addRowsAsync(rows, options, callback)

Fügt der Tabelle die angegebenen Daten als zusätzliche Zeilen hinzu.

addRowsAsync(rows: TableData | any[][], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

rows

Office.TableData | any[][]

Ein Array von Arrays ("Matrix") oder ein TableData-Objekt, das eine oder mehrere Datenzeilen enthält, die der Tabelle hinzugefügt werden sollen. Erforderlich.

options

Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Der Erfolg oder Fehler eines addRowsAsync-Vorgangs ist atomisch. Dies bedeutet, dass der gesamte Vorgang zum Hinzufügen von Spalten erfolgreich sein muss, andernfalls wird er vollständig rückgängig gemacht (und die an den Rückruf zurückgegebene AsyncResult.status-Eigenschaft meldet einen Fehler):

• Jede Zeile im Array, die Sie als Argument data übergeben, muss die gleiche Anzahl von Spalten aufweisen wie die tabelle, die aktualisiert wird. Wenn dies nicht der Fall ist, tritt bei dem Vorgang ein Fehler auf.

• Jede Spalte und Zelle im Array muss diese Spalte oder Zelle erfolgreich der Tabelle in den neu hinzugefügten Zeilen hinzufügen. Wenn eine Spalte oder Zelle aus irgendeinem Grund nicht festgelegt werden kann, schlägt der gesamte Vorgang fehl.

• Wenn Sie ein TableData-Objekt als Datenargument übergeben, muss die Anzahl der Headerzeilen mit der der Tabelle übereinstimmen, die aktualisiert wird.

Zusätzliche Anmerkung für Excel im Web: Die Gesamtzahl der Zellen im TableData-Objekt, die an den data-Parameter übergeben wird, darf 20.000 in einem einzelnen Aufruf dieser Methode nicht überschreiten.

Beispiele

function addRowsToTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.addRowsAsync([["6", "k"], ["7", "j"]]);
    });
}

addRowsAsync(rows, callback)

Fügt der Tabelle die angegebenen Daten als zusätzliche Zeilen hinzu.

addRowsAsync(rows: TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

Parameter

rows

Office.TableData | any[][]

Ein Array von Arrays ("Matrix") oder ein TableData-Objekt, das eine oder mehrere Datenzeilen enthält, die der Tabelle hinzugefügt werden sollen. Erforderlich.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Der Erfolg oder Fehler eines addRowsAsync-Vorgangs ist atomisch. Dies bedeutet, dass der gesamte Vorgang zum Hinzufügen von Spalten erfolgreich sein muss, andernfalls wird er vollständig rückgängig gemacht (und die an den Rückruf zurückgegebene AsyncResult.status-Eigenschaft meldet einen Fehler):

• Jede Zeile im Array, die Sie als Argument data übergeben, muss die gleiche Anzahl von Spalten aufweisen wie die tabelle, die aktualisiert wird. Wenn dies nicht der Fall ist, tritt bei dem Vorgang ein Fehler auf.

• Jede Spalte und Zelle im Array muss diese Spalte oder Zelle erfolgreich der Tabelle in den neu hinzugefügten Zeilen hinzufügen. Wenn eine Spalte oder Zelle aus irgendeinem Grund nicht festgelegt werden kann, schlägt der gesamte Vorgang fehl.

• Wenn Sie ein TableData-Objekt als Datenargument übergeben, muss die Anzahl der Headerzeilen mit der der Tabelle übereinstimmen, die aktualisiert wird.

Zusätzliche Anmerkung für Excel im Web: Die Gesamtzahl der Zellen im TableData-Objekt, die an den data-Parameter übergeben wird, darf 20.000 in einem einzelnen Aufruf dieser Methode nicht überschreiten.

clearFormatsAsync(options, callback)

Löscht Formatierung der gebundenen Tabelle.

clearFormatsAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

options

Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Weitere Informationen finden Sie unter Formatieren von Tabellen in Add-Ins für Excel .

Beispiele

// The following example shows how to clear the formatting of the bound table with an ID of "myBinding":
Office.select("bindings#myBinding").clearFormatsAsync();

clearFormatsAsync(callback)

Löscht Formatierung der gebundenen Tabelle.

clearFormatsAsync(callback?: (result: AsyncResult<void>) => void): void;

Parameter

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Weitere Informationen finden Sie unter Formatieren von Tabellen in Add-Ins für Excel .

deleteAllDataValuesAsync(options, callback)

Löscht alle Zeilen ohne Kopfzeilen und deren Werte in der Tabelle und wird entsprechend für die Office-Anwendung verschoben.

deleteAllDataValuesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

options

Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Wenn die Tabelle in Excel über keine Kopfzeile verfügt, löscht diese Methode die Tabelle selbst.

Beispiele

function deleteAllRowsFromTable() {
    Office.context.document.bindings.getByIdAsync("myBinding", function (asyncResult) {
        const binding = asyncResult.value;
        binding.deleteAllDataValuesAsync();
    });
}

deleteAllDataValuesAsync(callback)

Löscht alle Zeilen ohne Kopfzeilen und deren Werte in der Tabelle und wird entsprechend für die Office-Anwendung verschoben.

deleteAllDataValuesAsync(callback?: (result: AsyncResult<void>) => void): void;

Parameter

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Wenn die Tabelle in Excel über keine Kopfzeile verfügt, löscht diese Methode die Tabelle selbst.

getFormatsAsync(cellReference, formats, options, callback)

Ruft die Formatierung für angegebene Elemente in der Tabelle ab.

getFormatsAsync(cellReference?: any, formats?: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

Parameter

cellReference

any

Ein Objektliteral, das Name-Wert-Paare enthält, die den Zellbereich angeben, aus dem Formatierungen abgerufen werden sollen.

formats

any[]

Ein Array, das die abzurufenden Formateigenschaften angibt.

options

Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult< Array<{ cells: any, format: any}>>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein Array, das ein oder mehrere JavaScript-Objekte enthält, die die Formatierung der entsprechenden Zellen angeben.

Gibt zurück

void

Hinweise

Zurückgegebene Formatstruktur

Jedes JavaScript-Objekt im Rückgabewertarray hat folgende Form: {cells:{ cell_range }, format:{ format_definition }}

Die cells: -Eigenschaft gibt den Bereich an, den Sie formatieren möchten, indem Sie einen der folgenden Werte verwenden.

Unterstützte Bereiche in Zelleneigenschaft

cells Bereichseinstellungen	Beschreibung
{row: n}	Gibt den Bereich an, bei dem es sich um die nullbasierte n. Zeile der Daten in der Tabelle handelt.
{column: n}	Gibt den Bereich an, der die nullbasierte n-te Datenspalte in der Tabelle darstellt.
{row: i, column: j}	Gibt die einzelne Zelle an, bei der es sich um die ith-Zeile und die jth-Spalte der Tabelle handelt.
Office.Table.All	Gibt die gesamte Tabelle, einschließlich Spaltenüberschriften, Daten und Ergebnissen (falls vorhanden) an.
Office.Table.Data	Gibt nur die Daten in der Tabelle an (keine Überschriften und Ergebnisse).
Office.Table.Headers	Gibt nur die Kopfzeile an.

Die format: -Eigenschaft gibt Werte an, die einer Teilmenge der Einstellungen entsprechen, die im Dialogfeld Zellen formatieren in Excel verfügbar sind (Öffnen Sie das Kontextmenü (klicken Sie mit der rechten Maustaste, oder wählen Sie sie gedrückt), und wählen Sie dann Zellen formatieren oder Start>Formatieren>Zellen formatieren aus.

getFormatsAsync(cellReference, formats, callback)

Ruft die Formatierung für angegebene Elemente in der Tabelle ab.

getFormatsAsync(cellReference?: any, formats?: any[], callback?: (result: AsyncResult< Array<{ cells: any, format: any}>>) => void): void;

Parameter

cellReference

any

Ein Objektliteral, das Name-Wert-Paare enthält, die den Zellbereich angeben, aus dem Formatierungen abgerufen werden sollen.

formats

any[]

Ein Array, das die abzurufenden Formateigenschaften angibt.

callback

(result: Office.AsyncResult< Array<{ cells: any, format: any}>>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist. Die value -Eigenschaft des Ergebnisses ist ein Array, das ein oder mehrere JavaScript-Objekte enthält, die die Formatierung der entsprechenden Zellen angeben.

Gibt zurück

void

Hinweise

Zurückgegebene Formatstruktur

Jedes JavaScript-Objekt im Rückgabewertarray hat folgende Form: {cells:{ cell_range }, format:{ format_definition }}

Die cells: -Eigenschaft gibt den Bereich an, den Sie formatieren möchten, indem Sie einen der folgenden Werte verwenden.

Unterstützte Bereiche in Zelleneigenschaft

cells Bereichseinstellungen	Beschreibung
{row: n}	Gibt den Bereich an, bei dem es sich um die nullbasierte n. Zeile der Daten in der Tabelle handelt.
{column: n}	Gibt den Bereich an, der die nullbasierte n-te Datenspalte in der Tabelle darstellt.
{row: i, column: j}	Gibt die einzelne Zelle an, bei der es sich um die ith-Zeile und die jth-Spalte der Tabelle handelt.
Office.Table.All	Gibt die gesamte Tabelle, einschließlich Spaltenüberschriften, Daten und Ergebnissen (falls vorhanden) an.
Office.Table.Data	Gibt nur die Daten in der Tabelle an (keine Überschriften und Ergebnisse).
Office.Table.Headers	Gibt nur die Kopfzeile an.

Die format: -Eigenschaft gibt Werte an, die einer Teilmenge der Einstellungen entsprechen, die im Dialogfeld Zellen formatieren in Excel verfügbar sind (Öffnen Sie das Kontextmenü (klicken Sie mit der rechten Maustaste, oder wählen Sie sie gedrückt), und wählen Sie dann Zellen formatieren oder Start>Formatieren>Zellen formatieren aus.

setFormatsAsync(cellFormat, options, callback)

Legt die Formatierung für angegebene Elemente und Daten in der Tabelle fest.

setFormatsAsync(cellFormat: any[], options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

cellFormat

any[]

Ein Array, das ein oder mehrere JavaScript-Objekte enthält, die angeben, welche Zellen betroffen sind und welche Formate darauf angewendet werden sollen.

options

Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Angeben des cellFormat-Parameters

Verwenden Sie den cellFormat-Parameter zum Ändern von Zellenformatwerten wie z. B. die Breite, Höhe, Schriftart, Ausrichtung usw. Der Wert, den Sie als cellFormat-Parameter übergeben, ist ein Array, das eine Liste von einem oder mehreren JavaScript-Objekten enthält, die angeben, welche Zellen als Ziel (cells:) und welche Formate (format:) darauf angewendet werden sollen.

Jedes JavaScript-Objekt im cellFormat-Array hat folgende Form: {cells:{ cell_range }, format:{ format_definition }}

Die cells: -Eigenschaft gibt den Bereich an, den Sie formatieren möchten, indem Sie einen der folgenden Werte verwenden.

Unterstützte Bereiche in Zelleneigenschaft

cells Bereichseinstellungen	Beschreibung
{row: n}	Gibt den Bereich an, bei dem es sich um die nullbasierte n. Zeile der Daten in der Tabelle handelt.
{column: n}	Gibt den Bereich an, der die nullbasierte n-te Datenspalte in der Tabelle darstellt.
{row: i, column: j}	Gibt die einzelne Zelle an, bei der es sich um die ith-Zeile und die jth-Spalte der Tabelle handelt.
Office.Table.All	Gibt die gesamte Tabelle, einschließlich Spaltenüberschriften, Daten und Ergebnissen (falls vorhanden) an.
Office.Table.Data	Gibt nur die Daten in der Tabelle an (keine Überschriften und Ergebnisse).
Office.Table.Headers	Gibt nur die Kopfzeile an.

Die format: -Eigenschaft gibt Werte an, die einer Teilmenge der Einstellungen entsprechen, die im Dialogfeld Zellen formatieren in Excel verfügbar sind (Öffnen Sie das Kontextmenü (klicken Sie mit der rechten Maustaste, oder wählen Sie sie gedrückt), und wählen Sie dann Zellen formatieren oder Start>Formatieren>Zellen formatieren aus.

Sie geben den Wert der format: Eigenschaft als Liste von eigenschaftsnamen - Wertpaaren in einem JavaScript-Objektliteral an. Der Eigenschaftsname gibt den Namen der festzulegenden Formatierungseigenschaft an, und value gibt den Eigenschaftswert an. Sie können mehrere Werte für ein bestimmtes Format angeben, z. B. sowohl die Farbe als auch die Größe einer Schriftart.

Im Folgenden finden Sie drei format: Beispiele für Eigenschaftswerte:

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

Sie können Zahlenformate angeben, indem Sie die "Code"-Zeichenfolge für die Zahlenformatierung in der numberFormat: -Eigenschaft angeben. Die Formatzeichenfolgen, die Sie festlegen können, entsprechen denjenigen, die Sie in Excel mithilfe der Kategorie Benutzerdefiniert auf der Registerkarte Zahl im Dialogfeld Zellen formatieren festlegen können. Dieses Beispiel zeigt, wie Sie eine Zahl als Prozentsatz mit zwei Dezimalstellen formatieren:

format: {numberFormat:"0.00%"}

Weitere Informationen finden Sie unter Erstellen eines benutzerdefinierten Zahlenformats.

Verwenden Sie zum Festlegen der Formatierung von Tabellen beim Schreiben von Daten die optionalen Parameter tableOptions und cellFormat der Document.setSelectedDataAsync Methoden oder TableBinding.setDataAsync .

Das Festlegen der Formatierung mit den optionalen Parametern der -Methode und TableBinding.setDataAsync der Document.setSelectedDataAsync -Methode funktioniert nur zum Festlegen der Formatierung beim ersten Schreiben von Daten. Verwenden Sie die folgenden Methoden, um Formatierungsänderungen nach dem Schreiben von Daten vorzunehmen.

• Verwenden Sie zum Aktualisieren der Zellformatierung, z. B. Schriftfarbe und Schriftschnitt, die TableBinding.setFormatsAsync -Methode (diese Methode).

• Verwenden Sie die TableBinding.setTableOptions -Methode, um Tabellenoptionen wie gebänderte Zeilen und Filterschaltflächen zu aktualisieren.

• Verwenden Sie die -Methode, um die TableBinding.clearFormats Formatierung zu löschen.

Weitere Informationen und Beispiele finden Sie unter Formatieren von Tabellen in Add-Ins für Excel.

Beispiele

// Specifying a single target
// The following example shows a cellFormat value that sets the font color of the header row to red.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: Office.Table.Headers, format: {fontColor: "red"}}], 
    function (asyncResult){});

// Specifying multiple targets
// The setFormatsAsync method can support formatting multiple targets within the bound table in a 
// single function call. To do that, you pass a list of objects in the cellFormat array 
// for each target that you want to format.
// For example, the following line of code will set the font color of the first row yellow, 
// and the fourth cell in the third row to have a white border and bold text.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

// Additional remarks for Excel Online
// The number of formatting groups passed to the cellFormat parameter can't exceed 100. 
// A single formatting group consists of a set of formatting applied to a specified range of cells. 
// For example, the following call passes two formatting groups to cellFormat.
Office.select("bindings#myBinding").setFormatsAsync(
    [{cells: {row: 1}, format: {fontColor: "yellow"}}, 
        {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}], 
    function (asyncResult){});

setFormatsAsync(cellFormat, callback)

Legt die Formatierung für angegebene Elemente und Daten in der Tabelle fest.

setFormatsAsync(cellFormat: any[], callback?: (result: AsyncResult<void>) => void): void;

Parameter

cellFormat

any[]

Ein Array, das ein oder mehrere JavaScript-Objekte enthält, die angeben, welche Zellen betroffen sind und welche Formate darauf angewendet werden sollen.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Angeben des cellFormat-Parameters

Verwenden Sie den cellFormat-Parameter zum Ändern von Zellenformatwerten wie z. B. die Breite, Höhe, Schriftart, Ausrichtung usw. Der Wert, den Sie als cellFormat-Parameter übergeben, ist ein Array, das eine Liste von einem oder mehreren JavaScript-Objekten enthält, die angeben, welche Zellen als Ziel (cells:) und welche Formate (format:) darauf angewendet werden sollen.

Jedes JavaScript-Objekt im cellFormat-Array hat folgende Form: {cells:{ cell_range }, format:{ format_definition }}

Die cells: -Eigenschaft gibt den Bereich an, den Sie formatieren möchten, indem Sie einen der folgenden Werte verwenden.

Unterstützte Bereiche in Zelleneigenschaft

cells Bereichseinstellungen	Beschreibung
{row: n}	Gibt den Bereich an, bei dem es sich um die nullbasierte n. Zeile der Daten in der Tabelle handelt.
{column: n}	Gibt den Bereich an, der die nullbasierte n-te Datenspalte in der Tabelle darstellt.
{row: i, column: j}	Gibt die einzelne Zelle an, bei der es sich um die ith-Zeile und die jth-Spalte der Tabelle handelt.
Office.Table.All	Gibt die gesamte Tabelle, einschließlich Spaltenüberschriften, Daten und Ergebnissen (falls vorhanden) an.
Office.Table.Data	Gibt nur die Daten in der Tabelle an (keine Überschriften und Ergebnisse).
Office.Table.Headers	Gibt nur die Kopfzeile an.

Die format: -Eigenschaft gibt Werte an, die einer Teilmenge der Einstellungen entsprechen, die im Dialogfeld Zellen formatieren in Excel verfügbar sind (Öffnen Sie das Kontextmenü (klicken Sie mit der rechten Maustaste, oder wählen Sie sie gedrückt), und wählen Sie dann Zellen formatieren oder Start>Formatieren>Zellen formatieren aus.

Sie geben den Wert der format: Eigenschaft als Liste von eigenschaftsnamen - Wertpaaren in einem JavaScript-Objektliteral an. Der Eigenschaftsname gibt den Namen der festzulegenden Formatierungseigenschaft an, und value gibt den Eigenschaftswert an. Sie können mehrere Werte für ein bestimmtes Format angeben, z. B. sowohl die Farbe als auch die Größe einer Schriftart.

Im Folgenden finden Sie drei format: Beispiele für Eigenschaftswerte:

//Set cells: font color to green and size to 15 points.

format: {fontColor : "green", fontSize : 15}

//Set cells: border to dotted blue.

format: {borderStyle: "dotted", borderColor: "blue"}

//Set cells: background to red and alignment to centered.

format: {backgroundColor: "red", alignHorizontal: "center"}

Sie können Zahlenformate angeben, indem Sie die "Code"-Zeichenfolge für die Zahlenformatierung in der numberFormat: -Eigenschaft angeben. Die Formatzeichenfolgen, die Sie festlegen können, entsprechen denjenigen, die Sie in Excel mithilfe der Kategorie Benutzerdefiniert auf der Registerkarte Zahl im Dialogfeld Zellen formatieren festlegen können. Dieses Beispiel zeigt, wie Sie eine Zahl als Prozentsatz mit zwei Dezimalstellen formatieren:

format: {numberFormat:"0.00%"}

Weitere Informationen finden Sie unter Erstellen eines benutzerdefinierten Zahlenformats.

Verwenden Sie zum Festlegen der Formatierung von Tabellen beim Schreiben von Daten die optionalen Parameter tableOptions und cellFormat der Document.setSelectedDataAsync Methoden oder TableBinding.setDataAsync .

Das Festlegen der Formatierung mit den optionalen Parametern der -Methode und TableBinding.setDataAsync der Document.setSelectedDataAsync -Methode funktioniert nur zum Festlegen der Formatierung beim ersten Schreiben von Daten. Verwenden Sie die folgenden Methoden, um Formatierungsänderungen nach dem Schreiben von Daten vorzunehmen.

• Verwenden Sie zum Aktualisieren der Zellformatierung, z. B. Schriftfarbe und Schriftschnitt, die TableBinding.setFormatsAsync -Methode (diese Methode).

• Verwenden Sie die TableBinding.setTableOptions -Methode, um Tabellenoptionen wie gebänderte Zeilen und Filterschaltflächen zu aktualisieren.

• Verwenden Sie die -Methode, um die TableBinding.clearFormats Formatierung zu löschen.

Weitere Informationen und Beispiele finden Sie unter Formatieren von Tabellen in Add-Ins für Excel.

setTableOptionsAsync(tableOptions, options, callback)

Aktualisiert Tabellenformatierungsoptionen für die gebundene Tabelle.

setTableOptionsAsync(tableOptions: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parameter

tableOptions

any

Ein Objekt mit einer Liste von Eigenschaftsname-Wert-Paaren, welche die anzuwendenden Tabellenoptionen definieren.

options

Office.AsyncContextOptions

Bietet eine Option zum Beibehalten von Kontextdaten eines beliebigen Typs , unverändert, für die Verwendung in einem Rückruf.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: Nicht in einem Satz

In der Rückruffunktion, die Sie an die goToByIdAsync-Methode übergeben haben, können Sie die Eigenschaften des AsyncResult-Objekts verwenden, um die folgenden Informationen zurückzugeben.

Eigenschaft	Verwendung
AsyncResult.value	Gibt immer zurück undefined , da beim Festlegen von Formaten keine Daten oder Objekte zum Abrufen vorhanden sind.
AsyncResult.status	Bestimmen Sie, ob der Vorgang erfolgreich war oder ein Fehler aufgetreten ist.
AsyncResult.error	Greifen Sie auf ein Error-Objekt zu, das nach einem fehlgeschlagenen Vorgang Fehlerinformationen bereitstellt.
AsyncResult.asyncContext	Definieren Sie ein Element eines beliebigen Typs, der im AsyncResult-Objekt zurückgegeben wird, ohne geändert zu werden.

Beispiele

// The following example shows how to:
// 1. Create an object literal that specifies the table formatting options to update on the bound table.
// 2. Call setTableOptions on a previously bound table (with an id of myBinding) passing the object
//    with formatting setting as the tableOptions parameter.
function updateTableFormatting(){
    const tableOptions = {bandedRows: true, filterButton: false, style: "TableStyleMedium3"}; 

    Office.select("bindings#myBinding").setTableOptionsAsync(tableOptions, function(asyncResult){});
}

setTableOptionsAsync(tableOptions, callback)

Aktualisiert Tabellenformatierungsoptionen für die gebundene Tabelle.

setTableOptionsAsync(tableOptions: any, callback?: (result: AsyncResult<void>) => void): void;

Parameter

tableOptions

any

Ein Objekt mit einer Liste von Eigenschaftsname-Wert-Paaren, welche die anzuwendenden Tabellenoptionen definieren.

callback

(result: Office.AsyncResult<void>) => void

Optional. Eine Funktion, die aufgerufen wird, wenn der Rückruf zurückgibt, deren einziger Parameter vom Typ Office.AsyncResult ist.

Gibt zurück

void

Hinweise

Anforderungssatz: Nicht in einem Satz

In der Rückruffunktion, die Sie an die goToByIdAsync-Methode übergeben haben, können Sie die Eigenschaften des AsyncResult-Objekts verwenden, um die folgenden Informationen zurückzugeben.

Eigenschaft	Verwendung
AsyncResult.value	Gibt immer zurück undefined , da beim Festlegen von Formaten keine Daten oder Objekte zum Abrufen vorhanden sind.
AsyncResult.status	Bestimmen Sie, ob der Vorgang erfolgreich war oder ein Fehler aufgetreten ist.
AsyncResult.error	Greifen Sie auf ein Error-Objekt zu, das nach einem fehlgeschlagenen Vorgang Fehlerinformationen bereitstellt.
AsyncResult.asyncContext	Definieren Sie ein Element eines beliebigen Typs, der im AsyncResult-Objekt zurückgegeben wird, ohne geändert zu werden.