Back to Devexpress

UserDesignerOptions.FieldListMaxExpandLevelOnSearch Property

xtrareports-devexpress-dot-xtrareports-dot-configuration-dot-userdesigneroptions-21f6aea0.md

latest4.6 KB
Original Source

UserDesignerOptions.FieldListMaxExpandLevelOnSearch Property

Specifies how many levels of the field list tree are searched when the user enters text into a search box.

Namespace : DevExpress.XtraReports.Configuration

Assembly : DevExpress.XtraReports.v25.2.dll

NuGet Package : DevExpress.Reporting.Core

Declaration

csharp
public int FieldListMaxExpandLevelOnSearch { get; set; }
vb
Public Property FieldListMaxExpandLevelOnSearch As Integer

Property Value

TypeDescription
Int32

Number of levels to expand the tree node and search.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to FieldListMaxExpandLevelOnSearch
ReportingSettings

.UserDesignerOptions .FieldListMaxExpandLevelOnSearch

| | Settings |

.UserDesignerOptions .FieldListMaxExpandLevelOnSearch

|

Remarks

When a data source contains nested fields, the FieldListMaxExpandLevelOnSearch property allows you to restrict search to the specified number of levels. Initially it is set to 6. You can specify its value as follows:

csharp
DevExpress.XtraReports.Configuration.Settings.Default.UserDesignerOptions.FieldListMaxExpandLevelOnSearch = 4;
vb
DevExpress.XtraReports.Configuration.Settings.Default.UserDesignerOptions.FieldListMaxExpandLevelOnSearch = 4

Take the following example of an infinitely nested data source:

csharp
using DevExpress.DataAccess.ObjectBinding;
using System.Collections.Generic;
using System.ComponentModel;

[HighlightedClass]
[DisplayName("Recurrent Data Source")]
public class RDataProvider {

    [HighlightedMember]
    [DisplayName("ManagerKey")]
    public IEnumerable<ManagerKey> ManagerKey { get; set; }

    [HighlightedMember]
    [DisplayName("User")]
    public IEnumerable<User> User { get; set; }
}

public class User {
    public string Name { get; set; }
    public string Email { get; set; }
    public IEnumerable<ManagerKey> ManagerKeys {get; set; }
}

public class ManagerKey {
    public string Name { get; set; }
    public string Description { get; set; }
    public string ID { get; set; }
    public User Manager { get; set; }

}
vb
Imports DevExpress.DataAccess.ObjectBinding
Imports System.Collections.Generic
Imports System.ComponentModel

<HighlightedClass, DisplayName("Recurrent Data Source")>
Public Class RDataProvider

  <HighlightedMember, DisplayName("ManagerKey")>
  Public Property ManagerKey() As IEnumerable(Of ManagerKey)

  <HighlightedMember, DisplayName("User")>
  Public Property User() As IEnumerable(Of User)
End Class

Public Class User
  Public Property Name() As String
  Public Property Email() As String
  Public Property ManagerKeys() As IEnumerable(Of ManagerKey)
End Class

Public Class ManagerKey
  Public Property Name() As String
  Public Property Description() As String
  Public Property ID() As String
  Public Property Manager() As User

End Class

The FieldListMaxExpandLevelOnSearch value prevents the search box from infinite recursion. The following image shows the search-as-you-type feature when FieldListMaxExpandLevelOnSearch is set to 4:

See Also

RefreshFieldListService Class (Web Report Designer)

UserDesignerOptions Class

UserDesignerOptions Members

DevExpress.XtraReports.Configuration Namespace