Class GridViewSearchRowInfo

Represents the data row associated with the search functionality of RadGridView.

Inheritance
System.Object
GridViewRowInfo
GridViewSystemRowInfo
GridViewSearchRowInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class GridViewSearchRowInfo : GridViewSystemRowInfo, IDataItem, IHierarchicalRow, INotifyPropertyChanged, INotifyPropertyChangingEx, IDisposable, IComparable<GridViewSystemRowInfo>, IGridViewEventListener

Constructors

GridViewSearchRowInfo(GridViewInfo)

Initializes a new instance of the GridViewSearchRowInfo class.

Declaration
public GridViewSearchRowInfo(GridViewInfo viewInfo)
Parameters
GridViewInfo viewInfo

The grid view info that this search row belongs to.

Properties

AllowedStates

Gets the allowed states for this search row. Search rows do not support any special states.

Declaration
public override AllowedGridViewRowInfoStates AllowedStates { get; }
Property Value
AllowedGridViewRowInfoStates

Overrides

AutomaticallySelectFirstResult

Gets or sets a value indicating whether the first found cell will be automatically selected and brought into view.

Declaration
public bool AutomaticallySelectFirstResult { get; set; }
Property Value
System.Boolean

Cancel

Gets or sets a value indicating whether the current search operation should be cancelled.

Declaration
public static bool Cancel { get; set; }
Property Value
System.Boolean

CaseSensitive

Gets or sets a value indicating whether search will be case sensitive or case insensitive.

Declaration
public bool CaseSensitive { get; set; }
Property Value
System.Boolean

CloseOnEscape

Gets or sets a value indicating whether to close the search row when escape key is pressed.

Declaration
public bool CloseOnEscape { get; set; }
Property Value
System.Boolean

CompareOptions

Gets or sets the CompareOptions that will be used for case insensitive searches.

Declaration
public CompareOptions CompareOptions { get; set; }
Property Value
System.Globalization.CompareOptions

Culture

Gets or sets the culture that will be used for case insensitive searches.

Declaration
public CultureInfo Culture { get; set; }
Property Value
System.Globalization.CultureInfo

CurrentResultIndex

Gets the index of the currently selected search result.

Declaration
public int CurrentResultIndex { get; }
Property Value
System.Int32

CurrentSearchResultsCount

Gets the current count of search results. This number changes as new results are found.

Declaration
public int CurrentSearchResultsCount { get; }
Property Value
System.Int32

DeferredSearch

Gets or sets a value indicating whether the grid will wait until the Enter key is pressed before it starts a search.

Declaration
public bool DeferredSearch { get; set; }
Property Value
System.Boolean

HighlightResults

Gets or sets a value indicating whether search results should be highlighted in the grid.

Declaration
public bool HighlightResults { get; set; }
Property Value
System.Boolean

InitialSearchResultsTreshold

Gets or sets a value indicating the number of results that will be returned one at a time by the search mechanism.

Declaration
public int InitialSearchResultsTreshold { get; set; }
Property Value
System.Int32

IsSearchAsync

Gets or sets a value indicating whether the search will be performed on a background thread (true) or on the main thread (false).

Declaration
public bool IsSearchAsync { get; set; }
Property Value
System.Boolean

IsSearching

Gets a value indicating if there is an ongoing search operation at the moment.

Declaration
public bool IsSearching { get; }
Property Value
System.Boolean

IsSearchSuspended

Gets a value indicating whether the search functionality is suspended.

Declaration
public bool IsSearchSuspended { get; }
Property Value
System.Boolean

RowElementType

Gets the type of the GridRowElement used to visualize this search row.

Declaration
public override Type RowElementType { get; }
Property Value
System.Type

Overrides

SearchCriteria

Gets the current/last search criteria.

Declaration
public string SearchCriteria { get; }
Property Value
System.String

SearchDelay

Gets or sets a value indicating how long the grid will wait after a key is pressed until it starts a search operation.

Declaration
public int SearchDelay { get; set; }
Property Value
System.Int32

SearchFromCurrentPosition

Gets or sets a value indicating whether search will start from current position.

Declaration
public bool SearchFromCurrentPosition { get; set; }
Property Value
System.Boolean

SearchResultsGroupSize

Gets or sets a value indicating the number of search results that will be returned as a group after the InitialSearchResultsTreshold has been reached.

Declaration
public int SearchResultsGroupSize { get; set; }
Property Value
System.Int32

