DescriptionOnMenu Property (ListToolItem)

Gets or sets a string that contains formatted text that should be displayed beneath the caption of the item to provide additional information when it is displayed on a menu.

Syntax

Visual Basic

'Declaration
 
Public Property DescriptionOnMenu As String

C#

public string DescriptionOnMenu {get; set;}

Remarks

Note: When setting this property, the new description is parsed using the Infragistics.Win.FormattedLinkLabel.ParsedFormattedTextValue.Parse(System.Object,Infragistics.Win.FormattedLinkLabel.ParsedFormattedTextValue.ValueType,System.Exception@) method. Many different exceptions can be thrown by this method depending on the assigned value. See the remarks of the Parse method for details on these exceptions.

Note: This property must be assigned formatted text. If raw text is to be assigned to this property, pass the raw text into Infragistics.Win.FormattedLinkLabel.ParsedFormattedTextValue.EscapeXML(System.String) to convert the raw text to formatted text, then assign the return value to this property.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2