List View Column Generation

• Jun 19, 2024
• 8 minutes to read

The XAF automatically generates all List Views according to the Application Model‘s information. This topic describes the specific rules used to generate a default set of List View columns.

Note

The column generation logic is declared in the ModelListViewColumnsNodesGenerator class, which is the Node Generator (see Extend and Customize the Application Model in Code).

Simple Property Columns Generation

In this section, simple property columns are generated for the following persistent class:

C# (EF Core)

public class ObjectA : BaseObject {
    public virtual string PropertyA1 { get; set; }
    public virtual string PropertyA2 { get; set; }
}

// Make sure that you use options.UseChangeTrackingProxies() in your DbContext settings.

C# (XPO)

public class ObjectA : BaseObject {
    public ObjectA(Session session) : base(session) { }
    private string propertyA1;
    private string propertyA2;
    public string PropertyA1 {
        get { return propertyA1; }
        set { SetPropertyValue(nameof(PropertyA1), ref propertyA1, value); }
     }
    public string PropertyA2 {
        get { return propertyA2; }
        set { SetPropertyValue(nameof(PropertyA2), ref propertyA2, value); }
    }
}

VB.NET (XPO)

Public Class ObjectA
    Inherits BaseObject
    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
    Private _propertyA1 As String
    Private _propertyA2 As String
    Public Property PropertyA1() As String
        Get
            Return _propertyA1
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(PropertyA1), _propertyA1, value)
        End Set
    End Property
    Public Property PropertyA2() As String
        Get
            Return _propertyA2
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(PropertyA2), _propertyA2, value)
        End Set
    End Property
End Class

The ListView‘s and LookupListView‘s Columns node contains child nodes generated for this class. The following image illustrates this node in the Model Editor:

The column order specified using the IModelNode.Index properties corresponds to their declaration order. These columns are visible when their Index values are positive or zero.

The following attributes, applied in code, affect column visibility:

XafDefaultProperty, DefaultProperty, and FriendlyKeyProperty Attributes

If the class has a default or friendly key property (see XafDefaultPropertyAttribute, DefaultPropertyAttribute, and FriendlyKeyPropertyAttribute), its Lookup List View contains a single column corresponding to this property. In the general List View, the default property column has an index of zero and is displayed first. The code below demonstrates the DefaultProperty attribute in use, and the image illustrates the result.

C#

