Class

GridViewSearchRowInfo

Initializes a new instance of the GridViewSearchRowInfo class.

Declaration

public GridViewSearchRowInfo(GridViewInfo viewInfo)

Parameters

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

Declaration

public override AllowedGridViewRowInfoStates AllowedStates { get; }

Property Value

Overrides GridViewRowInfo.AllowedStates

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

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

Declaration

public static bool Cancel { get; set; }

Property Value

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

Declaration

public bool CaseSensitive { get; set; }

Property Value

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

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

Declaration

public CompareOptions CompareOptions { get; set; }

Property Value

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

Declaration

public CultureInfo Culture { get; set; }

Property Value

Gets the index of the currently selected search result.

Declaration

public int CurrentResultIndex { get; }

Property Value

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

Declaration

public int CurrentSearchResultsCount { get; }

Property Value

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

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

Declaration

public bool HighlightResults { get; set; }

Property Value

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

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

Gets a value indicating whether the search functionality is suspended.

Declaration

public bool IsSearchSuspended { get; }

Property Value

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

Declaration

public bool IsSearching { get; }

Property Value

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

Declaration

public override Type RowElementType { get; }

Property Value

Overrides GridViewRowInfo.RowElementType

Gets the current/last search criteria.

Declaration

public string SearchCriteria { get; }

Property Value

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

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

Declaration

public bool SearchFromCurrentPosition { get; set; }

Property Value

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

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

Declaration

public bool ShowClearButton { get; set; }

Property Value

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

Declaration

public bool ShowCloseButton { get; set; }

Property Value

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

Declaration

protected override int CompareToSystemRowInfo(GridViewSystemRowInfo row)

Parameters

Returns

Overrides GridViewSystemRowInfo.CompareToSystemRowInfo(GridViewSystemRowInfo)

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

Declaration

protected virtual BackgroundWorker CreateBackgroundWorker()

Returns

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

Declaration

protected virtual IEnumerator CreatePagedTraverser(bool grouped)

Parameters

Returns

Creates a traverser for iterating through grid rows.

Declaration

protected virtual GridTraverser CreateTraverser()

Returns

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

Declaration

protected virtual bool EnsurePageVisible(GridViewRowInfo row)

Parameters

Returns

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

Declaration

protected virtual bool EnsureViewInfoVisible(GridViewRowInfo row)

Parameters

Returns

Gets the formatted value of a cell for search purposes.

Declaration

public virtual string GetCellFormattedValue(GridViewRowInfo row, GridViewColumn column)

Parameters

Returns

Gets the traverser column index of the current cell.

Declaration

protected virtual int GetCurrentCellTraverserColumnIndex()

Returns

Gets the traverser row index of the current cell.

Declaration

protected virtual int GetCurrentCellTraverserRowIndex()

Returns

Determines whether the specified cell matches the search criteria.

Declaration

protected virtual bool MatchesSearchCriteria(string searchCriteria, GridViewRowInfo row, GridViewColumn col)

Parameters

Returns

Raises the PropertyChanged event and handles specific property changes.

Declaration

protected override void OnPropertyChanged(PropertyChangedEventArgs e)

Parameters

Overrides GridViewRowInfo.OnPropertyChanged(PropertyChangedEventArgs)

Raises the SearchProgressChanged event.

Declaration

protected virtual void OnSearchProgressChanged(SearchProgressChangedEventArgs e)

Parameters

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

Declaration

protected virtual void ReportSearchProgress(int percent, GridSearchResultCellInfo resultCell, GridSearchResultCellCollection resultCells)

Parameters

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

Declaration

public void ResumeSearch()

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

Declaration

public void ResumeSearch(bool performSearch)

Parameters

Initiates a search operation with the specified criteria.

Declaration

public virtual void Search(string criteria)

Parameters

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

Declaration

public virtual void SelectNextSearchResult()

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

Declaration

public virtual void SelectPreviousSearchResult()

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

Declaration

protected virtual void SetCurrent(GridSearchResultCellInfo cell)

Parameters

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

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

Declaration

public void SuspendSearch()

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

Declaration

protected virtual void TraverseRows(DoWorkEventArgs e = null)

Parameters

Occurs when the search progress changes during a search operation.

Declaration

public event SearchProgressChangedEventHandler SearchProgressChanged

Event Value