Word.TableColumn class

Пакет:: word

Представляет столбец таблицы в документе Word.

Extends: OfficeExtension.ClientObject

Свойства

borders	`BorderUniversalCollection` Возвращает объект , представляющий все границы столбца таблицы.
columnIndex	Возвращает позицию этого столбца в коллекции.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
isFirst	Возвращает значение `true` , если столбец или строка являются первым в таблице; `false` в противном случае .
isLast	Возвращает значение `true` , если столбец или строка являются последним в таблице; `false` в противном случае .
nestingLevel	Возвращает уровень вложенности столбца.
preferredWidth	Задает предпочтительную ширину (в точках или в процентах от ширины окна) для столбца. Единицу измерения можно указать с помощью `preferredWidthType` свойства .
preferredWidthType	Задает предпочтительную единицу измерения, используемую для ширины столбца таблицы.
shading	`ShadingUniversal` Возвращает объект, ссылающийся на форматирование затенения для столбца.
width	Задает ширину столбца в точках.

Методы

autoFit()	Изменяет ширину столбца таблицы в соответствии с шириной текста, не изменяя способ переноса текста в ячейки.
delete()	Удаляет столбец.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
select()	Выбирает столбец таблицы.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setWidth(columnWidth, rulerStyle)	Задает ширину столбца в таблице.
setWidth(columnWidth, rulerStyle)	Задает ширину столбца в таблице.
sort()	Сортирует столбец таблицы.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.TableColumn` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.TableColumnData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

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

borders

BorderUniversalCollection Возвращает объект , представляющий все границы столбца таблицы.

readonly borders: Word.BorderUniversalCollection;

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

Word.BorderUniversalCollection

columnIndex

Возвращает позицию этого столбца в коллекции.

readonly columnIndex: number;

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

number

context

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

context: RequestContext;

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

Word.RequestContext

isFirst

Возвращает значение true , если столбец или строка являются первым в таблице; false в противном случае .

readonly isFirst: boolean;

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

boolean

isLast

Возвращает значение true , если столбец или строка являются последним в таблице; false в противном случае .

readonly isLast: boolean;

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

boolean

nestingLevel

Возвращает уровень вложенности столбца.

readonly nestingLevel: number;

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

number

preferredWidth

Задает предпочтительную ширину (в точках или в процентах от ширины окна) для столбца. Единицу измерения можно указать с помощью preferredWidthType свойства .

preferredWidth: number;

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

number

preferredWidthType

Задает предпочтительную единицу измерения, используемую для ширины столбца таблицы.

preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";

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

Word.PreferredWidthType | "Auto" | "Percent" | "Points"

shading

ShadingUniversal Возвращает объект, ссылающийся на форматирование затенения для столбца.

readonly shading: Word.ShadingUniversal;

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

Word.ShadingUniversal

width

Задает ширину столбца в точках.

width: number;

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

number

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

autoFit()

Изменяет ширину столбца таблицы в соответствии с шириной текста, не изменяя способ переноса текста в ячейки.

autoFit(): void;

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

void

delete()

Удаляет столбец.

delete(): void;

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

void

load(options)

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

load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn;

Параметры

options: Word.Interfaces.TableColumnLoadOptions

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

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

Word.TableColumn

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.TableColumn

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Word.TableColumn

select()

Выбирает столбец таблицы.

select(): void;

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

void

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.TableColumnUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.TableColumn): void;

Параметры

properties: Word.TableColumn

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

void

setWidth(columnWidth, rulerStyle)

Задает ширину столбца в таблице.

setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;

Параметры

columnWidth: number

Заданная ширина.

rulerStyle: Word.RulerStyle

Применяемый стиль линейки.

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

void

setWidth(columnWidth, rulerStyle)

Задает ширину столбца в таблице.

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Параметры

columnWidth: number

Заданная ширина.

rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"

Применяемый стиль линейки.

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

void

sort()

Сортирует столбец таблицы.

sort(): void;

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

void

toJSON()

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

toJSON(): Word.Interfaces.TableColumnData;

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

Word.Interfaces.TableColumnData

track()

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

track(): Word.TableColumn;

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

Word.TableColumn

untrack()

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

untrack(): Word.TableColumn;

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

Word.TableColumn

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

Были ли сведения на этой странице полезными?

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

Word.TableColumn class

Комментарии

Свойства

Методы

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

borders

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

Комментарии

columnIndex

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

Комментарии

context

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

isFirst

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

Комментарии

isLast

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

Комментарии

nestingLevel

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

Комментарии

preferredWidth

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

Комментарии

preferredWidthType

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

Комментарии

shading

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

Комментарии

width

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

Комментарии

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

autoFit()

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

Комментарии

delete()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

select()

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

Комментарии

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setWidth(columnWidth, rulerStyle)

Параметры

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

Комментарии

setWidth(columnWidth, rulerStyle)

Параметры

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

Комментарии

sort()

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

Комментарии

toJSON()

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

track()

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

untrack()

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

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