Word.TableColumn class
Представляет столбец таблицы в документе Word.
- Extends
Комментарии
Используется
Свойства
| borders | Возвращает объект, |
| column |
Возвращает позицию этого столбца в коллекции. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| is |
Возвращает значение |
| is |
Возвращает значение |
| nesting |
Возвращает уровень вложенности столбца. |
| preferred |
Указывает предпочтительную ширину столбца (в точках или в процентах от ширины окна). Единица измерения может быть задана свойством |
| preferred |
Указывает предпочтительную единицу измерения для ширины столбца таблицы. |
| shading | Возвращает |
| width | Задает ширину столбца в точках. |
Методы
| auto |
Изменяет ширину столбца таблицы в соответствии с шириной текста без изменения способа переноса текста в ячейках. |
| delete() | Удаляет столбец. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| select() | Выделение столбца таблицы. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| set |
Ширина столбца в таблице. |
| set |
Ширина столбца в таблице. |
| sort() | Сортирует столбец таблицы. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
borders
Возвращает объект, BorderUniversalCollection представляющий все границы столбца таблицы.
readonly borders: Word.BorderUniversalCollection;Значение свойства
Комментарии
columnIndex
Возвращает позицию этого столбца в коллекции.
readonly columnIndex: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: 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;Значение свойства
Комментарии
width
Задает ширину столбца в точках.
width: number;Значение свойства
number
Комментарии
Сведения о методе
autoFit()
Изменяет ширину столбца таблицы в соответствии с шириной текста без изменения способа переноса текста в ячейках.
autoFit(): void;Возвращаемое значение
void
Комментарии
delete()
Удаляет столбец.
delete(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableColumn;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableColumn;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
select()
Выделение столбца таблицы.
select(): void;Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.TableColumnUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TableColumn;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TableColumn;