OneNote.TableCell class

表示 OneNote 表中的一个单元格。

注解

使用方

OneNote.Paragraph： parentTableCell， parentTableCellOrNull
OneNote.Table： getCell
OneNote.TableCellCollection： getItem， getItemAt， items

属性

cellIndex	获取单元格行中的单元格索引。
context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
id	获取单元格的 ID。
paragraphs	获取 TableCell 中 Paragraph 对象的集合。
parentRow	获取单元格的父行。
rowIndex	获取表中单元格行的索引。
shadingColor	获取并设置单元格的底纹色。

方法

appendHtml(html)	将指定的 HTML 添加到 TableCell 的底部。
appendImage(base64EncodedImage, width, height)	将指定图像添加到表格单元格中。
appendRichText(paragraphText)	将指定文本添加到表格单元格中。
appendTable(rowCount, columnCount, values)	将带有指定行数和列数的表格添加到表格单元格中。
clear()	清除单元格的内容。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
set(properties, options)	同时设置对象的多个属性。可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties)	基于现有加载的对象，同时在对象上设置多个属性。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `OneNote.TableCell` 对象是 API 对象， `toJSON` 但该方法返回一个纯 JavaScript 对象， (类型化为 `OneNote.Interfaces.TableCellData`) ，其中包含从原始对象加载的任何子属性的浅层副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果在调用中 `.sync` 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。需要在内存释放生效之前调用 `context.sync()` 。

cellIndex

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

readonly cellIndex: number;

属性值

number

注解

API 集：OneNoteApi 1.1

context

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

context: RequestContext;

属性值

OneNote.RequestContext

id

获取单元格的 ID。

readonly id: string;

属性值

string

注解

API 集：OneNoteApi 1.1

paragraphs

获取 TableCell 中 Paragraph 对象的集合。

readonly paragraphs: OneNote.ParagraphCollection;

属性值

OneNote.ParagraphCollection

注解

API 集：OneNoteApi 1.1

parentRow

获取单元格的父行。

readonly parentRow: OneNote.TableRow;

属性值

OneNote.TableRow

注解

API 集：OneNoteApi 1.1

rowIndex

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

readonly rowIndex: number;

属性值

number

注解

API 集：OneNoteApi 1.1

shadingColor

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

shadingColor: string;

属性值

string

注解

API 集：OneNoteApi 1.1

appendHtml(html)

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

appendHtml(html: string): void;

参数

html: string

要追加的 HTML 字符串。请参阅 OneNote 加载项 JavaScript API 支持的 HTML 。

返回

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, width, height)

将指定图像添加到表格单元格中。

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

参数

base64EncodedImage: string

要追加的 HTML 字符串。

width: number

可选。以磅为单位的宽度。默认值为 null，将考虑图像宽度。

height: number

可选。以磅为单位的高度。默认值为 null，将考虑图像高度。

返回

OneNote.Image

注解

API 集：OneNoteApi 1.1

appendRichText(paragraphText)

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

appendRichText(paragraphText: string): OneNote.RichText;

参数

paragraphText: string

要追加的 HTML 字符串。

返回

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, columnCount, values)

将带有指定行数和列数的表格添加到表格单元格中。

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

参数

rowCount: number

必填。表格的行数。

columnCount: number

必填。表格的列数。

values: string[][]

可选的二维数组。如果指定数组中的对应字符串，则填充单元格。

返回

OneNote.Table

注解

API 集：OneNoteApi 1.1

clear()

清除单元格的内容。

clear(): void;

返回

void

注解

API 集：OneNoteApi 1.1

load(options)

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

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

参数

options: OneNote.Interfaces.TableCellLoadOptions

为要加载的对象属性提供选项。

返回

OneNote.TableCell

load(propertyNames)

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

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

参数

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

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

OneNote.TableCell

set(properties, options)

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

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

参数

properties: OneNote.Interfaces.TableCellUpdateData

一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。

options: OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。

返回

void

set(properties)

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

set(properties: OneNote.TableCell): void;

参数

properties: OneNote.TableCell

返回

void

toJSON()

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

toJSON(): OneNote.Interfaces.TableCellData;

返回

OneNote.Interfaces.TableCellData

track()

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

track(): OneNote.TableCell;

返回

OneNote.TableCell

untrack()

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

untrack(): OneNote.TableCell;

返回

OneNote.TableCell

注解

使用方

属性

方法

属性详细信息

cellIndex

属性值

注解

context

属性值

id

属性值

注解

paragraphs

属性值

注解

parentRow

属性值

注解

rowIndex

属性值

注解

shadingColor

属性值

注解

方法详细信息

appendHtml(html)

参数

返回

注解

示例

appendImage(base64EncodedImage, width, height)

参数

返回

注解

appendRichText(paragraphText)

参数

返回

注解

示例

appendTable(rowCount, columnCount, values)

参数

返回

注解

clear()

返回

注解

load(options)

参数

返回

load(propertyNames)

参数

返回

示例

load(propertyNamesAndPaths)

参数

返回

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