BaseLayoutItem.Name Property

Gets or sets the layout item’s name.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v19.1.dll

Declaration

C#

[XtraSerializableProperty]
[DefaultValue("")]
[Browsable(false)]
public string Name { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue("")>
<Browsable(False)>
Public Property Name As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the item’s name.

Remarks

BaseLayoutItem objects are Component descendants and thus, can be directly accessed in code using their names. Therefore, the Name property specifies the string that can be used in code to access the layout item.

Note

To allow a Layout Control’s layout to be customized and serialized you need to ensure that Name properties of the layout items and controls within the layout items are set to unique values. You must set the Name properties to unique values for layout items and controls that are created at runtime. The control’s Name property must be initialized before this control is assigned to the LayoutControlItem.Control property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Name 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-display-records-of-different-types-in-the-same-grid-e446/CS/WindowsApplication16/Form1.cs#L53

Person p = view.GetRow(e.RowHandle) as Person;
string colTitleName = view.Columns["Title"].LayoutViewField.Name;
string colTotalTurnover = view.Columns["TotalTurnover"].LayoutViewField.Name;

how-to-create-and-place-the-emptyspaceitem-at-runtime-e1514/CS/WindowsApplication1/Form1.cs#L23

LayoutControlItem labelItem1 = lc.Root.AddItem();
labelItem1.Name = Guid.NewGuid().ToString();
labelItem1.Control = new LabelControl();

how-to-show-the-confirmation-dialog-before-hiding-a-layout-item-in-the-customization-form-e3592/CS/WindowsApplication3/Main.cs#L21

BaseLayoutItem item = sender as BaseLayoutItem;
if (XtraMessageBox.Show(string.Format("Do you wish to hide this item ({0})? ", item.Name), "HideItemDialog", MessageBoxButtons.YesNo) != DialogResult.Yes)
    e.CanHideItem = false;

VB.NET

how-to-display-records-of-different-types-in-the-same-grid-e446/VB/WindowsApplication16/Form1.vb#L44

Dim p As Person = TryCast(view.GetRow(e.RowHandle), Person)
Dim colTitleName As String = view.Columns("Title").LayoutViewField.Name
Dim colTotalTurnover As String = view.Columns("TotalTurnover").LayoutViewField.Name

how-to-create-and-place-the-emptyspaceitem-at-runtime-e1514/VB/WindowsApplication1/Form1.vb#L25

Dim labelItem1 As LayoutControlItem = lc.Root.AddItem()
labelItem1.Name = Guid.NewGuid().ToString()
labelItem1.Control = New LabelControl()

how-to-show-the-confirmation-dialog-before-hiding-a-layout-item-in-the-customization-form-e3592/VB/WindowsApplication3/Main.vb#L22

Dim item As BaseLayoutItem = TryCast(sender, BaseLayoutItem)
If XtraMessageBox.Show(String.Format("Do you wish to hide this item ({0})? ", item.Name), "HideItemDialog", MessageBoxButtons.YesNo) <> System.Windows.Forms.DialogResult.Yes Then
    e.CanHideLayoutItem = False