HtmlContentControl.CustomFieldValue Event

Allows you to supply data to custom data fields.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Events")]
public event HtmlContentCustomFieldValueEventHandler CustomFieldValue

VB.NET

<DXCategory("Events")>
Public Event CustomFieldValue As HtmlContentCustomFieldValueEventHandler

Event Data

The CustomFieldValue event's data class is DevExpress.XtraEditors.HtmlContentCustomFieldValueEventArgs.

Remarks

The following example handles the CustomFieldValue event to calculate a value for the FullName custom data field:

C#

namespace DXApplication {
    public partial class Form1 : DevExpress.XtraEditors.XtraForm {
        DataItem dataContext;
        public Form1() {
            InitializeComponent();
            dataContext = new DataItem() { FirstName = "Max", LastName = "Fisher" };
            htmlContentControl1.DataContext = dataContext;
            htmlContentControl1.CustomFieldValue += HtmlContentControl1_CustomFieldValue;
        }
        void HtmlContentControl1_CustomFieldValue(object sender, DevExpress.XtraEditors.HtmlContentCustomFieldValueEventArgs e) {
            if (e.PropertyName == "FullName")
                e.Value = string.Format("{0} {1}", dataContext.FirstName, dataContext.LastName);
        }
    }
    public class DataItem {
        public string FirstName { get; set; }
        public string LastName { get; set; }
    }
}

VB.NET

Namespace DXApplication
    Partial Public Class Form1
        Inherits DevExpress.XtraEditors.XtraForm

        Private dataContext As DataItem
        Public Sub New()
            InitializeComponent()
            dataContext = New DataItem() With {
                .FirstName = "Max",
                .LastName = "Fisher"
            }
            htmlContentControl1.DataContext = dataContext
            AddHandler htmlContentControl1.CustomFieldValue, AddressOf HtmlContentControl1_CustomFieldValue
        End Sub
        Private Sub HtmlContentControl1_CustomFieldValue(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.HtmlContentCustomFieldValueEventArgs)
            If e.PropertyName = "FullName" Then
                e.Value = String.Format("{0} {1}", dataContext.FirstName, dataContext.LastName)
            End If
        End Sub
    End Class
    Public Class DataItem
        Public Property FirstName() As String
        Public Property LastName() As String
    End Class
End Namespace

HTML

<h1>$Welcome: {FullName}</h1>