ListEditItemsRequestedByFilterConditionEventArgs.BeginIndex Property

Gets an integer value that identifies the begin index of the editor’s items.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public int BeginIndex { get; }

VB.NET

Public ReadOnly Property BeginIndex As Integer

Property Value

Type	Description
Int32	An integer value that represents the begin index.

Remarks

The BeginIndex property is affected by the ASPxAutoCompleteBoxBase.CallbackPageSize property value.

Example

The following section of the Filtering Large Data Source online demo illustrates how the ASPxComboBox.ItemsRequestedByFilterCondition and ASPxComboBox.ItemRequestedByValue events of the ASPxComboBox editor can be handled to filter the editor’s data source containing a large number of records.

Note

To work properly, both the ItemsRequestedByFilterCondition and ItemRequestedByValue events should be handled.

C#

protected void ASPxComboBox_OnItemsRequestedByFilterCondition_SQL(object source, 
ListEditItemsRequestedByFilterConditionEventArgs e) {
         ASPxComboBox comboBox = (ASPxComboBox)source;
         SqlDataSource1.SelectCommand = @"SELECT OID, [From], Sent, Subject 
             FROM (select OID, [From], Sent, Subject, row_number() over(order by t.Sent) as [rn] 
             from dbo.ServerSideGridTest as t WHERE ((t.Subject LIKE @filter) OR (t.[From] 
              LIKE @filter))) as st where st.[rn] between @startIndex and @endIndex";
         SqlDataSource1.SelectParameters.Clear();
         SqlDataSource1.SelectParameters.Add("filter", TypeCode.String, string.Format("%{0}%", e.Filter));
         SqlDataSource1.SelectParameters.Add("startIndex", TypeCode.Int64, (e.BeginIndex + 1).ToString());
         SqlDataSource1.SelectParameters.Add("endIndex", TypeCode.Int64, (e.EndIndex + 1).ToString());
         comboBox.DataSource = SqlDataSource1;
         comboBox.DataBind();
}

protected void ASPxComboBox_OnItemRequestedByValue_SQL(object source, 
ListEditItemRequestedByValueEventArgs e) {
    ASPxComboBox comboBox = (ASPxComboBox)source;
    SqlDataSource1.SelectCommand = @"SELECT OID, Subject, [From], Sent 
        FROM dbo.ServerSideGridTest WHERE (OID = @OID) ORDER BY Sent";
    SqlDataSource1.SelectParameters.Add("OID", TypeCode.Int64, e.Value.ToString());
    ...
    comboBox.DataSource = SqlDataSource1;
    comboBox.DataBind();
}

ASPX

<dxe:ASPxComboBox ID="ASPxComboBox1" runat="server" 
EnableCallbackMode="true" CallbackPageSize="10" 
    IncrementalFilteringMode="Contains" ValueType="System.String" ValueField="OID" 
    OnItemsRequestedByFilterCondition="ASPxComboBox_OnItemsRequestedByFilterCondition_SQL" 
    OnItemRequestedByValue="ASPxComboBox_OnItemRequestedByValue_SQL"  
    TextFormatString="{0};{1}" TextField="From" Width="100%" DropDownWidth="610">
    <Columns>
        <dxe:ListBoxColumn FieldName="Subject" Width="300px"/>
        <dxe:ListBoxColumn FieldName="From" Width="80px"/>
        <dxe:ListBoxColumn FieldName="Sent"/>
    </Columns>
</dxe:ASPxComboBox>

Related GitHub Examples

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

asp-net-mvc-grid-cascading-combo-boxes-in-batch-edit-mode/CS/Models/ComboBoxPropertiesProvider.cs#L113

IQueryable<City> query;
var skip = e.BeginIndex;
var take = e.EndIndex - e.BeginIndex + 1;

asp-net-mvc-grid-cascading-combo-boxes-in-edit-form/CS/Models/ComboBoxPropertiesProvider.cs#L112

IQueryable<City> query;
var skip = e.BeginIndex;
var take = e.EndIndex - e.BeginIndex + 1;

asp-net-mvc-combobox-bind-to-large-filtered-data-source/CS/ComboBoxLargeDataBase/Model/MyModel.cs#L30

public static object GetPersonsRange(ListEditItemsRequestedByFilterConditionEventArgs args) {
    var skip = args.BeginIndex;
    var take = args.EndIndex - args.BeginIndex + 1;

VB.NET

asp-net-mvc-grid-cascading-combo-boxes-in-batch-edit-mode/VB/Models/ComboBoxPropertiesProvider.vb#L105

Dim query As IQueryable(Of City)
Dim skip = e.BeginIndex
Dim take = e.EndIndex - e.BeginIndex + 1

asp-net-mvc-grid-cascading-combo-boxes-in-edit-form/VB/Models/ComboBoxPropertiesProvider.vb#L103

Dim query As IQueryable(Of City)
Dim skip = e.BeginIndex
Dim take = e.EndIndex - e.BeginIndex + 1

asp-net-mvc-combobox-bind-to-large-filtered-data-source/VB/ComboBoxLargeDataBase/Model/MyModel.vb#L34

Public Shared Function GetPersonsRange(ByVal args As ListEditItemsRequestedByFilterConditionEventArgs) As Object
    Dim skip = args.BeginIndex
    Dim take = args.EndIndex - args.BeginIndex + 1