Represents the data row associated with the search functionality of RadGridView.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class GridViewSearchRowInfo : GridViewSystemRowInfo, IDataItem, IHierarchicalRow, INotifyPropertyChanged, INotifyPropertyChangingEx, IDisposable, IComparable<GridViewSystemRowInfo>, IGridViewEventListenerInheritance: objectGridViewRowInfoGridViewSystemRowInfoGridViewSearchRowInfo
Implements:
Inherited Members
Constructors
Initializes a new instance of the GridViewSearchRowInfo class.
public GridViewSearchRowInfo(GridViewInfo viewInfo)The grid view info that this search row belongs to.
Properties
Gets the allowed states for this search row. Search rows do not support any special states.
public override AllowedGridViewRowInfoStates AllowedStates { get; }Overrides:
Gets or sets a value indicating whether the first found cell will be automatically selected and brought into view.
public bool AutomaticallySelectFirstResult { get; set; }Gets or sets a value indicating whether the current search operation should be cancelled.
public static bool Cancel { get; set; }Gets or sets a value indicating whether search will be case sensitive or case insensitive.
public bool CaseSensitive { get; set; }Gets or sets a value indicating whether to close the search row when escape key is pressed.
public bool CloseOnEscape { get; set; }Gets or sets the CompareOptions that will be used for case insensitive searches.
public CompareOptions CompareOptions { get; set; }Gets or sets the culture that will be used for case insensitive searches.
public CultureInfo Culture { get; set; }Gets the index of the currently selected search result.
public int CurrentResultIndex { get; }Gets the current count of search results. This number changes as new results are found.
public int CurrentSearchResultsCount { get; }Gets or sets a value indicating whether the grid will wait until the Enter key is pressed before it starts a search.
public bool DeferredSearch { get; set; }Gets or sets a value indicating whether search results should be highlighted in the grid.
public bool HighlightResults { get; set; }Gets or sets a value indicating the number of results that will be returned one at a time by the search mechanism.
public int InitialSearchResultsTreshold { get; set; }Gets or sets a value indicating whether the search will be performed on a background thread (true) or on the main thread (false).
public bool IsSearchAsync { get; set; }Gets a value indicating if there is an ongoing search operation at the moment.
public bool IsSearching { get; }Gets a value indicating whether the search functionality is suspended.
public bool IsSearchSuspended { get; }Gets the type of the GridRowElement used to visualize this search row.
public override Type RowElementType { get; }Overrides:
Gets the current/last search criteria.
public string SearchCriteria { get; }Gets or sets a value indicating how long the grid will wait after a key is pressed until it starts a search operation.
public int SearchDelay { get; set; }Gets or sets a value indicating whether search will start from current position.
public bool SearchFromCurrentPosition { get; set; }Gets or sets a value indicating the number of search results that will be returned as a group after the InitialSearchResultsTreshold has been reached.
public int SearchResultsGroupSize { get; set; }Gets or sets a value indicating whether to show the clear button in the search row.
public bool ShowClearButton { get; set; }Gets or sets a value indicating whether to show the close button in the search row.
public bool ShowCloseButton { get; set; }Methods
Compares this search row with another system row to determine the relative positioning.
protected override int CompareToSystemRowInfo(GridViewSystemRowInfo row)The system row to compare with.
Returns:An integer indicating the relative position of this row compared to the specified row.
Overrides:
Creates and configures the background worker used for asynchronous search operations.
protected virtual BackgroundWorker CreateBackgroundWorker()A configured BackgroundWorker instance for search operations.
Creates a paged traverser for iterating through grid rows when paging is enabled.
protected virtual IEnumerator CreatePagedTraverser(bool grouped)Indicates whether the grid is grouped.
Returns:An IEnumerator for paged row traversal.
Creates a traverser for iterating through grid rows.
protected virtual GridTraverser CreateTraverser()A GridTraverser configured for row traversal.
Ensures that the page containing the specified row is visible when paging is enabled.
protected virtual bool EnsurePageVisible(GridViewRowInfo row)The row to make visible.
Returns:True if the page was changed; otherwise, false.
Ensures that the view containing the specified row is visible in hierarchical scenarios.
protected virtual bool EnsureViewInfoVisible(GridViewRowInfo row)The row to make visible.
Returns:True if the view was made visible; otherwise, false.
Gets the formatted value of a cell for search purposes.
public virtual string GetCellFormattedValue(GridViewRowInfo row, GridViewColumn column)The row containing the cell.
columnGridViewColumnThe column containing the cell.
Returns:The formatted string value of the cell.
Gets the traverser column index of the current cell.
protected virtual int GetCurrentCellTraverserColumnIndex()The zero-based traverser column index of the current cell, or -1 if not found.
Gets the traverser row index of the current cell.
protected virtual int GetCurrentCellTraverserRowIndex()The zero-based traverser row index of the current cell, or -1 if not found.
Determines whether the specified cell matches the search criteria.
protected virtual bool MatchesSearchCriteria(string searchCriteria, GridViewRowInfo row, GridViewColumn col)The search criteria to match against.
rowGridViewRowInfoThe row containing the cell to check.
colGridViewColumnThe column containing the cell to check.
Returns:True if the cell matches the search criteria; otherwise, false.
Raises the PropertyChanged event and handles specific property changes.
protected override void OnPropertyChanged(PropertyChangedEventArgs e)The event arguments containing property change information.
Overrides:
Raises the SearchProgressChanged event.
protected virtual void OnSearchProgressChanged(SearchProgressChangedEventArgs e)The SearchProgressChangedEventArgs instance containing the event data.
Reports the progress of the search operation and updates the search results.
protected virtual void ReportSearchProgress(int percent, GridSearchResultCellInfo resultCell, GridSearchResultCellCollection resultCells)The completion percentage of the search operation.
resultCellGridSearchResultCellInfoA single search result cell to add to the results.
resultCellsGridSearchResultCellCollectionA collection of search result cells to add to the results.
Resumes the search functionality after it has been suspended through the SuspendSearch() method.
public void ResumeSearch()Resumes the search functionality after it has been suspended through the SuspendSearch() method.
public void ResumeSearch(bool performSearch)Indicates whether a search should be started after search is resumed.
Initiates a search operation with the specified criteria.
Selects and navigates to the next search result in the collection.
public virtual void SelectNextSearchResult()Selects and navigates to the previous search result in the collection.
public virtual void SelectPreviousSearchResult()Sets the current cell to the specified search result cell, with optional thread-safe invocation.
protected virtual void SetCurrent(GridSearchResultCellInfo cell, bool checkInvokeRequired)The search result cell to set as current.
checkInvokeRequiredboolIndicates whether to check if invocation is required for thread safety.
Sets the current cell to the specified search result cell and ensures it's visible.
protected virtual void SetCurrent(GridSearchResultCellInfo cell)The search result cell to set as current.
Suspends the search functionality. While suspended no searches will be started.
public void SuspendSearch()Traverses through all rows in the grid to find matches for the search criteria.
protected virtual void TraverseRows(DoWorkEventArgs e = null)The DoWorkEventArgs instance containing the event data for background operations.
Events
Occurs when the search progress changes during a search operation.
public event SearchProgressChangedEventHandler SearchProgressChanged