ApiBlockLvlSdt
Represents the ApiBlockLvlSdt class.
Methods
| Method | Returns | Description |
|---|---|---|
| AddCaption | boolean | Adds a caption paragraph after (or before) the current content control. 💡 Please note that the current content control must be in the document (not in the footer/header). And if the current content control is placed in a shape, then a caption is added after (or before) the parent shape. |
| AddComment | ApiComment | Adds a comment to the current block content control. 💡 Please note that the current block content control must be in the document. |
| AddElement | boolean | Adds a paragraph or a table or a block content control to the current container. |
| AddText | boolean | Adds a text to the current content control. |
| Copy | ApiBlockLvlSdt | Creates a copy of an block content control. Ignores comments, footnote references, complex fields. |
| Delete | boolean | Removes a content control and its content. If keepContent is true, the content is not deleted. |
| GetAlias | string | Returns the alias attribute for the current container. |
| GetAllContentControls | ApiBlockLvlSdt[] | ApiInlineLvlSdt[] | Returns a collection of content control objects in the current content control. |
| GetAllDrawingObjects | Drawing[] | Returns a collection of drawing objects in the current content control. |
| GetAllParagraphs | ApiParagraph[] | Returns a collection of paragraph objects in the current content control. |
| GetAllTablesOnPage | ApiTable[] | Returns a collection of tables on a given absolute page. 💡 This method can be a little bit slow, because it runs the document calculation process to arrange tables on the specified page. |
| GetAppearance | "boundingBox" | "hidden" | Gets the visualization of the content control. |
| GetBackgroundColor | null | Object | Returns the background color of the current content control. |
| GetBorderColor | null | Object | Returns the border color of the current content control. |
| GetClassType | "blockLvlSdt" | Returns a type of the ApiBlockLvlSdt class. |
| GetContent | ApiDocumentContent | Returns the content of the current container. |
| GetDataBinding | XmlMapping | Retrieves the data binding of the content control. |
| GetDataForXmlMapping | string | Returns the content control data for the XML mapping. |
| GetDropdownList | ApiContentControlList | Returns a list of values of the combo box / drop-down list content control. |
| GetId | string | Returns a unique ID for the current content control. |
| GetInternalId | string | Returns an internal id of the current content control. |
| GetLabel | string | Returns the label attribute for the current container. |
| GetLock | SdtLock | Returns the lock type of the current container. |
| GetParentContentControl | ApiBlockLvlSdt | null | Returns a content control that contains the current content control. |
| GetParentTable | ApiTable | null | Returns a table that contains the current content control. |
| GetParentTableCell | ApiTableCell | null | Returns a table cell that contains the current content control. |
| GetPlaceholderText | string | Returns the placeholder text from the current content control. |
| GetPosInParent | Number | Returns the content control position within its parent element. |
| GetRange | ApiRange | Returns a Range object that represents the part of the document contained in the specified content control. |
| GetTag | string | Returns the tag attribute for the current container. |
| IsPicture | boolean | Checks whether the content control is a picture control. This method verifies if the content control is specifically a picture control. |
| MoveCursorOutside | boolean | Places a cursor before/after the current content control. |
| Push | boolean | Pushes a paragraph or a table or a block content control to actually add it to the current container. |
| RemoveAllElements | boolean | Clears the contents from the current content control. |
| ReplaceByElement | boolean | Replaces the current content control with a new element. |
| Search | ApiRange[] | Searches for a scope of a content control object. The search results are a collection of ApiRange objects. |
| Select | boolean | Selects the current content control. |
| SetAlias | boolean | Sets the alias attribute to the current container. |
| SetAppearance | None | Sets the visualization of the content control. |
| SetBackgroundColor | boolean | Sets the background color to the current content control. |
| SetBorderColor | boolean | Sets the border color to the current content control. |
| SetDataBinding | boolean | Sets the data binding for the content control. |
| SetId | None | Specifies a unique ID for the current content control. |
| SetLabel | boolean | Sets the label attribute to the current container. |
| SetLock | boolean | Sets the lock to the current block text content control: -"contentLocked" - content cannot be edited. -"sdtContentLocked" - content cannot be edited and the container cannot be deleted. -"sdtLocked" - the container cannot be deleted. |
| SetPicture | boolean | Sets the content (image) for the picture content control. This method updates the picture inside a content control by setting an image from a provided URL. The URL should be an internet link to the image. |
| SetPlaceholderText | boolean | Sets the placeholder text to the current content control. |
| SetTag | boolean | Sets the tag attribute to the current container. |
| SetTextPr | boolean | Applies text settings to the content of the content control. |
| ToJSON | JSON | Converts the ApiBlockLvlSdt object into the JSON object. |
| UpdateFromXmlMapping | boolean | Updates the content control using the value from the XML mapping. |