Word.TableStyle class

Ссылка

Пакет:: word

Представляет объект TableStyle.

Extends: OfficeExtension.ClientObject

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-custom-style.yaml

// Gets the table style properties and displays them in the form.
const styleName = $("#style-name")
  .val()
  .toString();
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);
  $("#alignment").val(tableStyle.alignment);
  $("#allow-break-across-page").val(tableStyle.allowBreakAcrossPage.toString());
  $("#top-cell-margin").val(tableStyle.topCellMargin);
  $("#bottom-cell-margin").val(tableStyle.bottomCellMargin);
  $("#left-cell-margin").val(tableStyle.leftCellMargin);
  $("#right-cell-margin").val(tableStyle.rightCellMargin);
  $("#cell-spacing").val(tableStyle.cellSpacing);
});

Свойства

bottomCellMargin	Указывает объем пространства, добавляемого между содержимым и нижними границами ячеек.
cellSpacing	Задает интервал (в точках) между ячейками в стиле таблицы.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
leftCellMargin	Указывает объем пространства, добавляемого между содержимым и левыми границами ячеек.
rightCellMargin	Указывает объем пространства, добавляемого между содержимым и правыми границами ячеек.
topCellMargin	Задает объем пространства, добавляемого между содержимым и верхними границами ячеек.

Методы

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` метод переданного ему объекта.) В то время как исходный `Word.TableStyle` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.TableStyleData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

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

bottomCellMargin

Указывает объем пространства, добавляемого между содержимым и нижними границами ячеек.

bottomCellMargin: number;

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

number

cellSpacing

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

cellSpacing: number;

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

number

context

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

context: RequestContext;

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

Word.RequestContext

leftCellMargin

Указывает объем пространства, добавляемого между содержимым и левыми границами ячеек.

leftCellMargin: number;

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

number

rightCellMargin

Указывает объем пространства, добавляемого между содержимым и правыми границами ячеек.

rightCellMargin: number;

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

number

topCellMargin

Задает объем пространства, добавляемого между содержимым и верхними границами ячеек.

topCellMargin: number;

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

number

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

load(options)

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

load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;

Параметры

options: Word.Interfaces.TableStyleLoadOptions

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

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

Word.TableStyle

load(propertyNames)

load(propertyNames?: string | string[]): Word.TableStyle;

Параметры

propertyNames: string | string[]

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

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

Word.TableStyle

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableStyle;

Параметры

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

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

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

Word.TableStyle

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.TableStyleUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

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;

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

Word.Interfaces.TableStyleData

track()

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

track(): Word.TableStyle;

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

Word.TableStyle

untrack()

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

untrack(): Word.TableStyle;

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

Word.TableStyle

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

Word.TableStyle class

Комментарии

Примеры

Свойства

Методы

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

bottomCellMargin

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

Комментарии

cellSpacing

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

Комментарии

context

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

leftCellMargin

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

Комментарии

rightCellMargin

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

Комментарии

topCellMargin

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

Комментарии

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

track()

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

untrack()

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

Обратная связь

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