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;