DetailViewLayoutAttribute Class

Applied to business class properties. Specifies the Detail View layout options for a target property.

Namespace: DevExpress.ExpressApp.Model

Assembly: DevExpress.ExpressApp.v21.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[AttributeUsage(AttributeTargets.Property)]
public class DetailViewLayoutAttribute :
    Attribute

VB.NET

<AttributeUsage(AttributeTargets.Property)>
Public Class DetailViewLayoutAttribute
    Inherits Attribute

Remarks

In XAF, you can customize the Detail View layout at design-time or runtime using the Model Editor. Alternatively, you can modify the layout in code using DetailViewLayoutAttribute.

This attribute allows you to set the DetailViewLayoutAttribute.ColumnPosition of the current editor to specify the DetailViewLayoutAttribute.GroupId, DetailViewLayoutAttribute.GroupType and DetailViewLayoutAttribute.GroupIndex of the group where this editor will be placed.

Consider the following business class. In this example, we use the Entity Framework Code First class, but a similar approach is applicable to XPO classes as well.

C#

public class Contact {
    [Browsable(false)]
    public int ID { get; private set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string FullName {
        get { return FirstName + " " + LastName; }
    }
    public string Email { get; set; }
    public virtual Contact Manager { get; set; }
    public DateTime? Birthday { get; set; }
    [FieldSize(FieldSizeAttribute.Unlimited)]
    public string Notes { get; set; }
    [FieldSize(FieldSizeAttribute.Unlimited)]
    public string Remarks { get; set; }
}

VB.NET

Public Class Contact
    Private privateID As Integer
    <Browsable(False)>
    Public Property ID() As Integer
        Get
            Return privateID
        End Get
        Private Set(ByVal value As Integer)
            privateID = value
        End Set
    End Property
    Public Property FirstName() As String
    Public Property LastName() As String
    Public ReadOnly Property FullName() As String
        Get
            Return FirstName & " " & LastName
        End Get
    End Property
    Public Property Email() As String
    Public Property Manager() As Contact
    Public Property Birthday() As Date
    <FieldSize(FieldSizeAttribute.Unlimited)>
    Public Property Notes() As String
    <FieldSize(FieldSizeAttribute.Unlimited)>
    Public Property Remarks() As String
End Class

By default, SimpleEditors are grouped in two columns if there are more than four editors. Editors from the SizeableEditors group are placed one by one. In the image below, you can see this default layout.

The code below demonstrates how you can customize this default layout using DetailViewLayoutAttribute with different parameters.

C#

public class Contact {
    [Browsable(false)]
    public int ID { get; private set; }
    [DetailViewLayoutAttribute(LayoutColumnPosition.Left)]
    public string FirstName { get; set; }
    [DetailViewLayoutAttribute(LayoutColumnPosition.Right)]
    public string LastName { get; set; }
    [DetailViewLayoutAttribute("FullName", 0)]
    public string FullName {
        get { return FirstName + " " + LastName; }
    }
    [DetailViewLayoutAttribute(LayoutColumnPosition.Left)]
    public string Email { get; set; }
    [DetailViewLayoutAttribute(LayoutColumnPosition.Right)]
    public virtual Contact Manager { get; set; }
    [DetailViewLayoutAttribute(LayoutColumnPosition.Left)]
    public DateTime? Birthday { get; set; }
    [FieldSize(FieldSizeAttribute.Unlimited)]
    [DetailViewLayoutAttribute("NotesAndRemarks", LayoutGroupType.TabbedGroup, 100)]
    public string Notes { get; set; }
    [FieldSize(FieldSizeAttribute.Unlimited)]
    [DetailViewLayoutAttribute("NotesAndRemarks", LayoutGroupType.TabbedGroup, 100)]
    public string Remarks { get; set; }
}

VB.NET

Public Class Contact
    Private privateID As Integer
    <Browsable(False)>
    Public Property ID() As Integer
        Get
            Return privateID
        End Get
        Private Set(ByVal value As Integer)
            privateID = value
        End Set
    End Property
    <DetailViewLayoutAttribute(LayoutColumnPosition.Left)>
    Public Property FirstName() As String
    <DetailViewLayoutAttribute(LayoutColumnPosition.Right)>
    Public Property LastName() As String
    <DetailViewLayoutAttribute("FullName", 0)>
    Public ReadOnly Property FullName() As String
        Get
            Return FirstName & " " & LastName
        End Get
    End Property
    <DetailViewLayoutAttribute(LayoutColumnPosition.Left)>
    Public Property Email() As String
    <DetailViewLayoutAttribute(LayoutColumnPosition.Right)>
    Public Property Manager() As Contact
    <DetailViewLayoutAttribute(LayoutColumnPosition.Left)>
    Public Property Birthday() As Date
    <FieldSize(FieldSizeAttribute.Unlimited), _
    DetailViewLayoutAttribute("NotesAndRemarks", LayoutGroupType.TabbedGroup, 100)>
    Public Property Notes() As String
    <FieldSize(FieldSizeAttribute.Unlimited), _
    DetailViewLayoutAttribute("NotesAndRemarks", LayoutGroupType.TabbedGroup, 100)>
    Public Property Remarks() As String
End Class

Note

If several properties have the same groupId values, their other parameters should be the same as well.

As a result, the layout is changed in accordance with the specified parameters of DetailViewLayoutAttribute.

Inheritance

Object

Attribute

DetailViewLayoutAttribute