Word.BuildingBlockGalleryContentControl class

Пакет:

word

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

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.3

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

• Word. ContentControl: buildingBlockGalleryContentControl

Свойства

appearance	Определяет внешний вид элемента управления содержимым.
buildingBlockCategory	Определяет категорию для элемента управления содержимым стандартных блоков.
buildingBlockType	Определяет тип стандартного блока для элемента управления содержимым стандартного BuildingBlockType блока.
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.BuildingBlockGalleryContentControl объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.BuildingBlockGalleryContentControlData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

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

appearance

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

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

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

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

Комментарии

Набор API: WordApiDesktop 1.3

buildingBlockCategory

Определяет категорию для элемента управления содержимым стандартных блоков.

buildingBlockCategory: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

buildingBlockType

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

buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography";

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

Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"

Комментарии

Набор API: WordApiDesktop 1.3

color

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

color: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

context

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

context: RequestContext;

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

Word.RequestContext

id

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

readonly id: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

isTemporary

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

isTemporary: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

level

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

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

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

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

Комментарии

Набор API: WordApiDesktop 1.3

lockContentControl

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

lockContentControl: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

lockContents

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

lockContents: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

placeholderText

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

readonly placeholderText: Word.BuildingBlock;

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

Word.BuildingBlock

Комментарии

Набор API: WordApiDesktop 1.3

range

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

readonly range: Word.Range;

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

Word.Range

Комментарии

Набор API: WordApiDesktop 1.3

showingPlaceholderText

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

readonly showingPlaceholderText: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

tag

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

tag: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

title

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

title: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.3

xmlMapping

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

readonly xmlMapping: Word.XmlMapping;

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

Word.XmlMapping

Комментарии

Набор API: WordApiDesktop 1.3

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

copy()

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

copy(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

cut()

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

cut(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

delete(deleteContents)

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

delete(deleteContents?: boolean): void;

Параметры

deleteContents

boolean

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

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

void

Комментарии

Набор API: WordApiDesktop 1.3

load(options)

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

load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl;

Параметры

options

Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions

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

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

Word.BuildingBlockGalleryContentControl

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.BuildingBlockGalleryContentControl

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.BuildingBlockGalleryContentControl

set(properties, options)

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

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

Параметры

properties

Word.Interfaces.BuildingBlockGalleryContentControlUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.BuildingBlockGalleryContentControl): void;

Параметры

properties

Word.BuildingBlockGalleryContentControl

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

void

setPlaceholderText(options)

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

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

Параметры

options

Word.ContentControlPlaceholderOptions

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

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

void

Комментарии

Набор API: WordApiDesktop 1.3

toJSON()

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

toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData;

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

Word.Interfaces.BuildingBlockGalleryContentControlData

track()

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

track(): Word.BuildingBlockGalleryContentControl;

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

Word.BuildingBlockGalleryContentControl

untrack()

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

untrack(): Word.BuildingBlockGalleryContentControl;

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

Word.BuildingBlockGalleryContentControl