Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter SixFile Functions (continued)

SetSelectMode Function

Overview

The SetSelectMode function sets the select mode for an existing select area. When adding a selected area, the mode will automatically be set to linear or array depending on the type of selection made by SetSelectArea.

Syntax/Parameters

Syntax

int = SetSelectMode ( handle hObject, int mode );

Parameters

hObject

A handle to an Edit Object or an Edit View.

mode

An int specifying the select mode code (EDO_). See Remarks below.

Return Value

An int as ERROR_NONE (0) on success or a formatted error code.

Remarks

The mode determines what is actually selected.

The selection mode codes are as follows:

  Code Value   Comment
  EDO_NOT_SELECTED   0   Nothing Selected — Simple caret. Any existing selection is reset.
  EDO_LINEAR_SELECT   1   Linear Select — Text is selected from a start x/y to an end x/y.
  EDO_BLOCK_SELECT   2   Block Select — Text is selected from a start x/y to an end x/y but only within a box area.
  EDO_ARRAY_SELECT   3   Array Select — Multiple items have been selected. This is normally used for tables.
  EDO_OBJECT_SELECT   4   Object Select — An object, such as an image, is selected. Note that the selected area is the point position immediately after the start of the object’s tag.

 

Note that not all modes are supported in all window types.

The mode must be set after the select area is set otherwise the mode will be wiped out by the SetSelectArea function.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic