DataLayoutControl.AllowGeneratingCollectionProperties Property

Gets or sets whether layout items that correspond to IList properties will be added to the generated layout. By default, these layout items will contain embedded GridControls to display and edit IList object contents.

Namespace: DevExpress.XtraDataLayout

Assembly: DevExpress.XtraLayout.v21.2.dll

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

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Behavior")]
public DefaultBoolean AllowGeneratingCollectionProperties { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<DXCategory("Behavior")>
Public Property AllowGeneratingCollectionProperties As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	True to generate layout items for IList properties; Default or False to exclude these properties from the generated layout.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

When the AllowGeneratingCollectionProperties property is set to DefaultBoolean.Default or DefaultBoolean.False, the generation of layout items that correspond to IList properties is disabled. When this property is set to DefaultBoolean.True, IList properties will be presented in the layout by items with embedded GridControls (by default).

Note

For a bound object’s properties of the Array and IEnumerable types, layout items are added to the layout regardless of the DataLayoutControl.AllowGeneratingCollectionProperties option. These layout items contain embedded GridControls by default.

See Displaying Collection Properties to learn more.