Frame.GetController<ControllerType>() Method

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

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

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

VB.NET

Public Function GetController(Of ControllerType As Controller) As ControllerType

Type Parameters

Name
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.

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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetController<ControllerType>() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-execute-actions-in-code-e1393/CS/WinWebSolution.Module.Win/ActionsInvokerViewController.cs#L14

private void saPopupWindowShowActionInvoker_Execute(object sender, SimpleActionExecuteEventArgs e) {
    LinkUnlinkController linkUnlinkController = Frame.GetController<LinkUnlinkController>();
    if(linkUnlinkController != null) {

xaf-web-forms-use-oauth2-authentication-providers/CS/AuthenticationOwin.Module.Web/Controllers/LogonAuthController.cs#L46

((Page)sender).Load -= CurrentRequestPage_Load;
LogonController logonController = Frame.GetController<LogonController>();
if(logonController != null && logonController.AcceptAction.Active) {

XAF_how-to-customize-export-options-of-the-printing-system-in-winforms-e2108/CS/WinSolution.Module.Win/ConfigurePrintingSystemViewController.cs#L15

base.OnActivated();
reportService = Frame.GetController<WinReportServiceController>();
printingService = Frame.GetController<PrintingController>();

XAF_how-to-replace-a-list-views-default-action-e3275/CS/ReplaceDefaultActionInListView.Module.Win/PhoneCallController.cs#L26

// Comment out the following three lines to leave "Write Mail" action as default:
WriteMailController writeMailController = Frame.GetController<WriteMailController>();
if (writeMailController != null)

XAF_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/CS/CustomActionControl.Module.Win/Controllers/CustomActionControlController.cs#L42

base.OnActivated();
ActionControlsSiteController actionControlsSiteController = Frame.GetController<ActionControlsSiteController>();
if (actionControlsSiteController != null) {

VB.NET

XAF_how-to-execute-actions-in-code-e1393/VB/WinWebSolution.Module.Win/ActionsInvokerViewController.vb#L16

Private Sub saPopupWindowShowActionInvoker_Execute(ByVal sender As Object, ByVal e As SimpleActionExecuteEventArgs) Handles saPopupWindowShowActionInvoker.Execute
    Dim linkUnlinkController As LinkUnlinkController = Frame.GetController(Of LinkUnlinkController)()
    If linkUnlinkController IsNot Nothing Then

xaf-web-forms-use-oauth2-authentication-providers/VB/AuthenticationOwin.Module.Web/Controllers/LogonAuthController.vb#L48

RemoveHandler DirectCast(sender, Page).Load, AddressOf CurrentRequestPage_Load
Dim logonController As LogonController = Frame.GetController(Of LogonController)()
If logonController IsNot Nothing AndAlso logonController.AcceptAction.Active.ResultValue Then

XAF_how-to-customize-export-options-of-the-printing-system-in-winforms-e2108/VB/WinSolution.Module.Win/ConfigurePrintingSystemViewController.vb#L16

MyBase.OnActivated()
reportService = Frame.GetController(Of WinReportServiceController)()
printingService = Frame.GetController(Of PrintingController)()

XAF_how-to-replace-a-list-views-default-action-e3275/VB/ReplaceDefaultActionInListView.Module.Win/PhoneCallController.vb#L28

' Comment out the following three lines to leave "Write Mail" action as default:
Dim writeMailController As WriteMailController = Frame.GetController(Of WriteMailController)()
If writeMailController IsNot Nothing Then

XAF_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/VB/CustomActionControl.Module.Win/Controllers/CustomActionControlController.vb#L44

MyBase.OnActivated()
Dim actionControlsSiteController As ActionControlsSiteController = Frame.GetController(Of ActionControlsSiteController)()
If actionControlsSiteController IsNot Nothing Then