State (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage properties

Various properties

State

Presentation

Example

Report (Report editor): Visible or invisible control/block

State of a group of controls

State of a column in a Table control

Tabs and controls of a tab pane

Sidebar and pane controls

Radio Button/Check Box controls and their options

Active control made invisible or not

Menu options

Limitations

See also

State (Property)

In french: Etat

The State property is used to get and change the state:

of a control in a window, page or report.
of a block in a report,
of a window.

In a window, the State property is used to get and change the state:

of a window,
of a control or group of controls,
of a "container" control (Tab, Internal Window, Layout, etc.)
of a cell or row in a Table control,
of a menu option.

In a page, the State property is used to get and change the state:

of a control or group of controls,
of a "container" control (Tab, Internal Page, Layout, etc.)
of a group of controls.

In a report, the State property is used to get and change the visibility of a control or block. This property is kept for compatibility with WINDEV 5.5 and WEBDEV 1.5. To show or hide a control or a block in a report, use the Visible property.

New in version 28

The state of a container control (Tab, Layout, Supercontrol, Multiline Zone, etc.) is also applied to its children. For example, if a tab is grayed out, all the controls in that tab are also grayed out.

Example

// The STC_Static1 control becomes active
STC_Static1.State = Active

// The EDT_Edit1 control becomes active
EDT_Edit1.State = Active
// Modify the content of the Combo Box if it is active
IF COMBO_Combo1.State = Active THEN
COMBO_Combo1 = "<Enter HERE>"
SetFocusAndReturnToUserInput(COMBO_Combo1)
END

// Gray out 4th row in the Table control
TABLE_Customer[4].State = Grayed
// Gray out the 1st cell of column 2
COL_COL2[1].State = Grayed
// Makes the 5th row neither clickable nor editable
TABLE_Customer[5].State = ReadOnlyNoSelection
// Makes the 2nd cell of column 3 neither clickable nor editable
COL_COL3[2].State = ReadOnlyNoSelection
// Makes the cell active
COL_COL3[2].State = Active

Syntax

Getting the state of a window or an element in a window Hide the details

<Current state> = <Element name>.State

<Current state>: Integer constant

Current state of the object.
Window controls
Active The control is active and editable.
ReadOnlyNoSelection For the Table controls only: The control is read-only, no input is allowed.

In this case, the user will not be able to select a row in the Table control using the mouse or the arrow keys. A row can only be selected through programming with TableSelectPlus. This row will be selected via the selection bar.
DisplayOnly or Inactive The control is read-only, no input or action is allowed.
For the Table, TreeView Table and Looper controls, the user will be able to select a row. It can also be selected programmatically (using TableSelectPlus in Table controls, for example).
Grayed Control grayed out.
Row or cell in a Table, TreeView Table, List Box, ListView, Combo Box, Looper control
Active The control is enabled and is in edit mode (if the Table control is in edit mode).
ReadOnlyNoSelection The control is read-only, no input or action is allowed. The user will not be able to select a row in the control using the mouse or the arrow keys. Rows can only be selected programmatically (using TableSelectPlus in Table controls, for example).

This row will be selected via the selection bar.
Grayed The control is grayed out
Feature not supported.
Windows
Active Window that can be handled by the user.
DisplayOnly The controls of the window can no longer be modified. However, the user will be able to modify the row selected in the Table, TreeView Table or Looper controls. The window cannot be moved.
Grayed Grays out all window controls.
OutsideScreen The window is active but its coordinates are negative

<Element name>: Character string

Name of control, table row, cell, group of controls or window.

Changing the state of a window or an element in a window Hide the details

<Element name>.State = <New state>

<Element name>: Character string

Name of control, table row, cell, group of controls or window.

<New state>: Integer constant

New state of the element.
Window controls
Active The control is active and editable.
ReadOnlyNoSelection For the Table controls only: The control is read-only, no input is allowed.
In this case, the user will not be able to select a row in the Table control using the mouse or the arrow keys. A row can only be selected through programming with TableSelectPlus. This row will be selected via the selection bar.
DisplayOnly or Inactive The control is read-only, no input or action is allowed.
For the Table, TreeView Table and Looper controls, the user will be able to select a row. It can also be selected programmatically (using TableSelectPlus in Table controls, for example).
Grayed The control is grayed out
Row or cell in a Table, TreeView Table, List Box, ListView, Combo Box, Looper control
Active The control is enabled and is in edit mode (if the Table control is in edit mode).
ReadOnlyNoSelection The control is read-only, no input or action is allowed. The user will not be able to select a row in the Table control using the mouse or the arrow keys. Rows can only be selected programmatically (using TableSelectPlus, for example).
This row will be selected via the selection bar.
Grayed Control grayed out.
Windows
Active Window that can be handled by the user.
DisplayOnly The controls of the window can no longer be modified. However, the user will be able to modify the row selected in the Table, TreeView Table or Looper controls. The window cannot be moved.
Grayed Grays out all window controls.
OutsideScreen The window is active but its coordinates are negative.

Finding out the state of a control in a page Hide the details

<Current state> = <Control name>.State

<Current state>: Integer constant

Current state of the object.
Active or Visible The control is active and editable.
Grayed Control grayed out.
Inactive The edit control is visible and read-only (applies to the edit controls only).
Invisible Invisible (it is recommended to use the Visible property).
This constant is not available. Use the Visible property.
Remark: in List Box and Combo Box controls, 'Disabled' is equivalent to 'Grayed'.

<Control name>: Character string

Name of control or group of controls.

Changing the state of a control in a page Hide the details

<Control name>.State = <New state>

<Control name>: Character string

Name of control or group of controls.

<New state>: Integer constant

New state of the object.
Active or Visible The control is active and editable.
Grayed The control is grayed out
Inactive The edit control is visible and read-only (applies to the edit controls only).
Invisible Invisible control (it is recommended to use the Visible property).
This constant is not available. Use the Visible property.
Remarks:
In List Box and Combo Box controls, 'Disabled' is equivalent to 'Grayed'.
The change of state may result in slightly different effects depending on the browser used. For example, the grayed state will be more noticeable in Internet Explorer and Chrome than in Firefox.

Getting the state of an element in a report Hide the details

<Current state> = <Element name>.State

<Current state>: Integer constant

Current state of the object.
Active The control or block is visible.
Invisible Invisible control or block (it is recommended to use the Visible property).

<Element name>: Character string

Name of report control or block.

Changing the state of an element in a report Hide the details

<Element name>.State = <New state>

<Element name>: Character string

Name of report control or block.

<New state>: Integer constant

New state of the object.
Active The control or block is visible.
Invisible Invisible control or block (it is recommended to use the Visible property).

Remarks

Report (Report editor): Visible or invisible control/block

In a report, the only possible state for a control or a block is visible or invisible. To set the visibility of a control, it is recommended to use the Visible property. This property optimizes the management of control visibility.

State of a group of controls

Finding out the state of a group of controls: the state corresponds to the state of the first control in the group.
Changing the state of a group of controls: all the controls of the group are modified and correspond to the new state.

State of a column in a Table control

If the State property is applied to a column of a Table control, the state of the entire column is changed (and not only the state of the cell).

Caution: the State property only restricts the state of the column defined in the description window. For example, if the column is read-only, no column cell can become editable.

Tabs and controls of a tab pane

The state of a control in a tab pane depends on the state of the tab:

If the pane is not selected, the control is invisible.
If the pane is selected and invisible, the control is invisible.
If the pane is selected and grayed out, the control is grayed out.
If the pane is selected and disabled, the control is disabled.
If the pane is selected and enabled, the control can be enabled, disabled, grayed out or invisible.

Sidebar and pane controls

The state of a control found in a sidebar pane depends on the state of the pane:

If the pane is not selected, the control is invisible.
If the pane is selected and invisible, the control is invisible.
If the pane is selected and grayed out, the control is grayed out.
If the pane is selected and disabled, the control is disabled.
If the pane is selected and enabled, the control can be enabled, disabled, grayed out or invisible.

Radio Button/Check Box controls and their options

You can change the state of the control or the state of an option of the Radio Button/Check Box control. An option can be grayed out or enabled.

To change the state of a Radio Button control:

RADIO_Radio1.State = Grayed
To change the state of an option in a Radio Button control:

RADIO_Radio1[2].State = Grayed

Caution: The state of an option depends on the state of the Radio Button control. Therefore, if the following operations are performed:

An option is grayed out.
The Radio Button/Check Box control is grayed out.
The Radio Button/Check Box control is re-enabled. The option is still grayed out.

Active control made invisible or not

The Visible property can be used to hide a control (enabled, grayed out or read-only).

When the control is invisible, it loses all the characteristics of its previous state: the control is invisible and it cannot be used. The only way to run its code is to call ExecuteProcess. For example, an invisible control does not respond when using the shortcut. For example, an active button made invisible does not respond when using the shortcut.

To restore the previous state of the control, simply use the Visible property again.

Menu options

The State property determines if the menu option is enabled or greyed out. To show or hide a menu option, use the Visible property.

The State property hides a context menu option.

Limitations

The State property has no effect on reports created with the report editor.

The State property can only be used with the following elements:

Button.
Static.
Edit control.
Image.
Check Box.
Radio Button.
List Box.
Combo Box.
TreeView.
Tab.
Window.
Table.
Table column.
Supercontrol.

The State property has no effect on HTML controls.

The State property has no effect on the following elements:

Table,
TreeView Table,
Looper
Linear Looper
Table column.