Partager via

OneNote.TableRow class

  • Référence
Paquet:
onenote

Représente une ligne dans un tableau.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Propriétés

cellCount

Obtient le nombre de cellules dans la ligne.
cells

Obtient les cellules de la ligne.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
id

Obtient l’ID de la ligne.
parentTable

Obtient le tableau parent.
rowIndex

Obtient l’index de la ligne dans le tableau parent correspondant.

Méthodes

clear()

Efface le contenu de la ligne.
insertRowAsSibling(insertLocation, values)

Insère une ligne avant ou après la ligne active.
insertRowAsSibling(insertLocationString, values)

Insère une ligne avant ou après la ligne active.
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.
setShadingColor(colorCode)

Définit la couleur d’ombrage de toutes les cellules dans la ligne. Code couleur appliqué aux cellules.
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 OneNote.TableRow est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.TableRowDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

cellCount

Obtient le nombre de cellules dans la ligne.

readonly cellCount: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

cells

Obtient les cellules de la ligne.

readonly cells: OneNote.TableCellCollection;

Valeur de propriété

OneNote.TableCellCollection

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

OneNote.RequestContext

id

Obtient l’ID de la ligne.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

parentTable

Obtient le tableau parent.

readonly parentTable: OneNote.Table;

Valeur de propriété

OneNote.Table

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

rowIndex

Obtient l’index de la ligne dans le tableau parent correspondant.

readonly rowIndex: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Détails de la méthode

clear()

Efface le contenu de la ligne.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

insertRowAsSibling(insertLocation, values)

Insère une ligne avant ou après la ligne active.

insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;

Paramètres

insertLocation
OneNote.InsertLocation

Où les nouvelles lignes doivent être insérées par rapport à la ligne active.

values

string[]

Chaînes à insérer dans la nouvelle ligne, spécifiées sous forme de tableau. Elles ne doivent pas comporter plus de cellules que dans la ligne active. Optional.

Retours

OneNote.TableRow

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    
    const paragraphs = outline.paragraphs;
    
    // For each table, get table rows.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            
            // Queue a command to load table.rows.
            context.load(table, "rows");
            
            // Run the queued commands.
            await context.sync();

            const rows = table.rows;
            rows.items[1].insertRowAsSibling("Before", ["cell0", "cell1"]);
            await context.sync();
        }
    }
});

insertRowAsSibling(insertLocationString, values)

Insère une ligne avant ou après la ligne active.

insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;

Paramètres

insertLocationString

"Before" | "After"

Où les nouvelles lignes doivent être insérées par rapport à la ligne active.

values

string[]

Chaînes à insérer dans la nouvelle ligne, spécifiées sous forme de tableau. Elles ne doivent pas comporter plus de cellules que dans la ligne active. Optional.

Retours

OneNote.TableRow

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

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?: OneNote.Interfaces.TableRowLoadOptions): OneNote.TableRow;

Paramètres

options
OneNote.Interfaces.TableRowLoadOptions

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

Retours

OneNote.TableRow

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[]): OneNote.TableRow;

Paramètres

propertyNames

string | string[]

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

Retours

OneNote.TableRow

Exemples

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    
    const paragraphs = outline.paragraphs;
    
    // For each table, get table rows.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            
            // Queue a command to load table.rows.
            context.load(table, "rows");
            await context.sync();

            const rows = table.rows;
            
            // For each table row, log cell count and row index.
            for (let i = 0; i < rows.items.length; i++) {
                console.log("Row " + i + " Id: " + rows.items[i].id);
                console.log("Row " + i + " Cell Count: " + rows.items[i].cellCount);
                console.log("Row " + i + " Row Index: " + rows.items[i].rowIndex);
            }
            await context.sync();
        }
    }
});

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;
        }): OneNote.TableRow;

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

OneNote.TableRow

setShadingColor(colorCode)

Définit la couleur d’ombrage de toutes les cellules dans la ligne. Code couleur appliqué aux cellules.

setShadingColor(colorCode: string): void;

Paramètres

colorCode

string

Retours

void

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

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 OneNote.TableRow est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.TableRowDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): OneNote.Interfaces.TableRowData;

Retours

OneNote.Interfaces.TableRowData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet.

track(): OneNote.TableRow;

Retours

OneNote.TableRow

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): OneNote.TableRow;

Retours

OneNote.TableRow