Objet TableRowCollection (interface API JavaScript pour Excel)

Office and SharePoint Add-ins

La dernière version de ce complément Office est disponible dans le référentiel GitHub des compléments.


S’applique à : Excel 2016, Excel Online, Office 2016

Représente une collection de toutes les lignes du tableau.

PropriétéTypeDescription
countintRenvoie le nombre de lignes du tableau. En lecture seule.
ItemsTableRow[]Collection d’objets tableRow. En lecture seule.

Voir des exemples d’accès aux propriétés.

Aucun

MéthodeType renvoyéDescription
add(index: number, values: (boolean ou string ou number)[][])TableRowAjoute une nouvelle ligne au tableau.
getItemAt(index: number)TableRowObtient une ligne en fonction de sa position dans la collection.
load(param: object)voidRemplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

Ajoute une nouvelle ligne au tableau.

Syntaxe

jstableRowCollectionObject.add(index, values);

Paramètres

ParamètreTypeDescription
indexnumberFacultatif. Spécifie la position relative de la nouvelle ligne. Si la valeur est null, la ligne est ajoutée à la fin. Toutes les lignes en dessous de la ligne insérée sont déplacées vers le bas. Avec indice zéro.
values(boolean ou string ou number)[][]Facultatif. Matrice 2D des valeurs non mises en forme de la ligne du tableau.

Renvoie

TableRow

Exemples


Excel.run(function (ctx) { 
    var tables = ctx.workbook.tables;
    var values = [["Sample", "Values", "For", "New", "Row"]];
    var row = tables.getItem("Table1").rows.add(null, values);
    row.load('index');
    return ctx.sync().then(function() {
        console.log(row.index);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Obtient une ligne en fonction de sa position dans la collection.

Syntaxe

jstableRowCollectionObject.getItemAt(index);

Paramètres

ParamètreTypeDescription
indexnumberValeur d’indice de l’objet à récupérer. Avec indice zéro.

Renvoie

TableRow

Exemples


Excel.run(function (ctx) { 
    var tablerow = ctx.workbook.tables.getItem('Table1').rows.getItemAt(0);
    tablerow.load('name');
    return ctx.sync().then(function() {
            console.log(tablerow.name);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Remplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

Syntaxe

jsobject.load(param);

Paramètres

ParamètreTypeDescription
paramobjectFacultatif. Accepte les noms de paramètre et de relation sous forme de chaîne délimitée ou de tableau. Sinon, indiquez l’objet loadOption.

Renvoie

void


Excel.run(function (ctx) { 
    var tablerows = ctx.workbook.tables.getItem('Table1').rows;
    tablerows.load('items');
    return ctx.sync().then(function() {
        console.log("tablerows Count: " + tablerows.count);
        for (var i = 0; i < tablerows.items.length; i++)
        {
            console.log(tablerows.items[i].index);
        }
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Afficher: