ImageComboBoxItemCollection.GetItemDescription(Object) Method

Gets the text representation of the specified item.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public override string GetItemDescription(
    object item
)

VB.NET

Public Overrides Function GetItemDescription(
    item As Object
) As String

Parameters

Name	Type	Description
item	Object	The item for which to return its text representation.

Returns

Type	Description
String	The string representing the specified item.

Remarks

The GetItemDescription method returns the text representation of the specified item. The item parameter should specify an instance of the ImageComboBoxItem class. If so, the function returns the value of the ImageComboBoxItem.Description property. If item is not an ImageComboBoxItem instance, the function returns an empty string.

GetItemDescription is used internally by the combo box editor to get strings to display in the dropdown list and edit box. You can use GetItemDescription, for instance, when performing custom draw in the RepositoryItemComboBox.DrawItem event.