Skip to main content

TdxCustomMapItemLayer.GetItemHint(TdxMapItem) Method

Obtains the hint message for a specified map item.

Declaration

function GetItemHint(AItem: TdxMapItem): string;

Parameters

Name Type
AItem TdxMapItem

Returns

Type
string

Remarks

This function is called by a map item’s GetHint function to obtain a hint message for a map item (AItem) whose Hint property is assigned an empty string. The GetItemHint function fires the OnGetItemHint event and passes the default hint message specified by the ItemHint property and AItem as the event parameters. You can handle the event to customize the hint message. The resulting hint message is returned as the GetItemHint function’s result.

See Also