GridViewDataColumn.DataItemTemplate Property

Gets or sets a template for displaying data cells within the current column.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(null)]
public virtual ITemplate DataItemTemplate { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Overridable Property DataItemTemplate As ITemplate

Property Value

Type	Default	Description
ITemplate	*null*	An object that implements the ITemplate interface.

Remarks

To provide a common template for displaying data cells within the ASPxGridView, use the GridViewTemplates.DataItem property.

Note

Once a template defined via the DataItemTemplate property is created within a control, it is instantiated within a container object of the GridViewDataItemTemplateContainer type. This container object exposes a set of specific properties to which the template’s child controls can be bound.

If to create a new row in Batch Edit Mode when a column implements a DataItemTemplate, only HTML markup of the row is copied. So, it is recommended to use the DataItemTemplate in Batch Edit mode only for appearance customization.

Online Example

• ASPxGridView - BatchEdit - How to use and modify a control placed in DataItemTemplate

Example

Custom logic implemented in this example allows the end-user to select a limited number of named columns via comboboxes. The maximum number of columns the user can select is defined by a numeric column value, which he can also change. The only callback is used to post the entire grid page data. To work in multi-row-edit mode, scripts and ClientInstanceName property values are generated programmatically.

View Example

Default.aspx.cs

public void InstantiateIn(Control container)
{
    GridViewDataItemTemplateContainer gcontainer = (GridViewDataItemTemplateContainer)container;
    ASPxComboBox cbx = new ASPxComboBox();
    cbx.ID = "cbx_" + gcontainer.Column.FieldName;
    cbx.ValueType = typeof(bool);
    cbx.Items.Add("Yes", true);
    cbx.Items.Add("Blank", false);
    string code = DataBinder.Eval(gcontainer.DataItem, "Code") as string;
    bool value = string.IsNullOrEmpty(code) ? false : code.Contains(gcontainer.Column.FieldName);
    cbx.Value = value;
    cbx.Width = Unit.Pixel(80);
    int num = Convert.ToInt32(DataBinder.Eval(gcontainer.DataItem, "Num"));
    cbx.ClientEnabled = value || code.Length < num;
    cbx.ClientSideEvents.SelectedIndexChanged = "function(s,e){RefreshRow("+gcontainer.VisibleIndex+");}";
    cbx.ClientInstanceName = "cbx_" + gcontainer.Column.FieldName + gcontainer.VisibleIndex.ToString();
    gcontainer.Controls.Add(cbx);
}

Default.aspx

<dxwgv:ASPxGridView ID="ASPxGridView1" runat="server" AutoGenerateColumns="False"
    KeyFieldName="ID" Width="599px" ClientInstanceName="grid" OnCustomCallback="ASPxGridView1_CustomCallback">
    <Columns>
        <dxwgv:GridViewDataTextColumn FieldName="ID" ReadOnly="True" VisibleIndex="0">
            <EditFormSettings Visible="False" />
        </dxwgv:GridViewDataTextColumn>
        <dxwgv:GridViewDataTextColumn FieldName="Num" VisibleIndex="1">
            <DataItemTemplate>
                <dxe:ASPxTextBox ID="txtBox" Width="100px" runat="server" Value='<%# Eval("Num")%>' ClientSideEvents-ValueChanged='<%# "function(s,e){RefreshRow("+Container.VisibleIndex+");}" %>' ClientInstanceName='<%# "tbNum"+Container.VisibleIndex.ToString() %>'></dxe:ASPxTextBox>
            </DataItemTemplate>
        </dxwgv:GridViewDataTextColumn>
    </Columns>
</dxwgv:ASPxGridView>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataItemTemplate 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#

aspxgridview-dataitemtemplate-runtime/CS/HyperlinkColumn/Default.aspx.cs#L45

GridViewDataTextColumn colItemTemplate = new GridViewDataTextColumn();
colItemTemplate.DataItemTemplate = new MyHyperlinkTemplate(); // Create a template
colItemTemplate.Name = "colItemTemplate";

how-to-display-word-wrapped-or-clipped-text-in-the-aspxgridview-runtime-example-e1360/CS/Default.aspx.cs#L30

    grid.DataBind();
    ((GridViewDataColumn)grid.Columns["Product"]).DataItemTemplate = new MyDivTemplate();
}

VB.NET

aspxgridview-dataitemtemplate-runtime/VB/HyperlinkColumn/Default.aspx.vb#L47

Dim colItemTemplate As New GridViewDataTextColumn()
colItemTemplate.DataItemTemplate = New MyHyperlinkTemplate() ' Create a template
colItemTemplate.Name = "colItemTemplate"

how-to-display-word-wrapped-or-clipped-text-in-the-aspxgridview-runtime-example-e1360/VB/Default.aspx.vb#L32

    grid.DataBind()
    CType(grid.Columns("Product"), GridViewDataColumn).DataItemTemplate = New MyDivTemplate()
End Sub