PowerPoint.Table class

Représente un tableau.

Extends

Remarques

Jeu d’API : PowerPointApi 1.8

Utilisateur

Exemples

// 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();
});

Propriétés

columnCount

Obtient le nombre de colonnes dans le tableau.

columns

Obtient la collection de colonnes de la table.

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

rowCount

Obtient le nombre de lignes dans le tableau.

rows

Obtient l’ensemble des lignes de la table.

styleSettings

Obtient les paramètres de style de tableau.

values

Obtient toutes les valeurs de la table.

Méthodes

clear(options)

Efface les valeurs et la mise en forme des tableaux.

getCellOrNullObject(rowIndex, columnIndex)

Obtient la cellule à la valeur spécifiée rowIndex et columnIndex.

getMergedAreas()

Obtient une collection de cellules qui représentent les zones fusionnées du tableau.

getShape()

Obtient l’objet forme de la table.

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

mergeCells(rowIndex, columnIndex, rowCount, columnCount)

Crée une zone fusionnée à partir de la cellule spécifiée par rowIndex et columnIndex. La zone fusionnée s’étend sur un nombre spécifié de lignes et de colonnes.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.Table est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.TableDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

columnCount

Obtient le nombre de colonnes dans le tableau.

readonly columnCount: number;

Valeur de propriété

number

Remarques

Jeu d’API : PowerPointApi 1.8

columns

Obtient la collection de colonnes de la table.

readonly columns: PowerPoint.TableColumnCollection;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.9

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

rowCount

Obtient le nombre de lignes dans le tableau.

readonly rowCount: number;

Valeur de propriété

number

Remarques

Jeu d’API : PowerPointApi 1.8

rows

Obtient l’ensemble des lignes de la table.

readonly rows: PowerPoint.TableRowCollection;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.9

styleSettings

Obtient les paramètres de style de tableau.

readonly styleSettings: PowerPoint.TableStyleSettings;

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.9

values

Obtient toutes les valeurs de la table.

readonly values: string[][];

Valeur de propriété

string[][]

Remarques

Jeu d’API : PowerPointApi 1.8

Détails de la méthode

clear(options)

Efface les valeurs et la mise en forme des tableaux.

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

Paramètres

options
PowerPoint.TableClearOptions

Fournit des options pour effacer la table.

Retours

void

Remarques

Jeu d’API : PowerPointApi 1.9

getCellOrNullObject(rowIndex, columnIndex)

Obtient la cellule à la valeur spécifiée rowIndex et columnIndex.

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

Paramètres

rowIndex

number

Index de ligne de base zéro de la cellule.

columnIndex

number

Index de colonne en base zéro de la cellule.

Retours

Cellule à la ligne et à la colonne spécifiées. Si la cellule fait partie d’une zone fusionnée et non de la cellule supérieure gauche de la zone fusionnée, un objet avec la isNullObject propriété définie sur true est renvoyé. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

Remarques

Jeu d’API : PowerPointApi 1.8

Exemples

// 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()

Obtient une collection de cellules qui représentent les zones fusionnées du tableau.

getMergedAreas(): PowerPoint.TableCellCollection;

Retours

a avec des TableCellCollection cellules qui représentent les zones fusionnées du tableau.

Remarques

Jeu d’API : PowerPointApi 1.8

getShape()

Obtient l’objet forme de la table.

getShape(): PowerPoint.Shape;

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;

Paramètres

options
PowerPoint.Interfaces.TableLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): PowerPoint.Table;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Table;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

mergeCells(rowIndex, columnIndex, rowCount, columnCount)

Crée une zone fusionnée à partir de la cellule spécifiée par rowIndex et columnIndex. La zone fusionnée s’étend sur un nombre spécifié de lignes et de colonnes.

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

Paramètres

rowIndex

number

Index de ligne en base zéro de la cellule pour commencer la zone de fusion.

columnIndex

number

Index de colonne en base zéro de la cellule pour commencer la zone fusionnée.

rowCount

number

Nombre de lignes à fusionner avec la cellule de départ. Doit être supérieur à 0.

columnCount

number

Nombre de colonnes à fusionner avec la cellule de départ. Doit être supérieur à 0.

Retours

void

Remarques

Jeu d’API : PowerPointApi 1.9

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.Table est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.TableDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.TableData;

Retours