Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 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

SmartSearchBehaviorProperties.ItemDescriptions Property

Gets a collection of item descriptions.

Namespace: DevExpress.AIIntegration.WinForms

Assembly: DevExpress.AIIntegration.WinForms.v24.2.dll

NuGet Package: DevExpress.AIIntegration.WinForms

#Declaration

[Browsable(false)]
public List<AIItemDescription> ItemDescriptions { get; }

#Property Value

Type Description
List<DevExpress.AIIntegration.WinForms.AIItemDescription>

The collection of item descriptions.

#Remarks

Once you attach the SmartSearchBehavior to a control, you should describe items so that Smart Search can find appropriate items. In the context of Smart Search, an item refers to a BarItem when working with a RibbonControl, or an AccordionControlElement when working with an AccordionControl.

Note

Item descriptions are optional if an item’s text or caption is specified (for example, a bar item’s Caption property or accordion UI element’s Text property is set to a non-empty string). Although Smart Search attempts to find items based on their text/caption, we recommend that you also describe items for improved accuracy.

Use the ItemDescriptions collection property to add descriptions (AIItemDescription) for certain items. Each AIItemDescription object in the collection has two properties:

  1. AIItemDescription.Item: An item (BarItem or AccordionControlElement).
  2. AIItemDescription.Description: A string that describes the item.
using DevExpress.AIIntegration.WinForms;
using DevExpress.XtraBars.Ribbon;

public Form1() {
    InitializeComponent();
    // Displays a search box in the Ribbon control's caption.
    ribbon.OptionsSearchMenu.SearchItemPosition = SearchItemPosition.Caption;

    behaviorManager1.Attach<SmartSearchBehavior>(ribbon, behavior => {
        behavior.Properties.ItemDescriptions.AddRange(new AIItemDescription[]{
            new AIItemDescription(itemEnableSystemProtection, "Activates software protection against unauthorized access."),
            new AIItemDescription(itemLogin, "Displays a sign-in or login form."),
            new AIItemDescription(itemSettings, "Displays settings and options related to security and protection."),
            new AIItemDescription(itemRBAC, "Manages user access permissions and role-based access control (RBAC)."),
            new AIItemDescription(itemBackup, "Backs up (creates a copy of) sensitive data (information)."),
            new AIItemDescription(itemRestore, "Restores data from a backup database."),
        });
    });
}

Tip

Read the following help topic for additional information: AI-powered Smart Search.

See Also