IAreaInfo Interface

Declares properties of business objects that can be displayed as an area on a vector map using the Maps Module.

Namespace: DevExpress.Persistent.Base

Assembly: DevExpress.Persistent.Base.v24.1.dll

NuGet Package: DevExpress.Persistent.Base

Declaration

C#

public interface IAreaInfo

VB.NET

Public Interface IAreaInfo

Remarks

You can implement this interface in an XPO or Entity Framework business object. As a result, the WebVectorMapsListEditor will be used to display List Views of this business object. Each object is displayed as a map area. An object’s Detail View is displayed after clicking an area.

XPO Example

C#

using System.ComponentModel;
using DevExpress.Xpo;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl;
// ...
[DefaultProperty(nameof(Title)), NavigationItem(false)]
public class VectorMapsListEditorDemoObject : BaseObject, IAreaInfo {
    public VectorMapsListEditorDemoObject(Session session) : base(session) { }
    public string Title { get; set; }
    [Association("USAState-Stores"), Aggregated]
    public XPCollection<MapsListEditorDemoObject> Stores {
        get { return GetCollection<MapsListEditorDemoObject>(nameof(Stores)); }
    }
    string IAreaInfo.Tooltip {
        get {
            string tooltipStr = Title;
            int storesCount = Stores.Count;
            if(storesCount > 0) {
                tooltipStr += string.Format("<br> {0} store{1}", storesCount, storesCount == 1 ? "" : "s");
            }
            return tooltipStr;
        }
    }
    float IAreaInfo.Value {
        get {
            return Stores.Count;
        }
    }
}

VB.NET

Imports System.ComponentModel
Imports DevExpress.Xpo
Imports DevExpress.Persistent.Base
Imports DevExpress.Persistent.BaseImpl
' ...
<DefaultProperty(NameOf(VectorMapsListEditorDemoObject.Title)), NavigationItem(False)> _
Public Class VectorMapsListEditorDemoObject
    Inherits BaseObject
    Implements IAreaInfo

    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
    Public ReadOnly Property Title() As String Implements IAreaInfo.Title
    <Association("USAState-Stores"), Aggregated> _
    Public ReadOnly Property Stores() As XPCollection(Of MapsListEditorDemoObject)
        Get
            Return GetCollection(Of MapsListEditorDemoObject)(NameOf(Stores))
        End Get
    End Property
    Private ReadOnly Property IAreaInfo_Tooltip() As String Implements IAreaInfo.Tooltip
        Get
            Dim tooltipStr As String = Title
            Dim storesCount As Integer = Stores.Count
            If storesCount > 0 Then
                tooltipStr &= String.Format("<br> {0} store{1}", storesCount, If(storesCount = 1, "", "s"))
            End If
            Return tooltipStr
        End Get
    End Property
    Private ReadOnly Property IAreaInfo_Value() As Single Implements IAreaInfo.Value
        Get
            Return Stores.Count
        End Get
    End Property
End Class

Note

See the complete example in the VectorMapsListEditorDemoObject.cs file in the Feature Center demo that is installed in the %PUBLIC%\Documents\DevExpress Demos 24.1\Components\XAF\FeatureCenter.NETFramework.XPO folder by default, or refer to the Feature Center demo online.

EF Example

C#

using System.ComponentModel;
using DevExpress.ExpressApp.DC;
using DevExpress.Persistent.Base;
// ...
[DefaultProperty(nameof(Title)), NavigationItem(false)]
public class VectorMapsListEditorDemoObject : IAreaInfo {
    [Browsable(false)]
    public int ID { get; private set; }
    public string Title { get; set; }
    [Aggregated]
    public IList<MapsListEditorDemoObject> Stores { get; private set; } = new List<MapsListEditorDemoObject>();
    string IAreaInfo.Tooltip {
        get {
            string tooltipStr = Title;
            int storesCount = Stores.Count;
            if(storesCount > 0) {
                tooltipStr += string.Format("<br> {0} store{1}", storesCount, storesCount == 1 ? "" : "s");
            }
            return tooltipStr;
        }
    }
    float IAreaInfo.Value {
        get {
            return Stores.Count;
        }
    }
}

VB.NET

Imports System.ComponentModel
Imports DevExpress.ExpressApp.DC
Imports DevExpress.Persistent.Base
' ...
<DefaultProperty(NameOf(VectorMapsListEditorDemoObject.Title)), NavigationItem(False)>
Public Class VectorMapsListEditorDemoObject
    Implements IAreaInfo
    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 ReadOnly Property Title() As String Implements IAreaInfo.Title
    <Aggregated>
    Public ReadOnly Property Stores() As IList(Of MapsListEditorDemoObject) = New List(Of MapsListEditorDemoObject)()
    Private ReadOnly Property IAreaInfo_Tooltip() As String Implements IAreaInfo.Tooltip
        Get
            Dim tooltipStr As String = Title
            Dim storesCount As Integer = Stores.Count
            If storesCount > 0 Then
                tooltipStr &= String.Format("<br> {0} store{1}", storesCount, If(storesCount = 1, "", "s"))
            End If
            Return tooltipStr
        End Get
    End Property
    Private ReadOnly Property IAreaInfo_Value() As Single Implements IAreaInfo.Value
        Get
            Return Stores.Count
        End Get
    End Property
End Class