OneNote.TableCell class

Ссылка

Пакет:: onenote

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

Extends: OfficeExtension.ClientObject

Свойства

cellIndex	Получает индекс ячейки в строке. Только для чтения.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Получает идентификатор ячейки. Только для чтения.
paragraphs	Получает коллекцию объектов Paragraph в объекте TableCell. Только для чтения.
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

context

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

context: RequestContext;

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

OneNote.RequestContext

id

Получает идентификатор ячейки. Только для чтения.

readonly id: string;

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

string

paragraphs

Получает коллекцию объектов Paragraph в объекте TableCell. Только для чтения.

readonly paragraphs: OneNote.ParagraphCollection;

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

OneNote.ParagraphCollection

parentRow

Получает родительскую строку ячейки. Только для чтения.

readonly parentRow: OneNote.TableRow;

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

OneNote.TableRow

rowIndex

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

readonly rowIndex: number;

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

number

shadingColor

Возвращает и задает цвет заливки ячейки

shadingColor: string;

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

string

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

appendHtml(html)

Добавляет указанную строку HTML в нижнюю часть объекта TableCell.

appendHtml(html: string): void;

Параметры

html: string

Строка HTML, которую необходимо добавить. См. раздел Поддерживаемый HTML для API JavaScript надстроек OneNote.

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

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

appendRichText(paragraphText)

Добавляет указанный текст в ячейку таблицы.

appendRichText(paragraphText: string): OneNote.RichText;

Параметры

paragraphText: string

Строка HTML, которую необходимо добавить.

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

OneNote.RichText

Примеры

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

clear()

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

clear(): void;

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

void

load(options)

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

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

Параметры

options: OneNote.Interfaces.TableCellLoadOptions

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

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

OneNote.TableCell

load(propertyNames)

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)

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

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

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

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

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

OneNote.TableCell class

Комментарии

Свойства

Методы

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

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

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

Дополнительные ресурсы