BBjCEdit::getSelection

Description

Returns the selected text in the BBjCEdit control.

Syntax

Return Value	Method
BBjVector	getSelection()

Parameters

None.

Return Value

Returns a four-element BBjVector that identifies the currently selected text in the BBjCEdit control. If the vector is Selection!, then Selection!.getItem(0) and Selection!.getItem(1) identify the paragraph and offset of the beginning of the selected text while Selection!.getItem(2) and Selection!.getItem(3) identify the paragraph and offset of the end of the selected text. All values are zero-based. If the start and end points are the same, there is no selection and the location of the caret (insertion point) is reported.

Remarks

None.

Example

rem 'Get the selection of text of a paragraph in a custom edit box

rem 'Obtain the instance of the BBjAPI object
let myAPI! = BBjAPI()

rem 'Open the SysGui device
SYSGUI = UNT
OPEN (SYSGUI) "X0"

rem 'Obtain the instance of the BBjSysGui object
let mySysGui! = myAPI!.getSysGui()

rem 'Set addWindow param values
X = 10
Y = 10
WIDTH = 200
HEIGHT = 200
TITLE$ = "BBj Window"

rem 'Set the current context
mySysGui!.setContext(0)

rem 'Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

rem 'Add a CEDIT control on the window
myCEdit! = myWindow!.addCEdit(101,30,100,140,30,"")

rem 'Add a paragraph at index 0 to the CEdit control
myCEdit!.addParagraph(0,"This is a paragraph")

rem 'Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

rem 'Process Events
process_events

rem 'Callback routine called when the user closes the application window
APP_CLOSE:
    rem 'Get the offsets for the selected text in a custom edit control
    SELECTION! = myCEdit!.getSelection()
    PRINT SELECTION!.get(0),SELECTION!.get(1)
    PRINT SELECTION!.get(2),SELECTION!.get(3)
release

See Also

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.