Word.BuildingBlockGalleryContentControl class

Specifies the appearance of the content control.

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

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the category for the building block content control.

buildingBlockCategory: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies a BuildingBlockType value that represents the type of building block for the building block content control.

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";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format.

color: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Gets the identification for the content control.

readonly id: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies whether to remove the content control from the active document when the user edits the contents of the control.

isTemporary: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.

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

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies if the content control is locked (can't be deleted). true means that the user can't delete it from the active document, false means it can be deleted.

lockContentControl: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies if the contents of the content control are locked (not editable). true means the user can't edit the contents, false means the contents are editable.

lockContents: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns a BuildingBlock object that represents the placeholder text for the content control.

readonly placeholderText: Word.BuildingBlock;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns a Range object that represents the contents of the content control in the active document.

readonly range: Word.Range;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets if the placeholder text for the content control is being displayed.

readonly showingPlaceholderText: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies a tag to identify the content control.

tag: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the title for the content control.

title: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns an XmlMapping object that represents the mapping of the content control to XML data in the data store of the document.

readonly xmlMapping: Word.XmlMapping;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Copies the content control from the active document to the Clipboard.

copy(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Removes the content control from the active document and moves the content control to the Clipboard.

cut(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Deletes the content control and optionally its contents.

delete(deleteContents?: boolean): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.BuildingBlockGalleryContentControl): void;

Parameters

Returns

Sets the placeholder text that displays in the content control until a user enters their own text.

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

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.BuildingBlockGalleryContentControl object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.BuildingBlockGalleryContentControlData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.BuildingBlockGalleryContentControl;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.BuildingBlockGalleryContentControl;

Returns