XPBaseCollection.DisplayableProperties Property

Gets or sets the displayable properties list for a bound control.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v18.2.dll

Declaration

C#

public string DisplayableProperties { get; set; }

VB.NET

Public Property DisplayableProperties As String

Property Value

Type	Description
String	The displayable properties list, containing property paths separated by semicolons. For example, “FirstName;LastName;Company.Name;Address.City”.

Remarks

The XPBaseCollection class implements the IBindingList and ITypedList interfaces, so a data-aware control such as the XtraGrid can be bound to a collection and display and edit its data (object properties would be represented by columns in the grid). The DisplayableProperties property provides a list of the object properties that are available for binding at design time. Note that it’s still possible to bind a control to properties that are not included in the DisplayableProperties list. In this instance, the required property name should be specified (typed) for a control manually in the Property Grid (at design time) or in code.

If an object property represents a persistent object that has nested properties, you can include these nested properties in the DisplayableProperties list. These should be specified in the form: “PropertyName.NestedPropertyName” (for instance, “Address.City”). The number of nested levels is not limited.

When an empty string is assigned, the DisplayableProperties property is actually set to a string that contains all the public properties of the current object.

See Property Descriptors for further details.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DisplayableProperties 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#

how-to-bind-the-dxgrid-to-the-xpcollection-e2347/CS/Q265259/Window1.xaml.cs#L37

    Orders.DeleteObjectOnRemove = true;
    Orders.DisplayableProperties = "ShipName;ShipAddress";
}

VB.NET

how-to-bind-the-dxgrid-to-the-xpcollection-e2347/VB/Q265259/Window1.xaml.vb#L39

    Orders.DeleteObjectOnRemove = True
    Orders.DisplayableProperties = "ShipName;ShipAddress"
End Sub