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;