Skip to main content

SubDocument.getFloatingTextBoxInfo Method

Returns information specific for floating text boxes about the sub-document.

Declaration

getFloatingTextBoxInfo(): FloatingTextBoxInfo

Returns

Type Description
FloatingTextBoxInfo

An object that contains information about the floating text box.

Remarks

The getFloatingTextBoxInfo returns the FloatingTextBoxInfo object only if the sub-document type is TextBox. For other sub-document types, the method returns null.

if (richEdit.document.activeSubDocument.type == 3)
    var FloatingTextBox = richEdit.document.activeSubDocument.getFloatingTextBoxInfo();

Refer to the following section for more information: Document Elements.

See Also