Word.RepeatingSectionContentControl class

Пакет:: word

Представляет RepeatingSectionContentControl объект .

Extends: OfficeExtension.ClientObject

Свойства

allowInsertDeleteSection	Указывает, могут ли пользователи добавлять или удалять разделы из этого элемента управления содержимым повторяющихся разделов с помощью пользовательского интерфейса.
appearance	Указывает внешний вид элемента управления содержимым.
color	Задает значение цвета элемента управления содержимым в формате RGB. Можно указать значение в формате "#RRGGBB".
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Возвращает идентификацию элемента управления содержимым.
isTemporary	Указывает, следует ли удалять элемент управления содержимым из активного документа, когда пользователь изменяет содержимое элемента управления.
level	Возвращает уровень элемента управления содержимым— независимо от того, окружает ли элемент управления содержимым текст, абзацы, ячейки таблицы или строки таблицы; или, если он является встроенным.
lockContentControl	Указывает, заблокирован ли элемент управления содержимым (его невозможно удалить). `true` означает, что пользователь не может удалить его из активного документа, `false` то есть его можно удалить.
lockContents	Указывает, заблокировано ли содержимое элемента управления содержимым (невозможно изменить). `true` означает, что пользователь не может изменить содержимое, означает, `false` что содержимое является редактируемым.
placeholderText	`BuildingBlock` Возвращает объект , представляющий текст заполнителя для элемента управления содержимым.
range	`Range` Возвращает объект , представляющий содержимое элемента управления содержимым в активном документе.
repeatingSectionItems	Возвращает коллекцию повторяющихся элементов раздела в этом элементе управления содержимым повторяющегося раздела.
repeatingSectionItemTitle	Указывает имя повторяющихся элементов раздела, используемых в контекстном меню, связанном с этим элементом управления содержимым повторяющегося раздела.
showingPlaceholderText	Возвращает значение, указывающее, отображается ли замещающий текст для элемента управления содержимым.
tag	Указывает тег для идентификации элемента управления содержимым.
title	Задает заголовок элемента управления содержимым.
xmlMapping	`XmlMapping` Возвращает объект , представляющий сопоставление элемента управления содержимым с XML-данными в хранилище данных документа.

Методы

