Frame.SetControllersActive(String, Boolean) Method

Activates or deactivates the current Frame's Controllers for a specified reason.

Namespace: DevExpress.ExpressApp
Assembly: DevExpress.ExpressApp.v18.1.dll
public void SetControllersActive(string reason, bool isActive)
Type Name Description
String reason

A string value that specifies a reason by which Controllers are activated or deactivated.

Boolean isActive

true if you need to activate Controllers; otherwise, false.

Use this method to add a specified element to the Controller.Active collection of each Controller from the Frame's Frame.Controllers collection. This element, which represent a key/value pair, will be formed from values passed as the reason and isActive parameters. By calling this method, you can change a Controller's active state. A Controller is active, when none of the Controller.Activecollection elements have the false value. So, use this method in the following situations:

  • Deactivate all Controllers. To do this, pass false as the isActive parameter.
  • Activate the Controllers that have been deactivated by a particular reason. To do this, pass true as the isActive parameter and the required reason as the reason parameter. The Controllers that have been deactivated by another reason will not be activated until you call this method and pass this reason. *