Skip to main content

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

TdxOfficeSearchBoxProperties.GetPaths(TObject,Char) Method

Returns all paths to a specific UI item within the current search source.

#Declaration

Delphi
function GetPaths(ASourceItem: TObject; const APathDelimiter: Char = dxOfficeSearchBoxDefaultPathDelimiter): TStringList; virtual;

#Parameters

Name Type
ASourceItem TObject
APathDelimiter Char

#Returns

Type
TStringList

#Remarks

A path consists of UI items (delimited via customizable character) that a user has to click to navigate to the target item. Each bar- or ribbon-based application UI can contain the same item in different toolbars (for instance, in a ribbon group and the Quick Access Toolbar), that is, the item can have several links.

You can call this function within the OnDropDownMenuItemAdded event handler to obtain valid paths to ASourceItem as a string list and choose any of them. The GetPaths function uses the dxOfficeSearchBoxDefaultPathDelimiter global constant value as the APathDelimiter parameter if you omit a custom delimiter character.

Depending on a search source, the path can include:

Search Source

Path Description

Bar Manager

The captions of the corresponding toolbar and its items.

Ribbon

The names of the tab, group, and submenu items.

See Also