OneNote.Table class

Ссылка

Пакет:: onenote

Представляет таблицу на странице OneNote.

Extends: OfficeExtension.ClientObject

Свойства

borderVisible	Задает отображение границ или возвращает сведения об отображении границ. Значение true, если они отображаются, значение false — если нет.
columnCount	Получает количество столбцов в таблице.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Получает идентификатор таблицы.
paragraph	Получает объект Paragraph, содержащий объект Table.
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

columnCount

Получает количество столбцов в таблице.

readonly columnCount: number;

Значение свойства

number

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

OneNote.RequestContext

id

Получает идентификатор таблицы.

readonly id: string;

Значение свойства

string

paragraph

Получает объект Paragraph, содержащий объект Table.

readonly paragraph: OneNote.Paragraph;

Значение свойства

OneNote.Paragraph

rowCount

Получает количество строк в таблице.

readonly rowCount: number;

Значение свойства

number

rows

Возвращает все строки таблицы.

readonly rows: OneNote.TableRowCollection;

Значение свойства

OneNote.TableRowCollection

Сведения о методе

appendColumn(values)

Добавляет столбец в конец таблицы. Значения указываются в новом столбце. В противном случае столбец будет пустым.

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

Параметры

values: string[]

Необязательный параметр. Строки, которые необходимо вставить в новый столбец, заданные в виде массива. Значений в этом параметре не должно быть больше, чем строк в таблице.

Возвращаемое значение

void

Примеры

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[]

Необязательный параметр. Строки, которые необходимо вставить в новую строку, заданные в виде массива. Значений в этом параметре не должно быть больше, чем столбцов в таблице.

Возвращаемое значение

OneNote.TableRow

Примеры

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

getCell(rowIndex, cellIndex)

Возвращает ячейку таблицы в указанной строке и указанном столбце.

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

Параметры

rowIndex: number

Индекс строки.

cellIndex: number

Индекс ячейки в строке.

Возвращаемое значение

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

Примеры

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[]

Возвращаемое значение

OneNote.TableRow

Примеры

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

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

OneNote.Table

load(propertyNames)

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

OneNote.Table

Примеры

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)

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

Параметры

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

OneNote.Table

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

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

Параметры

properties: OneNote.Interfaces.TableUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: OneNote.Table): void;

Параметры

properties: OneNote.Table

Возвращаемое значение

void

setShadingColor(colorCode)

Задает цвет заливки всех ячеек в таблице. Код цвета, который нужно задать ячейкам.

setShadingColor(colorCode: string): void;

Параметры

colorCode: string

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный OneNote.Table объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.TableData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): OneNote.Interfaces.TableData;

Возвращаемое значение

OneNote.Interfaces.TableData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.

track(): OneNote.Table;

Возвращаемое значение

OneNote.Table

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): OneNote.Table;

Возвращаемое значение

OneNote.Table

Поделиться через

OneNote.Table class

Комментарии

Свойства

Методы

Сведения о свойстве

borderVisible

Значение свойства

Комментарии

columnCount

Значение свойства

Комментарии

context

Значение свойства

id

Значение свойства

Комментарии

paragraph

Значение свойства

Комментарии

rowCount

Значение свойства

Комментарии

rows

Значение свойства

Комментарии

Сведения о методе

appendColumn(values)

Параметры

Возвращаемое значение

Комментарии

Примеры

appendRow(values)

Параметры

Возвращаемое значение

Комментарии

Примеры

clear()

Возвращаемое значение

Комментарии

getCell(rowIndex, cellIndex)

Параметры

Возвращаемое значение

Комментарии

Примеры

insertColumn(index, values)

Параметры

Возвращаемое значение

Комментарии

Примеры

insertRow(index, values)

Параметры

Возвращаемое значение

Комментарии

Примеры

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

Примеры

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)

Параметры

Возвращаемое значение

set(properties)

Параметры

Возвращаемое значение

setShadingColor(colorCode)

Параметры

Возвращаемое значение

Комментарии

toJSON()

Возвращаемое значение

track()

Возвращаемое значение

untrack()