PropertyGridControl.RetrieveFields(Boolean) Method

Creates rows for the bound object’s properties, allowing rows for nested properties to be created.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.VerticalGrid

Declaration

C#

public void RetrieveFields(
    bool forceChildRowsCreating
)

VB.NET

Public Sub RetrieveFields(
    forceChildRowsCreating As Boolean
)

Parameters

Name	Type	Description
forceChildRowsCreating	Boolean	true to create rows for nested properties; false to only create root rows.

Remarks

This method clears the current row collection in the PropertyGridControl and then creates rows for the bound object’s properties. The control will only display the properties marked with any attribute from the PropertyGridControl.BrowsableAttributes collection. By default, it will display the properties marked with the BrowsableAttribute.Yes attribute.

If the forceChildRowsCreating parameter is set to false, only rows representing root properties are created. Nested properties will be created on demand (for instance, when a root row is expanded).

The RowProperties.FieldName property of a created row is set to the full name of the corresponding property. For instance, if a bound object contains the Font property of the Font type, the FieldName property of the corresponding row will be set to “Font”. For the nested row which represents the Size property, the FieldName will be set to “Font.Size”.

To create rows manually, use the VGridControlBase.Rows collection.