Word.TextColumnCollection class
Коллекция Word. Объекты TextColumn, представляющие все столбцы текста в документе или разделе документа.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(options) |
|
| get |
Возвращает направление, в котором текст перемещается из одного текстового столбца в другой. |
| get |
Возвращает значение, указывающее, отображаются ли вертикальные линии между всеми столбцами объекта |
| get |
Возвращает значение, указывающее, имеют ли текстовые столбцы равномерное пространство. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set |
Упорядочивает текст по указанному числу текстовых столбцов. |
| set |
Задает направление, в котором текст перемещается из одного текстового столбца в другой. |
| set |
Задает направление, в котором текст перемещается из одного текстового столбца в другой. |
| set |
Задает, отображаются ли вертикальные линии между всеми столбцами объекта |
| set |
Задает, равномерно ли расставляются текстовые столбцы. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Word.TextColumn[];Значение свойства
Сведения о методе
add(options)
TextColumn Возвращает объект , представляющий новый текстовый столбец, добавленный в раздел или документ.
add(options?: Word.TextColumnAddOptions): Word.TextColumn;Параметры
- options
- Word.TextColumnAddOptions
Необязательный параметр. Параметры для настройки нового текстового столбца.
Возвращаемое значение
Объект TextColumn , представляющий новый текстовый столбец, добавленный в документ.
Комментарии
getFlowDirection()
Возвращает направление, в котором текст перемещается из одного текстового столбца в другой.
getFlowDirection(): OfficeExtension.ClientResult<Word.FlowDirection>;Возвращаемое значение
Комментарии
getHasLineBetween()
Возвращает значение, указывающее, отображаются ли вертикальные линии между всеми столбцами объекта TextColumnCollection .
getHasLineBetween(): OfficeExtension.ClientResult<boolean>;Возвращаемое значение
OfficeExtension.ClientResult<boolean>
Комментарии
getIsEvenlySpaced()
Возвращает значение, указывающее, имеют ли текстовые столбцы равномерное пространство.
getIsEvenlySpaced(): OfficeExtension.ClientResult<boolean>;Возвращаемое значение
OfficeExtension.ClientResult<boolean>
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TextColumnCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TextColumnCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
setCount(numColumns)
Упорядочивает текст по указанному числу текстовых столбцов.
setCount(numColumns: number): void;Параметры
- numColumns
-
number
Количество столбцов, в которые должен быть упорядочен текст.
Возвращаемое значение
void
Комментарии
setFlowDirection(value)
Задает направление, в котором текст перемещается из одного текстового столбца в другой.
setFlowDirection(value: Word.FlowDirection): void;Параметры
- value
- Word.FlowDirection
Заданное направление потока.
Возвращаемое значение
void
Комментарии
setFlowDirection(value)
Задает направление, в котором текст перемещается из одного текстового столбца в другой.
setFlowDirection(value: "LeftToRight" | "RightToLeft"): void;Параметры
- value
-
"LeftToRight" | "RightToLeft"
Заданное направление потока.
Возвращаемое значение
void
Комментарии
setHasLineBetween(value)
Задает, отображаются ли вертикальные линии между всеми столбцами объекта TextColumnCollection .
setHasLineBetween(value: boolean): void;Параметры
- value
-
boolean
true для отображения вертикальных линий между столбцами.
Возвращаемое значение
void
Комментарии
setIsEvenlySpaced(value)
Задает, равномерно ли расставляются текстовые столбцы.
setIsEvenlySpaced(value: boolean): void;Параметры
- value
-
boolean
true , чтобы равномерно распределить все текстовые столбцы в документе.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TextColumnCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.TextColumnCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Word.Interfaces.TextColumnCollectionData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.TextColumnCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.TextColumnCollection;