OneNote.TableRow class
Представляет строку в таблице.
- Extends
Комментарии
Свойства
| cell |
Получает количество ячеек в строке. Только для чтения. |
| cells | Получает ячейки в строке. Только для чтения. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| id | Получает идентификатор строки. Только для чтения. |
| parent |
Получает родительскую таблицу. Только для чтения. |
| row |
Получает индекс строки в родительской таблице. Только для чтения. |
Методы
| clear() | Очищает содержимое строки. |
| insert |
Вставляет строку перед текущей строкой или после нее. |
| insert |
Вставляет строку перед текущей строкой или после нее. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set |
Задает цвет заливки всех ячеек в строке. Код цвета, который нужно задать ячейкам. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для |
Сведения о свойстве
cellCount
Получает количество ячеек в строке. Только для чтения.
readonly cellCount: number;Значение свойства
number
Комментарии
cells
Получает ячейки в строке. Только для чтения.
readonly cells: OneNote.TableCellCollection;Значение свойства
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
id
Получает идентификатор строки. Только для чтения.
readonly id: string;Значение свойства
string
Комментарии
parentTable
Получает родительскую таблицу. Только для чтения.
readonly parentTable: OneNote.Table;Значение свойства
Комментарии
rowIndex
Получает индекс строки в родительской таблице. Только для чтения.
readonly rowIndex: number;Значение свойства
number
Комментарии
Сведения о методе
clear()
Очищает содержимое строки.
clear(): void;Возвращаемое значение
void
Комментарии
insertRowAsSibling(insertLocation, values)
Вставляет строку перед текущей строкой или после нее.
insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;Параметры
- insertLocation
- OneNote.InsertLocation
Определяет, куда необходимо вставить новые строки относительно текущей строки.
- values
-
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, 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, values)
Вставляет строку перед текущей строкой или после нее.
insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;Параметры
- insertLocationString
-
"Before" | "After"
Определяет, куда необходимо вставить новые строки относительно текущей строки.
- values
-
string[]
Строки, которые необходимо вставить в новую строку, заданные в виде массива. Ячеек в этом параметре не должно быть больше, чем в текущей строке. Необязательный параметр.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: OneNote.Interfaces.TableRowLoadOptions): OneNote.TableRow;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): OneNote.TableRow;Параметры
- 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, 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();
}
}
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.TableRow;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
setShadingColor(colorCode)
Задает цвет заливки всех ячеек в строке. Код цвета, который нужно задать ячейкам.
setShadingColor(colorCode: string): void;Параметры
- colorCode
-
string
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект OneNote.TableRow является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.TableRowData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): OneNote.Interfaces.TableRowData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если этот объект используется в .sync вызовах и вне последовательного выполнения пакета .run, и при установке свойства или вызове метода для объекта возникает ошибка InvalidObjectPath, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
track(): OneNote.TableRow;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): OneNote.TableRow;Возвращаемое значение
Office Add-ins