Class

DataGridSearchSettings

Initializes a new instance of the class.

Declaration

public DataGridSearchSettings()

Identifies the ApplyFilter property.

Declaration

public static readonly BindableProperty ApplyFilterProperty

Field Value

Identifies the CaseSensitive property.

Declaration

public static readonly BindableProperty CaseSensitiveProperty

Field Value

Identifies the CloseSearchPanelCommand property.

Declaration

public static readonly BindableProperty CloseSearchPanelCommandProperty

Field Value

Identifies the DataGrid property.

Declaration

public static readonly BindableProperty DataGridProperty

Field Value

Identifies the IntermediateSearchText property.

Declaration

public static readonly BindableProperty IntermediateSearchTextProperty

Field Value

Identifies the ProvideSearchMatchesAction property.

Declaration

public static readonly BindableProperty ProvideSearchMatchesActionProperty

Field Value

Identifies the ResultsSummary property.

Declaration

public static readonly BindableProperty ResultsSummaryProperty

Field Value

Identifies the SearchEntryCompletedCommand property.

Declaration

public static readonly BindableProperty SearchEntryCompletedCommandProperty

Field Value

Identifies the SearchMatchesCount property.

Declaration

public static readonly BindableProperty SearchMatchesCountProperty

Field Value

Identifies the SearchPanelVisibilityMode property.

Declaration

public static readonly BindableProperty SearchPanelVisibilityModeProperty

Field Value

Identifies the SearchText property.

Declaration

public static readonly BindableProperty SearchTextProperty

Field Value

Identifies the SearchTrigger property.

Declaration

public static readonly BindableProperty SearchTriggerProperty

Field Value

Identifies the TextMatchMode property.

Declaration

public static readonly BindableProperty TextMatchModeProperty

Field Value

Gets or sets a value that determines whether business items that do not satisfy the search criteria should be filtered.

Declaration

public bool ApplyFilter { get; set; }

Property Value

Gets or sets a value indicating whether string comparison should be case sensitive.

Declaration

public bool CaseSensitive { get; set; }

Property Value

Gets or sets the command that is executed when pressing the close button in the DataGridSearchPanel.

Declaration

public ICommand CloseSearchPanelCommand { get; set; }

Property Value

Gets the corresponding RadDataGrid.

Declaration

public RadDataGrid DataGrid { get; }

Property Value

Gets or sets the text of the search entry. Change of this value will not necessarily trigger a search, i.e. it will not necessarily change the SearchText property. The SearchText property is updated in accordance to the SearchTrigger property.

Declaration

public string IntermediateSearchText { get; set; }

Property Value

Gets or sets the custom action that is invoked when determining the search matches for a an item. Use this action when you need to specify search matches based on custom logic. See also ProvideSearchMatches(DataGridSearchProbe) which allows to invoke the base logic.

Declaration

public Action<DataGridSearchProbe> ProvideSearchMatchesAction { get; set; }

Property Value

Gets a summary of the search results, like the number of search matches. You can override the GetResultsSummary() method when you need to change its value.

Declaration

public string ResultsSummary { get; }

Property Value

Gets the command that is executed when the Completed event of the search entry in the DataGridSearchPanel is raised.

Declaration

public ICommand SearchEntryCompletedCommand { get; }

Property Value

Gets the number of search matches.

Declaration

public int SearchMatchesCount { get; }

Property Value

Gets or sets a value indicating the user experience with the visibility of the DataGridSearchPanel and its close button.

Declaration

public DataGridSearchPanelVisibilityMode SearchPanelVisibilityMode { get; set; }

Property Value

Gets or sets the search text. Before a search is started, this value is trimmed, and the SearchStarting event is raised and it allows to change the effective search text that will be used for searching.

Declaration

public string SearchText { get; set; }

Property Value

Gets or sets a value indicating when a search operation should be performed while the end user is typing in the search entry of the DataGridSearchPanel is raised.

Declaration

public DataGridSearchTrigger SearchTrigger { get; set; }

Property Value

Gets or sets a value indicating how a search term should be searched for within a text element.

Declaration

public DataGridSearchTextMatchMode TextMatchMode { get; set; }

Property Value

Invoked when updating the ResultsSummary property.

Declaration

protected virtual string GetResultsSummary()

Returns

Invoked when the search results change. You can override this method to add custom logic by either adding or removing search matches. You can also call this method to provide custom search matches.

Declaration

public virtual void OnSearchResultsChanged(IEnumerable<DataGridSearchResultsItem> searchResults)

Parameters

Invoked when probing for search matches. You can override this method and the Matches collection to add custom logic by either adding or removing search matches.

Declaration

protected virtual void ProvideSearchMatches(DataGridSearchProbe probe)

Parameters

An event that is raised before searching starts. The effective search text can be changed and searching can be cancelled from the arguments.

Declaration

public event EventHandler<DataGridSearchStartingEventArgs> SearchStarting

Event Value