ObjectViewController<ViewType, ObjectType> Class

A base class for View Controllers intended for Object Views.

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#
VB.NET

public abstract class ObjectViewController<ViewType, ObjectType> :
    ViewController<ViewType>
    where ViewType : ObjectView

Public MustInherit Class ObjectViewController(Of ViewType As ObjectView, ObjectType)
    Inherits ViewController(Of ViewType)

Type Parameters

Name	Description
ViewType	Specifies the ViewController.TargetViewType value.
ObjectType	Specifies the ViewController.TargetObjectType value

Remarks

This Controller is derived from the ObjectViewController and introduces two generic type parameters. The ViewType parameter specifies the ViewController.TargetViewType value. The ObjectType specifies the ViewController.TargetObjectType value. You can use this class as the base class for a custom Controller to ensure that the custom Controller is activated for a specific View type and object type.

The following code snippet demonstrates a custom View Controller derived from the generic ObjectViewController.

C#
VB.NET

public class ContactController : ObjectViewController<ListView, Contact> {
    protected override void OnViewControlsCreated() {
        base.OnViewControlsCreated();
        // The View property is of the ListView type
        ASPxGridListEditor listEditor = View.Editor as ASPxGridListEditor;
        if (listEditor != null) {
            // Perform some actions here
            // ...
        }
    }
}

Public Class ContactController
    Inherits ObjectViewController(Of ListView, Contact)
    Protected Overrides Sub OnViewControlsCreated()
        MyBase.OnViewControlsCreated()
        ' The View property is of the ListView type
        Dim listEditor As ASPxGridListEditor = TryCast(View.Editor, ASPxGridListEditor)
        If listEditor IsNot Nothing Then
            ' Perform some actions here
            ' ...
        End If
    End Sub
End Class

Note

CodeRush allows you to add Actions and Controllers with a few keystrokes. To learn about the Code Templates for XAF, refer to the following help topic: XAF Templates.

Note that Visual Studio designer cannot be used with generic components, so you cannot use it to design generic Controllers. As a possible workaround, you can declare an intermediate non-generic base class, derived from a generic Controller and decorated with the DesignerCategoryAttribute, and then derive your custom Controller from this intermediate class. The following code snippet illustrates this.

C#
VB.NET

[System.ComponentModel.DesignerCategory("Component")]
public class MyIntermediateListViewController : ObjectViewController<ListView, Contact> { }

public class MyViewController : MyIntermediateListViewController { 
    //...
}

<System.ComponentModel.DesignerCategory("Component")>
Public Class MyIntermediateListViewController
    Inherits ObjectViewController(Of ListView, Contact)
End Class

Public Class MyViewController
    Inherits MyIntermediateListViewController
    '...
End Class