OneNote.Table class

表示 OneNote 页中的表格。

扩展

属性

borderVisible

获取或设置边框是否可见。 如果为 true,则边框可见,如果为 false,则隐藏边框。

columnCount

获取表中的列数。

context

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

id

获取表格的 ID。

paragraph

获取包含“表格”对象的“段落”对象。

rowCount

获取表格中的行数。

rows

获取所有表格行。

方法

appendColumn(values)

将列添加至表格结尾。 指定的值在新列中设置。 否则该列为空。

appendRow(values)

将行添加至表格结尾。 指定的值在新行中设置。 否则该行为空。

clear()

清除表内容。

getCell(rowIndex, cellIndex)

获取指定行和列处的表单元格。

insertColumn(index, values)

在表中给定索引处插入一列。 指定的值在新列中设置。 否则该列为空。

insertRow(index, values)

在表中给定索引处插入一行。 指定的值在新行中设置。 否则该行为空。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

setShadingColor(colorCode)

设置表格中所有单元格的底纹色。 要为单元格设置的颜色代码。

toJSON()

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

track()

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

untrack()

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

属性详细信息

borderVisible

获取或设置边框是否可见。 如果为 true,则边框可见,如果为 false,则隐藏边框。

borderVisible: boolean;

属性值

boolean

注解

API 集:OneNoteApi 1.1

columnCount

获取表中的列数。

readonly columnCount: number;

属性值

number

注解

API 集:OneNoteApi 1.1

context

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

context: RequestContext;

属性值

id

获取表格的 ID。

readonly id: string;

属性值

string

注解

API 集:OneNoteApi 1.1

paragraph

获取包含“表格”对象的“段落”对象。

readonly paragraph: OneNote.Paragraph;

属性值

注解

API 集:OneNoteApi 1.1

rowCount

获取表格中的行数。

readonly rowCount: number;

属性值

number

注解

API 集:OneNoteApi 1.1

rows

获取所有表格行。

readonly rows: OneNote.TableRowCollection;

属性值

注解

API 集:OneNoteApi 1.1

方法详细信息

appendColumn(values)

将列添加至表格结尾。 指定的值在新列中设置。 否则该列为空。

appendColumn(values?: string[]): void;

参数

values

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, append a column.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            table.appendColumn(["cell0", "cell1"]);
        }
    }
    await context.sync();
});

appendRow(values)

将行添加至表格结尾。 指定的值在新行中设置。 否则该行为空。

appendRow(values?: string[]): OneNote.TableRow;

参数

values

string[]

可选。 在新行中插入的字符串,指定为数组。 表中的值不能多于列。

返回

注解

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, append a column.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const row = table.appendRow(["cell0", "cell1"]);
        }
    }
    await context.sync();
});

clear()

清除表内容。

clear(): void;

返回

void

注解

API 集:OneNoteApi 1.1

getCell(rowIndex, cellIndex)

获取指定行和列处的表单元格。

getCell(rowIndex: number, cellIndex: number): OneNote.TableCell;

参数

rowIndex

number

行的索引。

cellIndex

number

行中单元格的索引。

返回

注解

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 cell in the second row and third column.
    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(2 /*Row Index*/, 3 /*Column Index*/);
        }
    }
    await context.sync();
});

insertColumn(index, values)

在表中给定索引处插入一列。 指定的值在新列中设置。 否则该列为空。

insertColumn(index: number, values?: string[]): void;

参数

index

number

表格中插入列位置的索引。

values

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, insert a column at index two.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            table.insertColumn(2, ["cell0", "cell1"]);
        }
    }
    await context.sync();
});

insertRow(index, values)

在表中给定索引处插入一行。 指定的值在新行中设置。 否则该行为空。

insertRow(index: number, values?: string[]): OneNote.TableRow;

参数

index

number

表格中插入行位置的索引。

values

string[]

可选。 在新行中插入的字符串,指定为数组。 表中的值不能多于列。

返回

注解

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, insert a row at index two.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const row = table.insertRow(2, ["cell0", "cell1"]);
        }
    }
    await context.sync();
});

load(options)

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

load(options?: OneNote.Interfaces.TableLoadOptions): OneNote.Table;

参数

options
OneNote.Interfaces.TableLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

示例

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/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const paragraphs = outline.paragraphs;
    
    // For each table, log properties.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            context.load(table);
            await context.sync();

            console.log("Table Id: " + table.id);
            console.log("Row Count: " + table.rowCount);
            console.log("Column Count: " + table.columnCount);
            await context.sync();
        }
    }
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

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

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

参数

properties
OneNote.Interfaces.TableUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: OneNote.Table): void;

参数

properties
OneNote.Table

返回

void

setShadingColor(colorCode)

设置表格中所有单元格的底纹色。 要为单元格设置的颜色代码。

setShadingColor(colorCode: string): void;

参数

colorCode

string

返回

void

注解

API 集:OneNoteApi 1.1

toJSON()

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

toJSON(): OneNote.Interfaces.TableData;

返回

track()

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

track(): OneNote.Table;

返回

untrack()

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

untrack(): OneNote.Table;

返回