Edit

Share via

Word.Interfaces.BuildingBlockGalleryContentControlUpdateData interface

Package:
word

An interface for updating data on the BuildingBlockGalleryContentControl object, for use in buildingBlockGalleryContentControl.set({ ... }).

Properties

appearance

Specifies the appearance of the content control.
buildingBlockCategory

Specifies the category for the building block content control.
buildingBlockType

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

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

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

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.
lockContents

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.
placeholderText

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

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

Specifies a tag to identify the content control.
title

Specifies the title for the content control.
xmlMapping

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

Property Details

appearance

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the appearance of the content control.

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

Property Value

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

buildingBlockCategory

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the category for the building block content control.

buildingBlockCategory?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

buildingBlockType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

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"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

color

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isTemporary

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

isTemporary?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

lockContentControl

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

lockContents

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

placeholderText

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

placeholderText?: Word.Interfaces.BuildingBlockUpdateData;

Property Value

Word.Interfaces.BuildingBlockUpdateData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

range

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

range?: Word.Interfaces.RangeUpdateData;

Property Value

Word.Interfaces.RangeUpdateData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

tag

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies a tag to identify the content control.

tag?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

title

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the title for the content control.

title?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

xmlMapping

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

xmlMapping?: Word.Interfaces.XmlMappingUpdateData;

Property Value

Word.Interfaces.XmlMappingUpdateData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]