RichEditCommands.changeTextBoxRelativeSize Property

Gets a command to modify a text box’s relative size settings.

Declaration

get changeTextBoxRelativeSize(): ChangeTextBoxRelativeSizeCommand

Property Value

Type	Description
ChangeTextBoxRelativeSizeCommand	An object that provides methods that execute the command and check its state.

Remarks

Call the execute(settings) method to invoke the command. The method checks the command state (obtained via the getState method) to determine whether the action can be performed.

The command includes size parameters assigned in twips. Use the ASPxClientRichEdit.unitConverter to convert size measure units (inches, points, pixels, centimeters) to twips.

Usage example (it is implied that selection is set to a floating object):

JS

var settings = {
    relativeWidth: rich.unitConverter.pixelsToTwips(50),
    relativeWidthType: ASPx.FloatingObjectRelativeWidthType.Page,
    relativeHeight: rich.unitConverter.pixelsToTwips(25),
    relativeHeightType: ASPx.FloatingObjectRelativeHeightType.Page
};
rich.commands.changeTextBoxRelativeSize.execute(settings);

Refer to the following section for more information: Client Commands.