CollectionSourceBase.DisplayableProperties Property

Provides access to the semicolon-delimited list of the CollectionSourceBase.Collection‘s Property Descriptors and/or expressions.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public string DisplayableProperties { get; set; }

VB.NET

Public Property DisplayableProperties As String

Property Value

Type	Description
String	A semicolon-delimited list of the collection’s property descriptors and/or expressions.

Remarks

The example below illustrates how to set the DisplayableProperties property’s value. Create a custom Controller and access the property from the OnActivated method and from the ListView.CustomizeDisplayableProperties event handler.

C#

using System;
using System.Collections.Generic;
using DevExpress.ExpressApp;
//...
public class MyViewController : ObjectViewController<ListView, Customer> {
    private List<string> additionalDisplayableProperties = 
        new List<string>() { "LocationContext.Flag", "LocationContext.Location.EntityNumberGenerationType" };
    protected override void OnActivated() {
        base.OnActivated();
            View.CollectionSource.DisplayableProperties = 
                GetUpdatedDisplayableProperties(View.CollectionSource.DisplayableProperties);
            View.CustomizeDisplayableProperties += View_CustomizeDisplayableProperties;
    }
    private void View_CustomizeDisplayableProperties(object sender, 
    CustomizeDisplayablePropertiesEventArgs e) {
        e.DisplayableProperties = GetUpdatedDisplayableProperties(e.DisplayableProperties);
    }
    private string GetUpdatedDisplayableProperties(string displayableProperties) {
        String result = displayableProperties;
        IList<String> displayablePropertiesList = displayableProperties.Replace("[", "").Replace("]", "").Split(';');
        foreach(string propertyName in additionalDisplayableProperties) {
            if(!displayablePropertiesList.Contains(propertyName)) {
                result = result + ";" + propertyName;
            }
        }
        return result;
    }
    protected override void OnDeactivated() {
        View.CustomizeDisplayableProperties -= View_CustomizeDisplayableProperties;
        base.OnDeactivated();
    }
}

VB.NET

Imports System
Imports System.Collections.Generic
Imports DevExpress.ExpressApp
'...
Public Class MyViewController
    Inherits ObjectViewController(Of ListView, Customer)

    Private additionalDisplayableProperties As New List(Of String)() From _ 
        {"LocationContext.Flag", "LocationContext.Location.EntityNumberGenerationType"}
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        If View.CollectionSource.DataAccessMode = CollectionSourceDataAccessMode.InstantFeedback Then
            View.CollectionSource.DisplayableProperties = _
                GetUpdatedDisplayableProperties(View.CollectionSource.DisplayableProperties)
            AddHandler View.CustomizeDisplayableProperties, AddressOf View_CustomizeDisplayableProperties
        End If
    End Sub
    Private Sub View_CustomizeDisplayableProperties(ByVal sender As Object, _
    ByVal e As CustomizeDisplayablePropertiesEventArgs)
        e.DisplayableProperties = GetUpdatedDisplayableProperties(e.DisplayableProperties)
    End Sub
    Private Function GetUpdatedDisplayableProperties(ByVal displayableProperties As String) As String
        Dim result As String = displayableProperties
        Dim displayablePropertiesList As IList(Of String) = displayableProperties.Replace("[", "").Replace("]", "").Split(";"c)
        For Each propertyName As String In additionalDisplayableProperties
            If Not displayablePropertiesList.Contains(propertyName) Then
                result = result & ";" & propertyName
            End If
        Next propertyName
        Return result
    End Function
    Protected Overrides Sub OnDeactivated()
        RemoveHandler View.CustomizeDisplayableProperties, AddressOf View_CustomizeDisplayableProperties
        MyBase.OnDeactivated()
    End Sub
End Class

Note

If the passed property name conflicts with a function name, wrap the name in square brackets (e.g. “Oid;[Count];Price”). If you subsequently need to access such a property via a data record, you do not need to use brackets.