ChoiceActionItem.GetCaptionPath() Method

Returns a full caption path from the current Item to the ChoiceActionBase.Items collection's first-level parent Item.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v18.1.dll

Syntax

public string GetCaptionPath()

Returns

Type Description
String

A string containing a chain of item captions from the current Item to the root parent Item, separated by the slash character.

Each ChoiceActionItem can have a collection of ChoiceActionItems, each of which can also have a collection of ChoiceActionItems, and so on. The entire Items collection of a ChoiceAction can contain two or more ChoiceActionItems with the same captions. You can uniquely identify an item via the GetCaptionPath method. For instance, if "Item121" is the current Item's caption, the GetCaptionPath method return value can be "Item1/Item12/Item121".

To access a ChoiceActionItem using its full caption path, use the SingleChoiceAction.FindItemByCaptionPath method.