This documentation is for the old version. Go to the latest Graphics Mill docs

ListItem.GetIconKey Method

Returns a key of the item icon for the specified View of the VirtualListView control.

Namespace: Aurigma.GraphicsMill.WinControls
Assembly: Aurigma.GraphicsMill.WinControls (in Aurigma.GraphicsMill.WinControls.dll)

Syntax

Visual Basic

Public MustOverride Function GetIconKey ( _
	view As View _
) As Object

public abstract Object GetIconKey(
	View view
)

Parameters

view: Type: Aurigma.GraphicsMill.WinControls.View
A View enumeration member identifying the view mode to extract an icon key for.

Return Value

A key of the item icon in one of the control image lists. The image list depends on the specified view parameter. If the item has no icon for the specified view, null is returned.

Implements

IListItem.GetIconKey(View)

Remarks

Although the return value null means that no icon is available, if you try to get an icon later, you may find out that it returns a correct index of the icon. This fact is explained by an asynchronous nature of item loading. Potentially, you can call this method before the control loads the item, and therefore it cannot return an icon. However, after you try to retrieve this item, its priority is increased (it is moved to the head of the item queue), and you can get the icon as soon as possible.