ViewController.TargetViewType Property

Specifies the type of the View, for which a View Controller is intended.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v22.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[DefaultValue(ViewType.Any)]
public ViewType TargetViewType { get; set; }

VB.NET

<DefaultValue(ViewType.Any)>
Public Property TargetViewType As ViewType

Property Value

Type	Default	Description
ViewType	Any	A ViewType enumeration value identifying a View type.

Available values:

Name	Description
Any	An Action or a View Controller will be activated in Frames (Windows) with any Views.
DetailView	An Action or a View Controller will be activated in Frames (Windows) with Detail Views.
ListView	An Action or a View Controller will be activated in Frames (Windows) with List Views.
DashboardView	An Action or a View Controller will be activated in Frames (Windows) with Dashboard Views.

Remarks

View Controllers can be activated for both List and Detail Views. You can use the TargetViewType property to provide View Controller activation within the List, Detail, or any type of View.

Note

The TargetViewType property affects only ViewController’s activation. Controller.FrameAssigned and other events that are irrelevant to the view type always fire.

Alternatively, you can implement the generic ViewController<ViewType> Controller instead of the ViewController and specify the View’s type, for which this Controller is intended, in the ViewType generic parameter. In this case, you do not need to perform an additional cast when you access the View.

The example below demonstrates how to add a PopupWindowShowAction to all List Views in an application.

C#

using System;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl;
// ...
public class ShowListViewController : ViewController {
    public ShowListViewController() {
        TargetViewType = ViewType.ListView;
        PopupWindowShowAction showListViewAction = new PopupWindowShowAction(this, "ShowListView",
            PredefinedCategory.Edit);
        showListViewAction.CustomizePopupWindowParams += ShowListViewAction_CustomizePopupWindowParams;
    }
    private void ShowListViewAction_CustomizePopupWindowParams(object sender, CustomizePopupWindowParamsEventArgs e) {
        Type objectType = typeof(Person);
        e.View = Application.CreateListView(objectType, true);
    }
}

VB.NET

Imports System
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
Imports DevExpress.Persistent.BaseImpl

Public Class ShowListViewController
    Inherits ViewController
    Public Sub New()
        TargetViewType = ViewType.ListView
        Dim showListViewAction As New PopupWindowShowAction(Me, "ShowListView", PredefinedCategory.Edit)
        AddHandler showListViewAction.CustomizePopupWindowParams, _
            AddressOf ShowListViewAction_CustomizePopupWindowParams
    End Sub
    Private Sub ShowListViewAction_CustomizePopupWindowParams(ByVal sender As Object, _
        ByVal e As CustomizePopupWindowParamsEventArgs)
        Dim objectType As Type = GetType(Person)
        e.View = Application.CreateListView(objectType, True)
    End Sub
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TargetViewType property.

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-perform-custom-actions-when-a-recurring-events-exceptional-occurrence-is-created-e1088/CS/CustomSchedulerEvent.Module/CustomEventController.cs#L20

    RegisterActions(components);
    this.TargetViewType = ViewType.ListView;
}

VB.NET

XAF_how-to-perform-custom-actions-when-a-recurring-events-exceptional-occurrence-is-created-e1088/VB/CustomSchedulerEvent.Module/CustomEventController.vb#L22

    RegisterActions(components)
    Me.TargetViewType = ViewType.ListView
End Sub