PlusWnd::RichEdit_GetTextRange

The PlusWnd::RichEdit_GetTextRange function returns a portion of text from a RichEditControl.

Syntax

RichEdit_GetTextRange(
    [string] ControlId,
    [number] StartIdx,
    [number] EndIdx
);

Parameters

ControlId

[string] Unique identifier of the control.

StartIdx

[number] Index of the first character included in the text range.

EndIdx

[number] Index following the last character included in the text range.

Return Value

The portion of text corresponding to the range specified in the parameters.

This function typically fails for the following reason:

• The StartIdx or EndIdx parameter is inferior to 0.
• The range specified is inferior to 0.
• The PlusWnd object refers to a window that has been destroyed.

Remarks

This function can only be used with a RichEditControl, it has no effect on an EditControl.

Function Information

See Also

PlusWnd Object.