LayoutControlItem Class

A layout item.

Assembly : DevExpress.XtraLayout.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

public class LayoutControlItem :
    LayoutItem,
    IContextItemCollectionOptionsOwner,
    IContextItemCollectionOwner,
    ISupportAppearanceObjectPropertiesFilter

Public Class LayoutControlItem
    Inherits LayoutItem
    Implements IContextItemCollectionOptionsOwner,
               IContextItemCollectionOwner,
               ISupportAppearanceObjectPropertiesFilter

The following members return LayoutControlItem objects:

Show 18 links

Remarks

The layout items embed UI controls and can display text labels. The image below illustrates the anatomy of a layout control.

The layout item’s Control property specifies the embedded control. The Text property specifies the label. The TextVisible option toggles the label’s visibility.

Important

The Layout Control holds layout items within groups. Its Root collection contains the root layout items and nesting groups.

Create a Layout Item at Design-Time

Drag a control from the Toolbox and drop it onto the Layout Control (see the animation below). The Layout Control automatically creates a layout item with an embedded control.

Watch Video

Create a Layout Item in Code

The following example demonstrates how to create a new instance of the LayoutControlItem class, specify its primary settings, embed a text editor, and add it to the Layout Control’s root group.

When you create the layout items and embedded controls in code, you should set their Name properties to unique values to avoid layout customization and serialization issues. The embedded control’s Name property must be specified before you assign the control to the LayoutControlItem.Control property.

C#
VB.NET

csharp

using DevExpress.XtraEditors;
using DevExpress.XtraLayout;

LayoutControlItem firstNameItem = new LayoutControlItem();
// Sets the layout item's name. The name should be unique.
firstNameItem.Name = "layourItemSecondaryName";
firstNameItem.Text = "First Name";
TextEdit fieldFirstName = new TextEdit() { Name = "textEditFirstName" };
firstNameItem.Control = fieldFirstName;
layoutControl1.AddItem(firstNameItem);

Imports DevExpress.XtraEditors
Imports DevExpress.XtraLayout

Private firstNameItem As New LayoutControlItem()
' Sets the layout item's name. The name should be unique.
firstNameItem.Name = "layourItemSecondaryName"
firstNameItem.Text = "First Name"
Dim fieldFirstName As New TextEdit() With {.Name = "textEditFirstName"}
firstNameItem.Control = fieldFirstName
layoutControl1.AddItem(firstNameItem)

Note

Once you specify the LayoutControlItem.Control property, the Layout Control adds the control to the LayoutControl.Controls collection. You can only set the LayoutControlItem.Control property once. When a layout item is disposed of at runtime, its embedded control is not destroyed.

You can also use the LayoutControlGroup.AddItem method to create a root layout item in code. The LayoutControlGroup.AddItem method creates a layout item within the specified layout group.

C#
VB.NET

csharp

using DevExpress.XtraEditors;
using DevExpress.XtraLayout;

// Creates a root layout item with the Text Editor.
layoutControl1.AddItem("Second Name", new TextEdit());

// Creates an Empty Space layout item.
layoutControl1.AddItem(new EmptySpaceItem());

Imports DevExpress.XtraEditors
Imports DevExpress.XtraLayout

' Creates a root layout item with the Text Editor.
layoutControl1.AddItem("Second Name", New TextEdit())

' Creates an Empty Space layout item.
layoutControl1.AddItem(New EmptySpaceItem())

Watch Video