State (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

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
Limits

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

State (Property)

In french: Etat

..State can be used:

in a report.
in a window.
in a page.

In a report, ..State is used to find out and modify the display state:

of a control,
of a report block.

Remark: In a report, ..State can only be used to manage the visibility of a control or block (a control or a block cannot be grayed). In this case, this property is available for backward compatibility with WINDEV 5.5 and WEBDEV 1.5. To manage the visibility of a control or block in a report, we recommend that you use ..Visible.

In a window, ..State is used to find out and modify the display state:

of a window,
of a control or group of controls,
of a table cell or table row,
of a menu option.

Versions 18 and later

This property is now available in Windows Store apps mode.

New in version 18

This property is now available in Windows Store apps mode.

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

New in version 21

This property is now available in Universal Windows 10 App mode.

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>"
ReturnToCapture(COMBO_Combo1)
END

// Gray out 4th row in the Table control
TABLE_Customer[4]..State = Grayed
// Grays 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

Finding out 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 The control or block is invisible (it is recommended to use ..Visible).

<Element name>: Character string (with or without quotes)

Name of report control or block.

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

<Element name>..State = <New state>

<Element name>: Character string (with or without quotes)

Name of report control or block.

<New state>: Integer constant

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

Finding out the state of an element in a window or the state of 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 table row with the mouse or with the arrows. A row can only be selected by 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 table row. It can also be selected by programming (with TableSelectPlus for the tables).
Grayed Control grayed.
Table row or Table cell, TreeView table, List Box, ListView, Combo Box, Looper
Active The control is active and editable (if the table is in edit).
ReadOnlyNoSelection The control is read-only, no input or action is allowed. The user will not be able to select a table row with the mouse or with the arrow keys. A row can only be selected by programming with TableSelectPlus.

This row will be selected via the selection bar.
Grayed The control is grayed
Feature not supported.
Windows
Active Window that can be handled by the user.
DisplayOnly The window controls are no longer accessible in modification. 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 all window controls.
OutsideScreen The window is active but its coordinates are negative

<Element name>: Character string (with or without quotes)

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

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

<Element name>..State = <New state>

<Element name>: Character string (with or without quotes)

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

<New state>: Integer constant

New state of 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 table row with the mouse or with the arrows. A row can only be selected by 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 by programming (with TableSelectPlus for the tables).
Grayed The control is grayed
Table row or Table cell, TreeView table, List Box, ListView, Combo Box, Looper
Active The control is active and editable (if the table is in edit).
ReadOnlyNoSelection The control is read-only, no input or action is allowed. The user will not be able to select a table row with the mouse or with the arrow keys. A row can only be selected by programming with TableSelectPlus.
This row will be selected via the selection bar.
Grayed Control grayed.
Windows
Active Window that can be handled by the user.
DisplayOnly The window controls are no longer accessible in modification. 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 all window controls.
OutsideScreen The window is active but its coordinates are negative.

Remarks

Visible or invisible control/block

In a report, the only possible state for a control or a block is visible or invisible. To manage the visibility of a control, it is recommended to use ..Visible. 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.
Modifying 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 ..State is applied to a column, the state of the entire column is changed (and not just the state of a column cell).

Caution: ..State can only be used to restrict 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 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, the control is grayed.
If the pane is selected and inactive, the control is inactive.
If the pane is selected and active, the control can be active, inactive, grayed 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, the control is grayed.
If the pane is selected and inactive, the control is inactive.
If the pane is selected and active, the control can be active, inactive, grayed or invisible.

Radio Button/Check Box controls and their options

You can modify the state of the control or the state of an option of the Radio Button/Check Box control. An option can be grayed or active.

To modify the state of a Radio Button control:

RADIO_Radio1..State = Grayed
To modify 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.
The Radio Button/Check Box control is grayed.
The Radio Button/Check Box control is re-enabled. The option is still grayed.

Active control made invisible or not

A control (active, grayed, read-only) can be made invisible by ..Visible.

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 use 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 ..Visible again.

Menu options

..State is used to find out whether the menu option is enabled or grayed. To define whether the menu option is visible, use ..Visible.

Limits

..State has no effect on the reports.

..State only applies to the following elements:

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

..State has no effect on the HTML controls.