Skip to main content
All docs
V25.1
  • DevExpress v25.1 Update — Your Feedback Matters

    Our What's New in v25.1 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

    Take the survey Not interested

    VGridControlBase.CustomizationFormSearch Event

    Allows you to filter search results when a user searches in the Customization Form.

    Namespace: DevExpress.XtraVerticalGrid

    Assembly: DevExpress.XtraVerticalGrid.v25.1.dll

    NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.VerticalGrid

    #Declaration

    [DXCategory("Action")]
    public event CustomizationFormSearchEventHandler CustomizationFormSearch

    #Event Data

    The CustomizationFormSearch event's data class is CustomizationFormSearchEventArgs. The following properties provide information specific to this event:

    Property Description
    Caption Gets the caption of the processed row or category.
    Row Gets the processed row.
    SearchText Gets the search string.
    Visible Gets or sets the visibility of the processed row or category.

    #Remarks

    The Customization Form search box allows users to locate rows and categories by their captions.

    The default search algorithm locates rows/categories that contain the search string in their captions. If a row caption matches the search string, this row is displayed with its owner category.

    Handle the CustomizationFormSearch event to change the search logic. The VGridControl raises this event for each item (row or category) displayed in the Customization Form on each change to the search string.

    #Example

    The following example handles the CustomizationFormSearch event to change the Contains comparison operator to StartsWith:

    vGridControl.CustomizationFormSearch += (s, e) => {
        e.Visible = e.Caption.StartsWith(e.SearchText, StringComparison.OrdinalIgnoreCase);
    };
    
    See Also