ShowClearButton

Gets or sets a value indicating whether to show the clear button in the search row.

Declaration
public bool ShowClearButton { get; set; }
Property Value
System.Boolean

ShowCloseButton

Gets or sets a value indicating whether to show the close button in the search row.

Declaration
public bool ShowCloseButton { get; set; }
Property Value
System.Boolean

Methods

CompareToSystemRowInfo(GridViewSystemRowInfo)

Compares this search row with another system row to determine the relative positioning.

Declaration
protected override int CompareToSystemRowInfo(GridViewSystemRowInfo row)
Parameters
GridViewSystemRowInfo row

The system row to compare with.
Returns
System.Int32

An integer indicating the relative position of this row compared to the specified row.
Overrides

CreateBackgroundWorker()

Creates and configures the background worker used for asynchronous search operations.

Declaration
protected virtual BackgroundWorker CreateBackgroundWorker()
Returns
System.ComponentModel.BackgroundWorker

A configured System.ComponentModel.BackgroundWorker instance for search operations.

CreatePagedTraverser(Boolean)

Creates a paged traverser for iterating through grid rows when paging is enabled.

Declaration
protected virtual IEnumerator CreatePagedTraverser(bool grouped)
Parameters
System.Boolean grouped

Indicates whether the grid is grouped.
Returns
System.Collections.IEnumerator

An System.Collections.IEnumerator for paged row traversal.

CreateTraverser()

Creates a traverser for iterating through grid rows.

Declaration
protected virtual GridTraverser CreateTraverser()
Returns
GridTraverser

A GridTraverser configured for row traversal.

EnsurePageVisible(GridViewRowInfo)

Ensures that the page containing the specified row is visible when paging is enabled.

Declaration
protected virtual bool EnsurePageVisible(GridViewRowInfo row)
Parameters
GridViewRowInfo row

The row to make visible.
Returns
System.Boolean

True if the page was changed; otherwise, false.

EnsureViewInfoVisible(GridViewRowInfo)

Ensures that the view containing the specified row is visible in hierarchical scenarios.

Declaration
protected virtual bool EnsureViewInfoVisible(GridViewRowInfo row)
Parameters
GridViewRowInfo row

The row to make visible.
Returns
System.Boolean

True if the view was made visible; otherwise, false.

GetCellFormattedValue(GridViewRowInfo, GridViewColumn)

Gets the formatted value of a cell for search purposes.

Declaration
public virtual string GetCellFormattedValue(GridViewRowInfo row, GridViewColumn column)
Parameters
GridViewRowInfo row

The row containing the cell.
GridViewColumn column

The column containing the cell.
Returns
System.String

The formatted string value of the cell.

GetCurrentCellTraverserColumnIndex()

Gets the traverser column index of the current cell.

Declaration
protected virtual int GetCurrentCellTraverserColumnIndex()
Returns
System.Int32

The zero-based traverser column index of the current cell, or -1 if not found.

GetCurrentCellTraverserRowIndex()

Gets the traverser row index of the current cell.

Declaration
protected virtual int GetCurrentCellTraverserRowIndex()
Returns
System.Int32

The zero-based traverser row index of the current cell, or -1 if not found.

MatchesSearchCriteria(String, GridViewRowInfo, GridViewColumn)

Determines whether the specified cell matches the search criteria.

Declaration
protected virtual bool MatchesSearchCriteria(string searchCriteria, GridViewRowInfo row, GridViewColumn col)
Parameters
System.String searchCriteria

The search criteria to match against.
GridViewRowInfo row

The row containing the cell to check.
GridViewColumn col

The column containing the cell to check.
Returns
System.Boolean

True if the cell matches the search criteria; otherwise, false.

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event and handles specific property changes.

Declaration
protected override void OnPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

The event arguments containing property change information.
Overrides

OnSearchProgressChanged(SearchProgressChangedEventArgs)

Raises the SearchProgressChanged event.

Declaration
protected virtual void OnSearchProgressChanged(SearchProgressChangedEventArgs e)
Parameters
SearchProgressChangedEventArgs e

The SearchProgressChangedEventArgs instance containing the event data.

ReportSearchProgress(Int32, GridSearchResultCellInfo, GridSearchResultCellCollection)

Reports the progress of the search operation and updates the search results.

Declaration
protected virtual void ReportSearchProgress(int percent, GridSearchResultCellInfo resultCell, GridSearchResultCellCollection resultCells)
Parameters
System.Int32 percent