[DefaultProperty(nameof(PropertyA2))]
public class ObjectA : BaseObject {
    // ...

VB.NET

<DefaultProperty(NameOf(PropertyA2))> _
Public Class ObjectA
    Inherits BaseObject
    ' ...

The FriendlyKeyProperty attribute has the same effect.

If the business class exposes a property whose name matches or contains one of the DevExpress.ExpressApp.DC.TypeInfo.DefaultPropertyNames values (excluding inherited properties), then it is considered as the default property. The DefaultPropertyNames values: Name, Title, Subject, Caption, Description, Benennung, Nombre, Nome. If you want to modify the DefaultPropertyNames collection, refer to the following help topic: Declare a Property with a Specific Name.

C#

public class ObjectA : BaseObject {
    // ...
    public string ObjectName {
        // ...

VB.NET

Public Class ObjectA
    Inherits BaseObject
    ' ...
    Public Property ObjectName() As String
        ' ...

The DefaultProperty attribute overrides this behavior.

Browsable Attribute

The corresponding column is not generated if the property is decorated with the Browsable attribute and false is passed as the parameter (see BrowsableAttribute).

VisibleInListView Attribute

The corresponding column is generated but remains invisible if the property is decorated with the VisibleInListViewAttribute attribute and false is passed as the parameter. The Columns node’s IModelNode.Index property is set to -1. You can use the Column Chooser or Model Editor to unhide such a column (see List View Columns Customization).

VisibleInLookupListView Attribute

When a class has a default property, XAF generates one column for this property in the Lookup List View. To add a column in code, decorate the required property with the VisibleInLookupListViewAttribute and pass true as the attribute parameter. When the class has no default property, all property columns are generated in the Lookup List View. To hide a column corresponding to a certain property, decorate the property with the VisibleInLookupListViewAttribute, and pass false as the attribute parameter.

Reference Property Columns Generation

To demonstrate how the reference property columns are generated, the persistent class demonstrated in the previous section, will be extended with the PropertyA3 reference property of the ObjectB type

C# (EF Core)

public class ObjectA : BaseObject {
    public virtual ObjectB PropertyA3 { get; set; }
}

[DefaultProperty(nameof(PropertyB2))]
public class ObjectB : BaseObject {
    public virtual string PropertyB1 { get; set; }
    public virtual string PropertyB2 { get; set; }
}

// Make sure that you use options.UseChangeTrackingProxies() in your DbContext settings.

C# (XPO)

public class ObjectA : BaseObject {
    // ...
    private ObjectB propertyA3;
    public ObjectB PropertyA3 {
        get { return propertyA3; }
        set { SetPropertyValue(nameof(propertyA3), ref propertyA3, value); }
    }
}
[DefaultProperty(nameof(PropertyB2))]
public class ObjectB : BaseObject {
    public ObjectB(Session session) : base(session) { }
    private string propertyB1;
    public string PropertyB1 {
        get { return propertyB1; }
        set { SetPropertyValue(nameof(propertyB1), ref propertyB1, value); }
    }
    private string propertyB2;
    public string PropertyB2 {
        get { return propertyB2; }
        set { SetPropertyValue(nameof(propertyB2), ref propertyB2, value); }
    }
}

VB.NET (XPO)

Public Class ObjectA
    Inherits BaseObject
    ' ...
    Private _propertyA3 As ObjectB
    Public Property PropertyA3() As ObjectB
        Get
            Return _propertyA3
        End Get
        Set(ByVal value As ObjectB)
            SetPropertyValue(NameOf(propertyA3), _propertyA3, value)
        End Set
    End Property
End Class
<DefaultProperty(NameOf(PropertyB2))> _
Public Class ObjectB
    Inherits BaseObject
    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
    Private _propertyB1 As String
    Public Property PropertyB1() As String
        Get
            Return _propertyB1
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(propertyB1), _propertyB1, value)
        End Set
    End Property
    Private _propertyB2 As String
    Public Property PropertyB2() As String
        Get
            Return _propertyB2
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(propertyB2), _propertyB2, value)
        End Set
    End Property
End Class

A column is generated to represent the PropertyA3 property by default.

In the UI, the PropertyA3 displays the PropertyB2‘s value, because the PropertyB2 is the ObjectB class’ default property.

If the PropertyA3 property is decorated by the ExpandObjectMembersAttribute with the ExpandObjectMembers.InListView parameter, then the columns for all ObjectB class’ properties are generated in the ObjectA List View.

C#

public class ObjectA : BaseObject {
    // ...
    [ExpandObjectMembers(ExpandObjectMembers.InListView)]
    public ObjectB PropertyA3 {
        // ...

VB.NET

Public Class ObjectA
    Inherits BaseObject
    ' ...
    <ExpandObjectMembers(ExpandObjectMembers.InListView)> _
    Public Property PropertyA3() As ObjectB
        Get
            ' ...

Columns, Generated in Inherited Class’ List Views

Consider the following ObjectC class, derived from the ObjectA class:

C# (EF Core)

public class ObjectC : ObjectA {
    public virtual string PropertyC1 { get; set; }
    public virtual string PropertyC2 { get; set; }
}

// Make sure that you use options.UseChangeTrackingProxies() in your DbContext settings.

C# (XPO)

public class ObjectC : ObjectA {
    public ObjectC(Session session) : base(session) { }
    private string propertyC1;
    public string PropertyC1 {
         get { return propertyC1; }
        set { SetPropertyValue(nameof(propertyC1), ref propertyC1, value); }
    }
    private string propertyC2;
    public string PropertyC2 {
        get { return propertyC2; }
        set { SetPropertyValue(nameof(propertyC2), ref propertyC2, value); }
    }
}

VB.NET (XPO)

Public Class ObjectC
    Inherits ObjectA
    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
    Private _propertyC1 As String
    Public Property PropertyC1() As String
         Get
             Return _propertyC1
         End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(propertyC1), _propertyC1, value)
        End Set
    End Property
    Private _propertyC2 As String
    Public Property PropertyC2() As String
        Get
            Return _propertyC2
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(propertyC2), _propertyC2, value)
        End Set
    End Property
End Class

Typically, the columns for this class properties are generated as usual (see the description of ObjectA List Views column generation above). The columns for derived properties are generated as hidden (with -1 indexes). Note the following specifics:

• The intended behavior when the derived class has no default property, and its ancestor has a default property

  The ancestor class’s default property is used as the default in a derived class’ List View. In the general List View, this property’s column gets the zero index and is shown first. In the Lookup List View, the default property ancestor class column is the only generated column. The following image illustrates the generated columns when the ProprertyA2 is the ObjectA class’ default property:

  

• The intended behavior, when the derived class has no public fields and properties

  In this case, columns generated for the derived class are the same as the ancestor class’ columns, and they all are visible by default. The ancestor class’s default property is used as the default in a derived class’ List View.

Default Columns Width

Each column has an IModelColumn.Width property that specifies its width in ASP.NET Core Blazor and Windows Forms application. The following table shows the default width values:

Type of Property	Default Width	Default Width in Lookups
The property is the class’ default or friendly key property (see DefaultPropertyAttribute, FriendlyKeyPropertyAttribute). If a property contains “Name” in its name (excluding inherited properties), this property is also considered default.	400	340
A short value type property - int, float, double, decimal, char or bool.	50	50
Other properties (string, etc.)	70	50

Note

In ASP.NET Core Blazor applications, the default column width is ignored.

Usually the default property contains the most details in the class, so a wide column is automatically generated for it. Short type values do not take much screen space, and their default columns are narrow.

In ASP.NET Web Forms XAF applications, the web browser determines column widths based on the current theme and the displayed content’s style - the Width property has no effect.

Columns Sorting Order

List Views are sorted by the default property values in ascending order (if the default property type is System.IComparable). The default column’s IModelColumn.SortIndex is set to 0, and IModelColumn.SortOrder is set to ColumnSortOrder.Ascending. Other columns have the default SortIndex and SortOrder (-1 and ColumnSortOrder.None, respectively) values.