Partager via

OneNote.TableCell class

  • Référence
Paquet:
onenote

Représente une cellule dans un tableau OneNote.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Propriétés

cellIndex

Obtient l’index de la cellule dans la ligne correspondante.
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 cellule.
paragraphs

Obtient la collection d’objets Paragraph dans TableCell.
parentRow

Obtient la ligne parent de la cellule.
rowIndex

Obtient l’index de la ligne de la cellule dans le tableau.
shadingColor

Obtient et définit la couleur de trame de la cellule.

Méthodes

appendHtml(html)

Ajoute le code HTML spécifié dans TableCell.
appendImage(base64EncodedImage, width, height)

Ajoute l’image spécifiée à la cellule du tableau.
appendRichText(paragraphText)

Ajoute le texte spécifié à la cellule du tableau.
appendTable(rowCount, columnCount, values)

Ajoute un tableau avec le nombre spécifié de lignes et de colonnes dans une cellule du tableau.
clear()

Efface le contenu de la cellule.
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.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
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.TableCell est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.TableCellDataque ) 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é

cellIndex

Obtient l’index de la cellule dans la ligne correspondante.

readonly cellIndex: number;

Valeur de propriété

number

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

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

paragraphs

Obtient la collection d’objets Paragraph dans TableCell.

readonly paragraphs: OneNote.ParagraphCollection;

Valeur de propriété

OneNote.ParagraphCollection

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

parentRow

Obtient la ligne parent de la cellule.

readonly parentRow: OneNote.TableRow;

Valeur de propriété

OneNote.TableRow

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

rowIndex

Obtient l’index de la ligne de la cellule dans le tableau.

readonly rowIndex: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

shadingColor

Obtient et définit la couleur de trame de la cellule.

shadingColor: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Détails de la méthode

appendHtml(html)

Ajoute le code HTML spécifié dans TableCell.

appendHtml(html: string): void;

Paramètres

html

string

Chaîne HTML à ajouter. Consultez HTML pris en charge pour l’API JavaScript des compléments OneNote.

Retours

void

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 a table cell at row one and column two and add "Hello".
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            cell.appendHtml("<p>Hello</p>");
        }
    }
    await context.sync();
});

appendImage(base64EncodedImage, width, height)

Ajoute l’image spécifiée à la cellule du tableau.

appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;

Paramètres

base64EncodedImage

string

Chaîne HTML à ajouter.

width

number

Optional. Largeur de l’unité des points. La valeur par défaut est Null et la largeur d’image est respectée.

height

number

Optional. Hauteur de l’unité des points. La valeur par défaut est Null et la hauteur d’image est respectée.

Retours

OneNote.Image

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

appendRichText(paragraphText)

Ajoute le texte spécifié à la cellule du tableau.

appendRichText(paragraphText: string): OneNote.RichText;

Paramètres

paragraphText

string

Chaîne HTML à ajouter.

Retours

OneNote.RichText

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    const appendedRichText = null;
    
    // 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 a table cell at row one and column two and add "Hello".
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            appendedRichText = cell.appendRichText("Hello");
        }
    }
    await context.sync();
});

appendTable(rowCount, columnCount, values)

Ajoute un tableau avec le nombre spécifié de lignes et de colonnes dans une cellule du tableau.

appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Paramètres

rowCount

number

Obligatoire. Nombre de lignes dans le tableau.

columnCount

number

Obligatoire. Nombre de colonnes dans le tableau.

values

string[][]

Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.

Retours

OneNote.Table

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

clear()

Efface le contenu de la cellule.

clear(): void;

Retours

void

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.TableCellLoadOptions): OneNote.TableCell;

Paramètres

options
OneNote.Interfaces.TableCellLoadOptions

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

Retours

OneNote.TableCell

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.TableCell;

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

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 a table cell at row one and column two.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            
            // Queue a command to load the table cell.
            context.load(cell);
            await context.sync();

            console.log("Cell Id: " + cell.id);
            console.log("Cell Index: " + cell.cellIndex);
            console.log("Cell's Row Index: " + cell.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.TableCell;

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

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
OneNote.Interfaces.TableCellUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: OneNote.TableCell): void;

Paramètres

properties
OneNote.TableCell

Retours

void

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

toJSON(): OneNote.Interfaces.TableCellData;

Retours

OneNote.Interfaces.TableCellData

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.TableCell;

Retours

OneNote.TableCell

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.TableCell;

Retours

OneNote.TableCell