OneNote.TableCell class

Gets the index of the cell in its row. Read-only.

readonly cellIndex: number;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Gets the ID of the cell. Read-only.

readonly id: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the collection of Paragraph objects in the TableCell. Read-only.

readonly paragraphs: OneNote.ParagraphCollection;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the parent row of the cell. Read-only.

readonly parentRow: OneNote.TableRow;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the index of the cell's row in the table. Read-only.

readonly rowIndex: number;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets and sets the shading color of the cell

shadingColor: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Adds the specified HTML to the bottom of the TableCell.

appendHtml(html: string): void;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Examples

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

Adds the specified image to table cell.

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

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Adds the specified text to table cell.

appendRichText(paragraphText: string): OneNote.RichText;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Examples

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

Adds a table with the specified number of rows and columns to table cell.

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

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Clears the contents of the cell.

clear(): void;

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: OneNote.Interfaces.TableCellLoadOptions): OneNote.TableCell;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): OneNote.TableCell;

Parameters

Returns

Examples

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

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.TableCell;

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: OneNote.TableCell): void;

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original OneNote.TableCell object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.TableCellData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): OneNote.Interfaces.TableCellData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

track(): OneNote.TableCell;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call context.sync() before the memory release takes effect.

untrack(): OneNote.TableCell;

Returns