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 view info.

Properties

AllowedStates

Gets the allowed states.

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

The allowed states.
Overrides

AutomaticallySelectFirstResult

Determines if the first found cell will be selected and brough into view.

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

Cancel

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

CaseSensitive

Gets or sets a value indicating whether serach 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

The close on escape.

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 seraches.

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 grid will wait until enter key is pressed before it starts a search.

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

HighlightResults

Gets or sets whether search results should be highlighted.

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 wheather 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 for current GridViewRowInfo.

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.

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

SearchFromCurrentPosition

Gets or sets a value indicating whether serach 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.

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

The show clear button.

ShowCloseButton

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

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

The show close button.

Methods

CompareToSystemRowInfo(GridViewSystemRowInfo)

Compares with the system row info.

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

The row.
Returns
System.Int32

Overrides

CreateBackgroundWorker()

Creates the background worker.

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

CreatePagedTraverser(Boolean)

Creates the paged traverser.

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

The grouped.
Returns
System.Collections.IEnumerator

CreateTraverser()

Creates the traverser.

Declaration
protected virtual GridTraverser CreateTraverser()
Returns
GridTraverser

EnsurePageVisible(GridViewRowInfo)

Ensures the page visible.

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

The row.
Returns
System.Boolean

EnsureViewInfoVisible(GridViewRowInfo)

Ensures the page visible.

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

The row.
Returns
System.Boolean

GetCellFormattedValue(GridViewRowInfo, GridViewColumn)

Gets the cell formatted value.

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

The row.
GridViewColumn column

The column.
Returns
System.String

GetCurrentCellTraverserColumnIndex()

Gets the index of the current cell traverser column.

Declaration
protected virtual int GetCurrentCellTraverserColumnIndex()
Returns
System.Int32

GetCurrentCellTraverserRowIndex()

Gets the index of the current cell traverser row.

Declaration
protected virtual int GetCurrentCellTraverserRowIndex()
Returns
System.Int32

MatchesSearchCriteria(String, GridViewRowInfo, GridViewColumn)

Returns whether the cell matches the search criteria.

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

The search criteria.
GridViewRowInfo row

The row.
GridViewColumn col

The col.
Returns
System.Boolean

OnPropertyChanged(PropertyChangedEventArgs)

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

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 search progress.

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

The percent.
GridSearchResultCellInfo resultCell

The result cell.
GridSearchResultCellCollection resultCells

The result cells.

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

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

Search(String)

Searches the specified criteria.

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

The criteria.

SelectNextSearchResult()

Selects the next search result.

Declaration
public virtual void SelectNextSearchResult()

SelectPreviousSearchResult()

Selects the previous search result.

Declaration
public virtual void SelectPreviousSearchResult()

SetCurrent(GridSearchResultCellInfo)

Sets the current.

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

The cell.

SetCurrent(GridSearchResultCellInfo, Boolean)

Sets the current.

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

The cell.
System.Boolean checkInvokeRequired

The check invoke required.

SuspendSearch()

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

Declaration
public void SuspendSearch()

TraverseRows(DoWorkEventArgs)

Traverses the rows.

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

The System.ComponentModel.DoWorkEventArgs instance containing the event data.

Events

SearchProgressChanged

Occurs when the search progress is changed.

Declaration
public event SearchProgressChangedEventHandler SearchProgressChanged
Event Type
SearchProgressChangedEventHandler

Explicit Interface Implementations

IGridViewEventListener.AnalyzeQueue(List<GridViewEvent>)

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

Returns
System.Boolean

Implements

IGridViewEventListener.DesiredEvents

Declaration
GridEventType IGridViewEventListener.DesiredEvents { get; }
Returns
GridEventType

Implements

IGridViewEventListener.DesiredProcessMode

Declaration
GridEventProcessMode IGridViewEventListener.DesiredProcessMode { get; }
Returns
GridEventProcessMode

Implements

IGridViewEventListener.PostProcessEvent(GridViewEvent)

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

Returns
GridViewEventResult

Implements

IGridViewEventListener.PreProcessEvent(GridViewEvent)

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

Returns
GridViewEventResult

Implements

IGridViewEventListener.Priority

Declaration
EventListenerPriority IGridViewEventListener.Priority { get; }
Returns
EventListenerPriority

Implements

IGridViewEventListener.ProcessEvent(GridViewEvent)

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

Returns
GridViewEventResult

Implements

Extension Methods