CustomColumnDataEventArgs.IsGetData Property

Gets a Boolean value which indicates whether you should provide data for the currently processed cell.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public bool IsGetData { get; }

VB.NET

Public ReadOnly Property IsGetData As Boolean

Property Value

Type	Description
Boolean	true if you need to provide data for the currently processed cell, false otherwise.

Remarks

If the IsGetData property returns true (and consequently the CustomColumnDataEventArgs.IsSetData property is set to false) the data for the cell currently being processed should be supplied via the event handler. To do this get a value from your data source based upon the current row and unbound column and assign it to the event’s CustomColumnDataEventArgs.Value parameter. The current unbound column is identified by the CustomColumnDataEventArgs.Column property. The CustomColumnDataEventArgs.ListSourceRowIndex property can be used to identify the currently processed row.

If the IsGetData property is set to false (and consequently the CustomColumnDataEventArgs.IsSetData property is set to true) the CustomColumnDataEventArgs.Value parameter identifies the value which has been set for the current cell from the grid. This should be stored to your data source by the event handler.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IsGetData 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-external-images-in-grid-if-its-data-source-contains-links-to-the-images-e538/CS/Form1.cs#L229

private void gridView1_CustomUnboundColumnData(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs e) {
    if(e.Column.FieldName == "Image" && e.IsGetData) {
        GridView view = sender as GridView;

how-to-show-error-icons-for-cells-which-belong-to-an-unbound-column-gridcontrol-e1933/CS/Form1.cs#L67

{
    if (e.IsGetData) e.Value = e.ListSourceRowIndex;
}

winforms-create-populate-unbound-column/CS/WindowsApplication1/Form1.cs#L47

{
    if (e.IsGetData)
        e.Value = _Cache.GetValue(e.Row);

how-to-use-typeconverter-for-converting-values-displayed-in-a-gridlookupedit-dropdown-e2814/CS/E2814/WindowsApplication3/TypeConverterHelper.cs#L59

if(e.Column.FieldName == unboundColumnFieldName) {
    if(e.IsGetData) {
        IList dataSource = edit.DataSource as IList;

how-to-use-the-grid-in-the-unbound-mode-e4434/CS/E4434/CustomGrid/UnboundGridView.cs#L20

private void UnboundGridView_CustomUnboundColumnData(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs e) {
    if (e.IsGetData) {
        e.Value = GridControl.DataSource.GetValue(e.ListSourceRowIndex, e.Column.AbsoluteIndex);

VB.NET

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

If emp IsNot Nothing Then
    If e.IsGetData Then
        e.Value = (TryCast(p, Employee)).Title

how-to-display-external-images-in-grid-if-its-data-source-contains-links-to-the-images-e538/VB/Form1.vb#L211

Private Sub gridView1_CustomUnboundColumnData(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs) Handles gridView1.CustomUnboundColumnData
    If e.Column.FieldName = "Image" AndAlso e.IsGetData Then
        Dim view As GridView = TryCast(sender, GridView)

how-to-show-error-icons-for-cells-which-belong-to-an-unbound-column-gridcontrol-e1933/VB/Form1.vb#L74

Private Sub gridView1_CustomUnboundColumnData(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs) Handles gridView1.CustomUnboundColumnData
    If e.IsGetData Then
        e.Value = e.ListSourceRowIndex

winforms-create-populate-unbound-column/VB/WindowsApplication1/Form1.vb#L45

Private Sub gridView1_CustomUnboundColumnData(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs)
    If e.IsGetData Then e.Value = _Cache.GetValue(e.Row)
    If e.IsSetData Then _Cache.SetValue(e.Row, e.Value)

how-to-use-typeconverter-for-converting-values-displayed-in-a-gridlookupedit-dropdown-e2814/VB/WindowsApplication3/TypeConverterHelper.vb#L58

If e.Column.FieldName = unboundColumnFieldName Then
    If e.IsGetData Then
        Dim dataSource As IList = TryCast(edit.DataSource, IList)