API Documentation -> NtApplication -> NtGetTooltipText

# NtApplication.NtGetTooltipText Method

The NtTimeChartControl calls this method whenever it wants to create a tooltip for a NtDisplayObject (which is the object that is drawn on the screen in behalf of the NtDataObject). You should implement this method and use the NtDataObject reference contained in that NtDisplayObject to create a tooltip text. Depending on the ttType this should be either a plain text or a HTML string that is then shown as tooltip contents.
Please see the tutorial Tooltips on how to create tooltips for your solution using a NtTimeChartControl.

Overload List:

Modifier / Return Value | Name and Parameters | Description
--- | --- | ---
bool | NtGetTooltipText ( NtDisplayObject tooltipDisplayObject, int ttType ) | Your implementation of this method should return the tool tip text depending on the ttType.

Return value:

string
If ttType is 0 no tooltip will be displayed at all. Return an empty string.
If ttType is 1 a plain text tooltip will be displayed. Return a simple string with no formatting except new lines and tabs.
If ttType is 2 create and return a string that makes up a full HTML body. This will be rendered as a tooltip.
Returning null will result in the tooltip not being shown. On this way your application can always decide not to show a tooltip for a certain data object at a certain time.

Parameters:

int ttType
The tooltip type. The way how a certain type of data is being displayed within the NtTimeChartControl is determined by the NtDisplayDef that is provided for that data type. Among other information the NtDisplayDef also contains a tooltip type that determines what kind of tooltip has to be shown for this data type.

Remarks:

Depending on the different NtDisplayDefs that are set up for the various data types it is absolutely normal to have various tooltip options combined in one Time Chart: For some data types there might be HTML tooltips, for some only simple tooltips and for some no tooltips at all.

Top API Documentation -> NtApplication -> NtGetTooltipText © 2016 Bassaly