Word.TableColumnCollection class
Представляет коллекцию Word. TableColumn в документе Word.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(before |
Возвращает объект, |
| auto |
Изменяет ширину столбца таблицы в соответствии с шириной текста без изменения способа обтекания текстом в ячейках. |
| delete() | Удаляет указанные столбцы. |
| distribute |
Изменяет ширину указанных столбцов так, чтобы они были равны. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| select() | Выделение указанных столбцов таблицы. |
| set |
Ширина столбцов в таблице. |
| set |
Ширина столбцов в таблице. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Word.TableColumn[];Значение свойства
Сведения о методе
add(beforeColumn)
Возвращает объект, TableColumn представляющий столбец, добавленный в таблицу.
add(beforeColumn?: Word.TableColumn): Word.TableColumn;Параметры
- beforeColumn
- Word.TableColumn
Необязательный параметр. Столбец, перед которым добавляется новый столбец.
Возвращаемое значение
Новый TableColumn объект.
Комментарии
autoFit()
Изменяет ширину столбца таблицы в соответствии с шириной текста без изменения способа обтекания текстом в ячейках.
autoFit(): void;Возвращаемое значение
void
Комментарии
delete()
Удаляет указанные столбцы.
delete(): void;Возвращаемое значение
void
Комментарии
distributeWidth()
Изменяет ширину указанных столбцов так, чтобы они были равны.
distributeWidth(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableColumnCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableColumnCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
select()
Выделение указанных столбцов таблицы.
select(): void;Возвращаемое значение
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
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableColumnCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.TableColumnCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Word.Interfaces.TableColumnCollectionData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TableColumnCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TableColumnCollection;