setEnable

Enables or disables a specific control.

Parameters

1. controlId - id of the Gebra Suite control as a string

2. enable - (optional, default = true) bool value if the control should be enabled or not

3. subControl (optional) Some controls have sub Controls, that can be enabled or disabled. Important: setEnable for subcontrols cannot be used in onAppStart, because some controls are not fully created at that time, use onAppInitialized instead. Here is a list of possible subControls:

   • grids

     • inline - enables or disables the inline editing of a grid (Cell Editing)

     • buttons - enables or disables the buttons of a grid

     • buttonNew - enables or disables the new buttons of a grid

     • buttonDelete - enables or disables the delete buttons of a grid

     • buttonCopy - enables or disables the copy buttons of a grid

Example Usages

1. Simple

app.setEnable("myControlId"); //enables the control
app.setEnable("myControlId", true); //enables the control
app.setEnable("myControlId", false); //disables the control

2. Disable the Grid inline edit feature

app.setEnable("myGridControl", false, "inline");

3. Disable all data manipulating grid Toolbar Buttons

app.setEnable("myGridControl", false, "buttons");

4. Disable a single grid Toolbar Buttons

app.setEnable("myGridControl", false, "buttonNew");
app.setEnable("myGridControl", false, "buttonDelete");
app.setEnable("myGridControl", false, "buttonCopy");

5. Enable/Disable a grid column for inline editing

app.setEnable("myGridControl", true, "columnName");
app.setEnable("myGridControl", false, "columnName");

Return Values

Function does not explicitly produce return value.