PowerPoint.Table class

Stellt eine Tabelle dar.

Extends

Hinweise

API-Satz: PowerPointApi 1.8

Verwendet von

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml

// Updates a table's values.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;

  // Add a table (which is a type of Shape).
  const shape = shapes.addTable(4, 3);
  let table = shape.getTable();
  table.load();
  await context.sync();

  // Update values in the table.
  for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
    for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
      const cell = table.getCellOrNullObject(rowIndex, columnIndex);
      cell.text = generateRandomString();
    }
  }

  await context.sync();
});

Eigenschaften

columnCount

Ruft die Anzahl der Spalten in der Tabelle ab.

columns

Ruft die Auflistung der Spalten in der Tabelle ab.

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

rowCount

Ruft die Anzahl der Zeilen in der Tabelle ab.

rows

Ruft die Auflistung der Zeilen in der Tabelle ab.

styleSettings

Ruft die Einstellungen für das Tabellenformat ab.

values

Ruft alle Werte in der Tabelle ab.

Methoden

clear(options)

Löscht Tabellenwerte und Formatierungen.

getCellOrNullObject(rowIndex, columnIndex)

Ruft die Zelle an der angegebenen rowIndexcolumnIndexund ab.

getMergedAreas()

Ruft eine Sammlung von Zellen ab, die die verbundenen Bereiche der Tabelle darstellen.

getShape()

Ruft das Formobjekt für die Tabelle ab.

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(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(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.

mergeCells(rowIndex, columnIndex, rowCount, columnCount)

Erstellt einen verbundenen Bereich beginnend mit der Zelle, die mit rowIndex und columnIndex angegeben wird. Der zusammengeführte Bereich erstreckt sich über eine angegebene Anzahl von Zeilen und Spalten.

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 PowerPoint.Table Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.TableData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

columnCount

Ruft die Anzahl der Spalten in der Tabelle ab.

readonly columnCount: number;

Eigenschaftswert

number

Hinweise

API-Satz: PowerPointApi 1.8

columns

Ruft die Auflistung der Spalten in der Tabelle ab.

readonly columns: PowerPoint.TableColumnCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.9

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

rowCount

Ruft die Anzahl der Zeilen in der Tabelle ab.

readonly rowCount: number;

Eigenschaftswert

number

Hinweise

API-Satz: PowerPointApi 1.8

rows

Ruft die Auflistung der Zeilen in der Tabelle ab.

readonly rows: PowerPoint.TableRowCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.9

styleSettings

Ruft die Einstellungen für das Tabellenformat ab.

readonly styleSettings: PowerPoint.TableStyleSettings;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.9

values

Ruft alle Werte in der Tabelle ab.

readonly values: string[][];

Eigenschaftswert

string[][]

Hinweise

API-Satz: PowerPointApi 1.8

Details zur Methode

clear(options)

Löscht Tabellenwerte und Formatierungen.

clear(options?: PowerPoint.TableClearOptions): void;

Parameter

options
PowerPoint.TableClearOptions

Bietet Optionen zum Löschen der Tabelle.

Gibt zurück

void

Hinweise

API-Satz: PowerPointApi 1.9

getCellOrNullObject(rowIndex, columnIndex)

Ruft die Zelle an der angegebenen rowIndexcolumnIndexund ab.

getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;

Parameter

rowIndex

number

Der Null-basierte Zeilenindex der Zelle.

columnIndex

number

Der nullbasierte Spaltenindex der Zelle.

Gibt zurück

Die Zelle in der angegebenen Zeile und Spalte. Wenn die Zelle Teil eines verbundenen Bereichs und nicht die obere linke Zelle des verbundenen Bereichs ist, wird ein Objekt zurückgegeben, auf das die isNullObject Eigenschaft festgelegt ist true . Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Hinweise

API-Satz: PowerPointApi 1.8

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml

// Updates a table's values.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;

  // Add a table (which is a type of Shape).
  const shape = shapes.addTable(4, 3);
  let table = shape.getTable();
  table.load();
  await context.sync();

  // Update values in the table.
  for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
    for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
      const cell = table.getCellOrNullObject(rowIndex, columnIndex);
      cell.text = generateRandomString();
    }
  }

  await context.sync();
});

getMergedAreas()

Ruft eine Sammlung von Zellen ab, die die verbundenen Bereiche der Tabelle darstellen.

getMergedAreas(): PowerPoint.TableCellCollection;

Gibt zurück

A TableCellCollection mit Zellen, die die verbundenen Bereiche der Tabelle darstellen.

Hinweise

API-Satz: PowerPointApi 1.8

getShape()

Ruft das Formobjekt für die Tabelle ab.

getShape(): PowerPoint.Shape;

Gibt zurück

Hinweise

API-Satz: PowerPointApi 1.8

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?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;

Parameter

options
PowerPoint.Interfaces.TableLoadOptions

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[]): PowerPoint.Table;

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?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Table;

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

mergeCells(rowIndex, columnIndex, rowCount, columnCount)

Erstellt einen verbundenen Bereich beginnend mit der Zelle, die mit rowIndex und columnIndex angegeben wird. Der zusammengeführte Bereich erstreckt sich über eine angegebene Anzahl von Zeilen und Spalten.

mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void;

Parameter

rowIndex

number

Der nullbasierte Zeilenindex der Zelle zum Beginnen des verbundenen Bereichs.

columnIndex

number

Der nullbasierte Spaltenindex der Zelle zum Starten des verbundenen Bereichs.

rowCount

number

Die Anzahl der Zeilen, die mit der Ausgangszelle zusammengeführt werden sollen. Muss größer als 0 sein.

columnCount

number

Die Anzahl der Spalten, die mit der Ausgangszelle zusammengeführt werden sollen. Muss größer als 0 sein.

Gibt zurück

void

Hinweise

API-Satz: PowerPointApi 1.9

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 PowerPoint.Table Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.TableData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): PowerPoint.Interfaces.TableData;

Gibt zurück