MLGrid_ClearGrid

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > UI (User Interface) > CONTROLS > Control Types > MLGrid Control > MLGrid Control Commands >

MLGrid_ClearGrid

 

Description

 

Remove data from a MLGrid

 

Syntax

 

n = MLGrid_ClearGrid(hGrid [, ClearOption [, Refresh]] )

 

Returns

 

Number

 

Parameters

 

Name

Type

Optional

Meaning

hGrid

Number

No

handle to grid control, the one returned by CONTROL ADD MLGRID ...

ClearOptions

Number

Yes

%TRUE or %FALSE

If %TRUE, data plus column and row headings will be cleared

If %FALSE, only data will be cleared.

Refresh

Number

Yes

%TRUE or %FALSE

If %TRUE, after clearing data a refresh command is fired to the control

If %FALSE, no refresh command is fired. It is programmer responsibility to fire a MLGrid_Refresh when needed.

 

Remarks

 

Restrictions

 

See also

 

Examples