copy()	Копирует элемент управления содержимым из активного документа в буфер обмена.
cut()	Удаляет элемент управления содержимым из активного документа и перемещает его в буфер обмена.
delete(deleteContents)	Удаляет элемент управления содержимым и содержимое элемента управления содержимым.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setPlaceholderText(options)	Задает текст-заполнитель, который отображается в элементе управления содержимым до тех пор, пока пользователь не введет свой собственный текст.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.RepeatingSectionContentControl` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.RepeatingSectionContentControlData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

Сведения о свойстве

allowInsertDeleteSection

Указывает, могут ли пользователи добавлять или удалять разделы из этого элемента управления содержимым повторяющихся разделов с помощью пользовательского интерфейса.

allowInsertDeleteSection: boolean;

Значение свойства

boolean

appearance

Указывает внешний вид элемента управления содержимым.

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

Значение свойства

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

color

Задает значение цвета элемента управления содержимым в формате RGB. Можно указать значение в формате "#RRGGBB".

color: string;

Значение свойства

string

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

id

Возвращает идентификацию элемента управления содержимым.

readonly id: string;

Значение свойства

string

isTemporary

Указывает, следует ли удалять элемент управления содержимым из активного документа, когда пользователь изменяет содержимое элемента управления.

isTemporary: boolean;

Значение свойства

boolean

level

Возвращает уровень элемента управления содержимым— независимо от того, окружает ли элемент управления содержимым текст, абзацы, ячейки таблицы или строки таблицы; или, если он является встроенным.

readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";

Значение свойства

Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"

lockContentControl

Указывает, заблокирован ли элемент управления содержимым (его невозможно удалить). true означает, что пользователь не может удалить его из активного документа, false то есть его можно удалить.

lockContentControl: boolean;

Значение свойства

boolean

lockContents

Указывает, заблокировано ли содержимое элемента управления содержимым (невозможно изменить). true означает, что пользователь не может изменить содержимое, означает, false что содержимое является редактируемым.

lockContents: boolean;

Значение свойства

boolean

placeholderText

BuildingBlock Возвращает объект , представляющий текст заполнителя для элемента управления содержимым.

readonly placeholderText: Word.BuildingBlock;

Значение свойства

Word.BuildingBlock

range

Range Возвращает объект , представляющий содержимое элемента управления содержимым в активном документе.

readonly range: Word.Range;

Значение свойства

Word.Range

repeatingSectionItems

Возвращает коллекцию повторяющихся элементов раздела в этом элементе управления содержимым повторяющегося раздела.

readonly repeatingSectionItems: Word.RepeatingSectionItemCollection;

Значение свойства

Word.RepeatingSectionItemCollection

repeatingSectionItemTitle

Указывает имя повторяющихся элементов раздела, используемых в контекстном меню, связанном с этим элементом управления содержимым повторяющегося раздела.

repeatingSectionItemTitle: string;

Значение свойства

string

showingPlaceholderText

Возвращает значение, указывающее, отображается ли замещающий текст для элемента управления содержимым.

readonly showingPlaceholderText: boolean;

Значение свойства

boolean

tag

Указывает тег для идентификации элемента управления содержимым.

tag: string;

Значение свойства

string

title

Задает заголовок элемента управления содержимым.

title: string;

Значение свойства

string

xmlMapping

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

XmlMapping Возвращает объект , представляющий сопоставление элемента управления содержимым с XML-данными в хранилище данных документа.

readonly xmlMapping: Word.XmlMapping;

Значение свойства

Word.XmlMapping

Сведения о методе

copy()

Копирует элемент управления содержимым из активного документа в буфер обмена.

copy(): void;

Возвращаемое значение

void

cut()

Удаляет элемент управления содержимым из активного документа и перемещает его в буфер обмена.

cut(): void;

Возвращаемое значение

void

delete(deleteContents)

Удаляет элемент управления содержимым и содержимое элемента управления содержимым.

delete(deleteContents?: boolean): void;

Параметры

deleteContents: boolean

Необязательный параметр. Удаляется ли содержимое внутри элемента управления.

Возвращаемое значение

void

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl;

Параметры

options: Word.Interfaces.RepeatingSectionContentControlLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Word.RepeatingSectionContentControl

load(propertyNames)

load(propertyNames?: string | string[]): Word.RepeatingSectionContentControl;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Word.RepeatingSectionContentControl

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.RepeatingSectionContentControl;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Word.RepeatingSectionContentControl

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.RepeatingSectionContentControlUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.RepeatingSectionContentControl): void;

Параметры

properties: Word.RepeatingSectionContentControl

Возвращаемое значение

void

setPlaceholderText(options)

Задает текст-заполнитель, который отображается в элементе управления содержимым до тех пор, пока пользователь не введет свой собственный текст.

setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;

Параметры

options: Word.ContentControlPlaceholderOptions

Необязательный параметр. Параметры для настройки замещающего текста элемента управления содержимым.

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.RepeatingSectionContentControl объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.RepeatingSectionContentControlData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.RepeatingSectionContentControlData;

Возвращаемое значение

Word.Interfaces.RepeatingSectionContentControlData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.RepeatingSectionContentControl;

Возвращаемое значение

Word.RepeatingSectionContentControl

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.RepeatingSectionContentControl;

Возвращаемое значение

Word.RepeatingSectionContentControl

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Word.RepeatingSectionContentControl class

Комментарии

Свойства

Методы

Сведения о свойстве

allowInsertDeleteSection

Значение свойства

Комментарии

appearance

Значение свойства

Комментарии

color

Значение свойства

Комментарии

context

Значение свойства

id

Значение свойства

Комментарии

isTemporary

Значение свойства

Комментарии

level

Значение свойства

Комментарии

lockContentControl

Значение свойства

Комментарии

lockContents

Значение свойства

Комментарии

placeholderText

Значение свойства

Комментарии

range

Значение свойства

Комментарии

repeatingSectionItems

Значение свойства

Комментарии

repeatingSectionItemTitle

Значение свойства

Комментарии

showingPlaceholderText

Значение свойства

Комментарии

tag

Значение свойства

Комментарии

title

Значение свойства

Комментарии

xmlMapping

Значение свойства

Комментарии

Сведения о методе

copy()

Возвращаемое значение

Комментарии

cut()

Возвращаемое значение

Комментарии

delete(deleteContents)

Параметры

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)

Параметры

Возвращаемое значение

set(properties)