OneNote.TableCell class

获取单元格行中的单元格索引。

readonly cellIndex: number;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

获取单元格的 ID。

readonly id: string;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取 TableCell 中 Paragraph 对象的集合。

readonly paragraphs: OneNote.ParagraphCollection;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取单元格的父行。

readonly parentRow: OneNote.TableRow;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取表中单元格行的索引。

readonly rowIndex: number;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

获取并设置单元格的底纹色。

shadingColor: string;

属性值

注解

[ API 集：OneNoteApi 1.1 ]

将指定的 HTML 添加到 TableCell 的底部。

appendHtml(html: string): void;

参数

返回

注解

[ API 集：OneNoteApi 1.1 ]

示例

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: string, width: number, height: number): OneNote.Image;

参数

返回

注解

[ API 集：OneNoteApi 1.1 ]

将指定文本添加到表格单元格中。

appendRichText(paragraphText: string): OneNote.RichText;

参数

返回

注解

[ API 集：OneNoteApi 1.1 ]

示例

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: number, columnCount: number, values?: string[][]): OneNote.Table;

参数

返回

注解

[ API 集：OneNoteApi 1.1 ]

清除单元格的内容。

clear(): void;

返回

注解

[ API 集：OneNoteApi 1.1 ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

示例

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

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: OneNote.TableCell): void;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始OneNote.TableCell对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 OneNote.Interfaces.TableCellData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): OneNote.Interfaces.TableCellData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。

track(): OneNote.TableCell;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): OneNote.TableCell;

返回