DevExpress.ExpressApp > Frame > Methods > GetController<ControllerType>()

Frame.GetController<ControllerType>() Method

Returns a specified Controller from the current Frame's Frame.Controllers collection.

Assembly: DevExpress.ExpressApp.v19.2.dll

Declaration

C#
VB.NET

public ControllerType GetController<ControllerType>()
    where ControllerType : Controller

Public Function GetController(Of ControllerType As Controller) As ControllerType

Type Parameters

Name	Description
ControllerType

Returns

Type	Description
ControllerType	A specified Controller found in the current Frame's Frame.Controllers collection.

Remarks

Use the GetController<ControllerType> method to access a particular Controller from the current Frame's Frame.Controllers collection. The ControllerType generic type argument specifies the required Controller type. In this argument, you can specify any class which is a descendant of the Controller class.

The code below demonstrates how to access the NewObjectViewController and add its NewObjectAction to the Quick Access Toolbar.

C#
VB.NET

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.SystemModule;

// ...
public class NewObjectActionController : WindowController {
    protected override void OnActivated() {
        base.OnActivated();
        NewObjectViewController newObjectViewController = Window.GetController<NewObjectViewController>();
        if(newObjectViewController != null) {
            newObjectViewController.NewObjectAction.QuickAccess = true;
        }
    }
}

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.SystemModule

Public Class NewObjectActionController
    Inherits WindowController

    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        Dim newObjectViewController As NewObjectViewController = Window.GetController(Of NewObjectViewController)()
        If newObjectViewController IsNot Nothing Then
            newObjectViewController.NewObjectAction.QuickAccess = True
        End If
    End Sub
End Class

If there is no Controller of the specified type in the Frame.Controllers collection, this method returns the first Controller which is assignable to this type.

IMPORTANT

To avoid possible null reference exceptions when accessing an existing Controller from your code, always ensure that the Frame.GetController<ControllerType> method result is not null when the XafApplication.OptimizedControllersCreation property is true.