Skip to main content

ApiInlineLvlSdt

Represents the ApiInlineLvlSdt class.

Methods

MethodReturnsDescription
AddCommentApiCommentAdds a comment to the current inline content control.\ 💡 Please note that this inline content control must be in the document.
AddElementbooleanAdds an element to the inline text content control.
AddTextbooleanAdds text to the current content control.
CopyApiInlineLvlSdtCreates a copy of an inline content control. Ignores comments, footnote references, complex fields.
DeletebooleanRemoves a content control and its content. If keepContent is true, the content is not deleted.
GetAliasstringReturns the alias attribute for the current container.
GetClassType"inlineLvlSdt"Returns a type of the ApiInlineLvlSdt class.
GetDropdownListApiContentControlListReturns a list of values of the combo box / dropdown list content control.
GetElementParagraphContentReturns an element of the current inline text content control using the position specified.
GetElementsCountnumberReturns a number of elements in the current inline text content control. The text content \ control is created with one text run present in it by default, so even without any \ element added this method will return the value of '1'.
GetInternalIdstringReturns an internal id of the current content control.
GetLabelstringReturns the label attribute for the current container.
GetLockSdtLockReturns the lock type of the current container.
GetParentContentControlApiBlockLvlSdt | ApiInlineLvlSdt | nullReturns a content control that contains the current content control.
GetParentParagraphApiParagraph | nullReturns a paragraph that contains the current content control.
GetParentTableApiTable | nullReturns a table that contains the current content control.
GetParentTableCellApiTableCell | nullReturns a table cell that contains the current content control.
GetPlaceholderTextstringReturns the placeholder text from the current inline content control.
GetRangeApiRangeReturns a Range object that represents the part of the document contained in the specified content control.
GetTagstringReturns the tag attribute for the current container.
IsFormbooleanChecks if the content control is a form.
MoveCursorOutsideNonePlaces a cursor before/after the current content control.
PushbooleanAdds an element to the end of inline text content control.
RemoveAllElementsbooleanRemoves all the elements from the current inline text content control.
RemoveElementbooleanRemoves an element using the position specified from the current inline text content control.
SetAliasNoneSets the alias attribute to the current container.
SetLabelNoneAdds a string label to the current inline text content control.
SetLockNoneSets the lock to the current inline 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.
SetPlaceholderTextbooleanSets the placeholder text to the current inline content control.\ Can't be set to checkbox or radio button*
SetTagNoneAdds a string tag to the current inline text content control.
SetTextPrApiInlineLvlSdtApplies text settings to the content of the content control.
ToJSONJSONConverts the ApiInlineLvlSdt object into the JSON object.