Word.GroupContentControl class

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

Свойства

appearance	Определяет внешний вид элемента управления содержимым.
color	Определяет красно-зелено-синее (RGB) значение цвета элемента управления содержимым. Вы можете указать значение в формате "#RRGGBB".
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
id	Возвращает идентификатор элемента управления содержимым.
isTemporary	Указывает, следует ли удалять элемент управления содержимым из активного документа, когда пользователь изменяет содержимое элемента управления.
level	Получает уровень элемента управления содержимым: распространяется ли он на текст, абзацы, ячейки таблицы или строки таблицы. или если он встроен.
lockContentControl	Указывает, заблокирован ли элемент управления содержимым (его нельзя удалить). `true` означает, что пользователь не может удалить его из активного документа, означает, `false` что его можно удалить.
lockContents	Указывает, заблокировано ли содержимое элемента управления содержимым (недоступно для редактирования). `true` означает, что пользователь не может изменять содержимое, означает, `false` что содержимое можно редактировать.
placeholderText	Возвращает `BuildingBlock` объект, представляющий замещающий текст для элемента управления содержимым.
range	Получает объект, `Range` представляющий содержимое элемента управления содержимым в активном документе.
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.GroupContentControl` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.GroupContentControlData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
ungroup()	Удаляет элемент управления содержимым группы из документа, так что его дочерние элементы управления содержимым больше не являются вложенными и их можно свободно редактировать.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

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

showingPlaceholderText

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

readonly showingPlaceholderText: boolean;

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

boolean

tag

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

tag: string;

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

string

title

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

title: string;

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

string

xmlMapping

Получает 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.GroupContentControlLoadOptions): Word.GroupContentControl;

Параметры

options: Word.Interfaces.GroupContentControlLoadOptions

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

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

Word.GroupContentControl

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Word.GroupContentControl

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Word.GroupContentControl

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.GroupContentControlUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.GroupContentControl): void;

Параметры

properties: Word.GroupContentControl

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

void

setPlaceholderText(options)

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

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

Параметры

options: Word.ContentControlPlaceholderOptions

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

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

void

toJSON()

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

toJSON(): Word.Interfaces.GroupContentControlData;

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

Word.Interfaces.GroupContentControlData

track()

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

track(): Word.GroupContentControl;

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

Word.GroupContentControl

ungroup()

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

ungroup(): void;

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

void

untrack()

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

untrack(): Word.GroupContentControl;

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

Word.GroupContentControl

Комментарии

Используется

Свойства

Методы

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

appearance

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

Комментарии

color

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

Комментарии

context

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

id

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

Комментарии

isTemporary

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

Комментарии

level

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

Комментарии

lockContentControl

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

Комментарии

lockContents

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

Комментарии

placeholderText

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

Комментарии

range

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

Комментарии

showingPlaceholderText

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

Комментарии

tag

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

Комментарии

title

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

Комментарии

xmlMapping

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

Комментарии

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

copy()

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

Комментарии

cut()

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

Комментарии

delete(deleteContents)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setPlaceholderText(options)

Параметры

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

Комментарии

toJSON()

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

track()