The completion percentage of the search operation.
GridSearchResultCellInfo resultCell

A single search result cell to add to the results.
GridSearchResultCellCollection resultCells

A collection of search result cells to add to the results.

ResumeSearch()

Resumes the search functionality after it has been suspended through the SuspendSearch() method.

Declaration
public void ResumeSearch()

ResumeSearch(Boolean)

Resumes the search functionality after it has been suspended through the SuspendSearch() method.

Declaration
public void ResumeSearch(bool performSearch)
Parameters
System.Boolean performSearch

Indicates whether a search should be started after search is resumed.

Search(String)

Initiates a search operation with the specified criteria.

Declaration
public virtual void Search(string criteria)
Parameters
System.String criteria

The search criteria to use.

SelectNextSearchResult()

Selects and navigates to the next search result in the collection.

Declaration
public virtual void SelectNextSearchResult()

SelectPreviousSearchResult()

Selects and navigates to the previous search result in the collection.

Declaration
public virtual void SelectPreviousSearchResult()

SetCurrent(GridSearchResultCellInfo)

Sets the current cell to the specified search result cell and ensures it's visible.

Declaration
protected virtual void SetCurrent(GridSearchResultCellInfo cell)
Parameters
GridSearchResultCellInfo cell

The search result cell to set as current.

SetCurrent(GridSearchResultCellInfo, Boolean)

Sets the current cell to the specified search result cell, with optional thread-safe invocation.

Declaration
protected virtual void SetCurrent(GridSearchResultCellInfo cell, bool checkInvokeRequired)
Parameters
GridSearchResultCellInfo cell

The search result cell to set as current.
System.Boolean checkInvokeRequired

Indicates whether to check if invocation is required for thread safety.

SuspendSearch()

Suspends the search functionality. While suspended no searches will be started.

Declaration
public void SuspendSearch()

TraverseRows(DoWorkEventArgs)

Traverses through all rows in the grid to find matches for the search criteria.

Declaration
protected virtual void TraverseRows(DoWorkEventArgs e = null)
Parameters
System.ComponentModel.DoWorkEventArgs e

The System.ComponentModel.DoWorkEventArgs instance containing the event data for background operations.

Events

SearchProgressChanged

Occurs when the search progress changes during a search operation.

Declaration
public event SearchProgressChangedEventHandler SearchProgressChanged
Event Type
SearchProgressChangedEventHandler

Explicit Interface Implementations

IGridViewEventListener.AnalyzeQueue(List<GridViewEvent>)

Analyzes a queue of events to determine if any special processing is required.

Declaration
bool IGridViewEventListener.AnalyzeQueue(List<GridViewEvent> events)
Parameters
System.Collections.Generic.List<GridViewEvent> events

The list of events to analyze.
Returns
System.Boolean

True if special processing is required; otherwise, false.
Implements

IGridViewEventListener.DesiredEvents

Gets the types of grid events that this listener is interested in receiving.

Declaration
GridEventType IGridViewEventListener.DesiredEvents { get; }
Returns
GridEventType

Implements

IGridViewEventListener.DesiredProcessMode

Gets the desired process mode for event handling.

Declaration
GridEventProcessMode IGridViewEventListener.DesiredProcessMode { get; }
Returns
GridEventProcessMode

Implements

IGridViewEventListener.PostProcessEvent(GridViewEvent)

Post-processes grid events after they have been handled by other listeners.

Declaration
GridViewEventResult IGridViewEventListener.PostProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The grid event data to process.
Returns
GridViewEventResult

A GridViewEventResult indicating how the event should be handled.
Implements

IGridViewEventListener.PreProcessEvent(GridViewEvent)

Pre-processes grid events before they are handled by other listeners.

Declaration
GridViewEventResult IGridViewEventListener.PreProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The grid event data to process.
Returns
GridViewEventResult

A GridViewEventResult indicating how the event should be handled.
Implements

IGridViewEventListener.Priority

Gets the priority level of this event listener.

Declaration
EventListenerPriority IGridViewEventListener.Priority { get; }
Returns
EventListenerPriority

Implements

IGridViewEventListener.ProcessEvent(GridViewEvent)

Processes grid events during the main event handling phase.

Declaration
GridViewEventResult IGridViewEventListener.ProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The grid event data to process.
Returns
GridViewEventResult

A GridViewEventResult indicating how the event should be handled.
Implements

Extension Methods