Autodesk Vault ProfessionalVault API

GetHotCellToolTip Method

Autodesk.DataManagement.Client.Framework.Vault.Forms.InterfacesIHotCellHandler

Get the tool tip to use when the HotCell is hovered over.

Syntax

System.string GetHotCellToolTip(
   IEntity entity,
   PropertyDefinition propDef,
   System.object currentValue,
   System.string currentToolTip
)
Function GetHotCellToolTip( _
   ByVal entity As IEntity, _
   ByVal propDef As PropertyDefinition, _
   ByVal currentValue As System.Object, _
   ByVal currentToolTip As System.String _
) As System.String

Parameters

NameDescription
entityThe Autodesk.DataManagement.Client.Framework.Vault.Currency.Entities.IEntity of the row in question.
propDefThe Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.PropertyDefinition of the column in question.
currentValueThe current value of the hot cell.
currentToolTipThe current tooltip.

Return Value

The string to use as the tooltip.

Remarks

This is useful when indicating to users that this cell is a hot cell by customizing the standard tooltip with text like "CTRL + click to edit".

See Also