Word.TableStyle class
Представляет TableStyle объект.
- Extends
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml
// Gets the table style properties and displays them in the form.
const styleName = (document.getElementById("style-name") as HTMLInputElement).value;
if (styleName == "") {
console.warn("Please input a table style name.");
return;
}
await Word.run(async (context) => {
const tableStyle: Word.TableStyle = context.document.getStyles().getByName(styleName).tableStyle;
tableStyle.load();
await context.sync();
if (tableStyle.isNullObject) {
console.warn(`There's no existing table style with the name '${styleName}'.`);
return;
}
console.log(tableStyle);
(document.getElementById("alignment") as HTMLInputElement).value = tableStyle.alignment;
(document.getElementById("allow-break-across-page") as HTMLInputElement).value = tableStyle.allowBreakAcrossPage.toString();
(document.getElementById("top-cell-margin") as HTMLInputElement).value = `${tableStyle.topCellMargin}`;
(document.getElementById("bottom-cell-margin") as HTMLInputElement).value = `${tableStyle.bottomCellMargin}`;
(document.getElementById("left-cell-margin") as HTMLInputElement).value = `${tableStyle.leftCellMargin}`;
(document.getElementById("right-cell-margin") as HTMLInputElement).value = `${tableStyle.rightCellMargin}`;
(document.getElementById("cell-spacing") as HTMLInputElement).value = `${tableStyle.cellSpacing}`;
});
Свойства
| alignment | Выравнивание таблицы относительно поля страницы. |
| allow |
Указывает, перемежаются ли страницы строками таблиц с разрывом стиля. |
| borders | Возвращает значение, |
| bottom |
Определяет интервал между содержимым ячеек и нижними границами. |
| cell |
Определяет интервал (в точках) между ячейками в стиле таблицы. |
| column |
Определяет количество столбцов в чередовании, если стиль задает чередование четных или нечетных столбцов. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| is |
Указывает, разрешает ли Microsoft Word разбивать указанную таблицу на несколько страниц. |
| left |
Определяет интервал между содержимым ячеек и левыми границами ячеек. |
| left |
Значение отступа слева (в пунктах) для строк в стиле таблицы. |
| right |
Определяет интервал между содержимым ячеек и правыми границами ячеек. |
| row |
Количество строк, включаемых в чередование, если стилем предусмотрено чередование по четным или нечетным строкам. |
| shading | Возвращает |
| table |
Указывает, в каком направлении Microsoft Word упорядочивает ячейки в стиле таблицы. |
| top |
Определяет интервал между содержимым ячеек и верхними границами ячеек. |
Методы
| condition(condition |
Возвращает объект, |
| condition(condition |
Возвращает объект, |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
alignment
Выравнивание таблицы относительно поля страницы.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";Значение свойства
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Комментарии
allowBreakAcrossPage
Указывает, перемежаются ли страницы строками таблиц с разрывом стиля.
allowBreakAcrossPage: boolean;Значение свойства
boolean
Комментарии
borders
Возвращает значение, BorderUniversalCollection представляющее все границы таблицы.
readonly borders: Word.BorderUniversalCollection;Значение свойства
Комментарии
bottomCellMargin
Определяет интервал между содержимым ячеек и нижними границами.
bottomCellMargin: number;Значение свойства
number
Комментарии
cellSpacing
Определяет интервал (в точках) между ячейками в стиле таблицы.
cellSpacing: number;Значение свойства
number
Комментарии
columnStripe
Определяет количество столбцов в чередовании, если стиль задает чередование четных или нечетных столбцов.
columnStripe: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
isBreakAcrossPagesAllowed
Указывает, разрешает ли Microsoft Word разбивать указанную таблицу на несколько страниц.
isBreakAcrossPagesAllowed: boolean;Значение свойства
boolean
Комментарии
leftCellMargin
Определяет интервал между содержимым ячеек и левыми границами ячеек.
leftCellMargin: number;Значение свойства
number
Комментарии
leftIndent
Значение отступа слева (в пунктах) для строк в стиле таблицы.
leftIndent: number;Значение свойства
number
Комментарии
rightCellMargin
Определяет интервал между содержимым ячеек и правыми границами ячеек.
rightCellMargin: number;Значение свойства
number
Комментарии
rowStripe
Количество строк, включаемых в чередование, если стилем предусмотрено чередование по четным или нечетным строкам.
rowStripe: number;Значение свойства
number
Комментарии
shading
Возвращает ShadingUniversal объект, который ссылается на форматирование заливки для стиля таблицы.
readonly shading: Word.Shading;Значение свойства
Комментарии
tableDirection
Указывает, в каком направлении Microsoft Word упорядочивает ячейки в стиле таблицы.
tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight";Значение свойства
Word.TableDirection | "RightToLeft" | "LeftToRight"
Комментарии
topCellMargin
Определяет интервал между содержимым ячеек и верхними границами ячеек.
topCellMargin: number;Значение свойства
number
Комментарии
Сведения о методе
condition(conditionCode)
Возвращает объект, ConditionalStyle представляющий особый стиль форматирования для части таблицы.
condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle;Параметры
- conditionCode
- Word.ConditionCode
Область таблицы, к которой требуется применить форматирование.
Возвращаемое значение
Комментарии
condition(conditionCode)
Возвращает объект, ConditionalStyle представляющий особый стиль форматирования для части таблицы.
condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle;Параметры
- conditionCode
-
"FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"
Область таблицы, к которой требуется применить форматирование.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableStyle;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableStyle;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.TableStyleUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Word.TableStyle): void;Параметры
- properties
- Word.TableStyle
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableStyle объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.TableStyleData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Word.Interfaces.TableStyleData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TableStyle;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TableStyle;