Partager via


Office.TableData class

Représente les données d’une table ou d’un objet Office.TableBinding.

Constructeurs

(constructor)(rows, headers)

Construit une nouvelle instance de la TableData classe

(constructor)()

Construit une nouvelle instance de la TableData classe

Propriétés

headers

Obtient ou définit les en-têtes du tableau.

rows

Obtient ou définit les lignes dans le tableau. Renvoie un tableau de tableaux qui contient les données du tableau. Retourne un tableau vide s’il n’y a pas de lignes.

Détails du constructeur

(constructor)(rows, headers)

Construit une nouvelle instance de la TableData classe

constructor(rows: any[][], headers: any[]);

Paramètres

rows

any[][]

headers

any[]

(constructor)()

Construit une nouvelle instance de la TableData classe

constructor();

Détails de la propriété

headers

Obtient ou définit les en-têtes du tableau.

headers: any[];

Valeur de propriété

any[]

Remarques

Pour spécifier des en-têtes, vous devez spécifier un tableau de tableaux qui correspond à la structure du tableau. Par exemple, pour spécifier des en-têtes pour une table à deux colonnes, vous devez définir la propriété d’en-tête sur [['header1', 'header2']].

Si vous spécifiez null pour la propriété headers (ou si vous laissez la propriété vide lorsque vous construisez un objet TableData), les résultats suivants se produisent lorsque votre code s’exécute.

  • Si vous insérez un nouveau tableau, les en-têtes de colonnes par défaut du tableau sont créés.

  • Si vous remplacez ou mettez à jour un tableau existant, les en-têtes existants ne sont pas modifiés.

Exemples

// The following example creates a single-column table with a header and three rows.
function createTableData() {
    const tableData = new Office.TableData();
    tableData.headers = [['header1']];
    tableData.rows = [['row1'], ['row2'], ['row3']];
    return tableData;
}

rows

Obtient ou définit les lignes dans le tableau. Renvoie un tableau de tableaux qui contient les données du tableau. Retourne un tableau vide s’il n’y a pas de lignes.

rows: any[][];

Valeur de propriété

any[][]

Remarques

Pour spécifier des lignes, vous devez spécifier un tableau de tableaux qui correspond à la structure du tableau. Par exemple, pour spécifier deux lignes de valeurs de chaîne dans une table à deux colonnes, vous devez définir la propriété rows sur [['a', 'b'], ['c', 'd']].

Si vous spécifiez null pour la propriété rows (ou laissez la propriété vide lorsque vous construisez un objet TableData), les résultats suivants se produisent lorsque votre code s’exécute.

  • Si vous insérez un nouveau tableau, une ligne vide est insérée.

  • Si vous remplacez ou mettez à jour un tableau existant, les lignes existantes ne sont pas modifiées.

Exemples

// The following example creates a single-column table with a header and three rows.
function createTableData() {
    const tableData = new Office.TableData();
    tableData.headers = [['header1']];
    tableData.rows = [['row1'], ['row2'], ['row3']];
    return tableData;
}