Shiny Language Reference

Language Reference > Panel Functions


setpanelallowdrag

setpanelallowdrag(bool IsAllowed);

 

 

Sets whether the display panel can be dragged

SETPANELALLOWDRAG controls an internal state within Brass that dictates whether the panel can be dragged to a new position on-screen. This statement overrides any choice made by the user via the tray menu or configuration window. However, the user's choice at the time of calling this statement is not discarded.

For example if the user chooses to enable the panel drag bar, then SETPANELALLOWDRAG is called with a parameter of FALSE, the drag bar will be hidden and the tray menu option disabled. This prevents the user from dragging the panel or from changing the status of the drag bar. If SETPANELALLOWDRAG is then called with a parameter of TRUE, the drag bar and tray options will return to their previous states - in this example, the drag bar will be enabled.

This option is enabled by default, therefore there is no need to call SETPANELALLOWDRAG with a parameter of TRUE at the start of your plugin.

 

Parameters

IsAllowed

TRUE if the panel drag functions should be accessible, otherwise FALSE to prevent any use of the drag functions.

 

Return Value

None

 

Example Code

// Prevent any use or change to the drag bar
setpanelallowdrag(False);