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. |
GetClassType | "blockLvlSdt" | Returns a type of the ApiBlockLvlSdt class. |
GetContent | ApiDocumentContent | Returns the content of the current container. |
GetDropdownList | ApiContentControlList | Returns a list of values of the combo box / dropdown list 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. |
MoveCursorOutside | None | 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 | None | Selects the current content control. |
SetAlias | None | Sets the alias attribute to the current container. |
SetLabel | None | Sets the label attribute to the current container. |
SetLock | None | 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. |
SetPlaceholderText | boolean | Sets the placeholder text to the current content control. |
SetTag | None | Sets the tag attribute to the current container. |
SetTextPr | None | Applies text settings to the content of the content control. |
ToJSON | JSON | Converts the ApiBlockLvlSdt object into the JSON object. |