OneNote.TableRow class

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

readonly cellCount: number;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Получает ячейки в строке.

readonly cells: OneNote.TableCellCollection;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

context: RequestContext;

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

Получает идентификатор строки.

readonly id: string;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Получает родительскую таблицу.

readonly parentTable: OneNote.Table;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

readonly rowIndex: number;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Очищает содержимое строки.

clear(): void;

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Вставляет строку перед текущей строкой или после нее.

insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;

Параметры

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

Комментарии

[ Набор 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 table rows.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            
            // Queue a command to load table.rows.
            context.load(table, "rows");
            
            // Run the queued commands.
            await context.sync();

            const rows = table.rows;
            rows.items[1].insertRowAsSibling("Before", ["cell0", "cell1"]);
            await context.sync();
        }
    }
});

Вставляет строку перед текущей строкой или после нее.

insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;

Параметры

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: OneNote.Interfaces.TableRowLoadOptions): OneNote.TableRow;

Параметры

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

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | 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, get table rows.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            
            // Queue a command to load table.rows.
            context.load(table, "rows");
            await context.sync();

            const rows = table.rows;
            
            // For each table row, log cell count and row index.
            for (let i = 0; i < rows.items.length; i++) {
                console.log("Row " + i + " Id: " + rows.items[i].id);
                console.log("Row " + i + " Cell Count: " + rows.items[i].cellCount);
                console.log("Row " + i + " Row Index: " + rows.items[i].rowIndex);
            }
            await context.sync();
        }
    }
});

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

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

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

setShadingColor(colorCode: string): void;

Параметры

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

Комментарии

[ Набор API: OneNoteApi 1.1 ]

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

toJSON(): OneNote.Interfaces.TableRowData;

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

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

track(): OneNote.TableRow;

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

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

untrack(): OneNote.TableRow;

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