PM_TreeListToolTipGet

Note: This page includes content based on the F1 documentation for Centura development. It may be partially converted to support APF development, but should be regarded to be of uncertain actuality. It is provided as is. Eventually, it should be replaced by documentation available from within Visual Studio.

Const.PM_TreeListToolTipGet

The Const.PM_TreeListToolTipGet message is sent to a cTreeListBox to retrieve the tool tip text for a node.

Parameters

Name Description
nType = wParamNode type of the node to retrieve the tool tip text for.
hItem = lParamItem handle of the node to retrieve the tool tip text for.

Returns

Application should return a string handle to the tooltip text if processing this message.

Comments

If applications do not process this message, the framework will use the displayed text as the tool tip text.

Example

This example shows how an application overrides the Const.PM_TreeListToolTipGet message to specify a non-default tooltip text.

On PM_TreeListToolTipGet
   Call TreeListNodeGet( hItem, msgNodeData )
   Return SalHStringToNumber( msgNodeData.GetAttribute( 'NAME' ) 
          || ' - ' || msgNodeData.GetAttribute( 'COMMENTS' ) )
C# coding
public SalNumber __OnPmTreeListToolTipGet(SalNumber nNodeType, SalNumber hItem)
{
	#region Local Variables
	cMessage msgNodeData = new cMessage();
	#endregion
	
	#region Actions
	using (new SalContext(this))
	{
		TreeListNodeGet(hItem, msgNodeData);
		return msgNodeData.FindAttribute(_GetDisplayAttr(nNodeType), 
SalString.Null).ToHandle(); } #endregion }