Pivot.ShowToolTip Method (ExPivot)

Use the ShowToolTip method to display a custom tooltip at specified position or to update the object's tooltip, title or position. You can call the ShowToolTip method during the MouseMove event. Use the ToolTipPopDelay property specifies the period in ms of time the ToolTip remains visible if the mouse pointer is stationary within a control. The ToolTipDelay property specifies the time in ms that passes before the ToolTip appears. Use the ToolTipWidth property to specify the width of the tooltip window. Use the ToolTipFont property to change the tooltip's font. Use the Background(exToolTipAppearance) property indicates the visual appearance of the borders of the tooltips. Use the Background(exToolTipBackColor) property indicates the tooltip's background color. Use the Background(exToolTipForeColor) property indicates the tooltip's foreground color.

For instance:

ShowToolTip(`<null>`,`<null>`,,`+8`,`+8`), shows the tooltip of the object moved relative to its default position
ShowToolTip(`<null>`,`new title`), adds, changes or replaces the title of the object's tooltip
ShowToolTip(`new content`), adds, changes or replaces the object's tooltip
ShowToolTip(`new content`,`new title`), shows the tooltip and title at current position
ShowToolTip(`new content`,`new title`,,`+8`,`+8`), shows the tooltip and title moved relative to the current position
ShowToolTip(`new content`,``,,128,128), displays the tooltip at a fixed position
ShowToolTip(``,``), hides the tooltip

The ToolTip parameter supports the built-in HTML format like follows:

 ...  displays the text in bold
 ...  displays the text in italics
 ...  underlines the text
<s> ... </s> ~~Strike~~-through text
<a id;options> ... </a> displays an anchor element that can be clicked. An anchor is a piece of text or some other object (for example an image) which marks the beginning and/or the end of a hypertext link.The <a> element is used to mark that piece of text (or inline image), and to give its hypertextual relationship to other documents. The control fires the AnchorClick(AnchorID, Options) event when the user clicks the anchor element. The FormatAnchor property customizes the visual effect for anchor elements.
 ...  displays portions of text with a different font and/or different size. For instance, the bit draws the bit text using the Tahoma font, on size 12 pt. If the name of the font is missing, and instead size is present, the current font is used with a different size. For instance, bit displays the bit text using the current font, but with a different size.
<fgcolor rrggbb> ... </fgcolor> or <fgcolor=rrggbb> ... </fgcolor> displays text with a specified foreground color. The rr/gg/bb represents the red/green/blue values of the color in hexa values.
<bgcolor rrggbb> ... </bgcolor> or <bgcolor=rrggbb> ... </bgcolor> displays text with a specified background color. The rr/gg/bb represents the red/green/blue values of the color in hexa values.
<solidline rrggbb> ... </solidline> or <solidline=rrggbb> ... </solidline> draws a solid-line on the bottom side of the current text-line, of specified RGB color. The <solidline> ... </solidline> draws a black solid-line on the bottom side of the current text-line. The rr/gg/bb represents the red/green/blue values of the color in hexa values.
<dotline rrggbb> ... </dotline> or <dotline=rrggbb> ... </dotline> draws a dot-line on the bottom side of the current text-line, of specified RGB color. The <dotline> ... </dotline> draws a black dot-line on the bottom side of the current text-line. The rr/gg/bb represents the red/green/blue values of the color in hexa values.
<upline> ... </upline> draws the line on the top side of the current text-line (requires <solidline> or <dotline>).
<r> right aligns the text
<c> centers the text
  forces a line-break
<img>number[:width]</img> inserts an icon inside the text. The number indicates the index of the icon being inserted. Use the Images method to assign a list of icons to your chart. The last 7 bits in the high significant byte of the number expression indicates the identifier of the skin being used to paint the object. Use the Add method to add new skins to the control. If you need to remove the skin appearance from a part of the control you need to reset the last 7 bits in the high significant byte of the color being applied to the part. The width is optional and indicates the width of the icon being inserted. Using the width option you can overwrite multiple icons getting a nice effect. By default, if the width field is missing, the width is 18 pixels.
<img>key[:width]</img> inserts a custom size picture into the text being previously loaded using the HTMLPicture property. The Key parameter indicates the key of the picture being displayed. The Width parameter indicates a custom size, if you require to stretch the picture, else the original size of the picture is used.
& glyph characters as & ( & ), < ( < ), > ( > ), &qout; ( " ) and &#number; ( the character with specified code ), For instance, the € displays the EUR character. The & ampersand is only recognized as markup when it is followed by a known letter or a #character and a digit. For instance if you want to display bold in HTML caption you can use bold
<off offset> ... </off> defines the vertical offset to display the text/element. The offset parameter defines the offset to display the element. This tag is inheritable, so the offset is keep while the associated </off> tag is found. You can use the <off offset> HTML tag in combination with the to define a smaller or a larger font to be displayed. For instance: Text with <off 6>subscript displays the text such as: Text with _subscriptThe Text with <off -6>superscript displays the text such as: Text with ^subscript
<gra rrggbb;mode;blend> ... </gra> defines a gradient text. The text color or <fgcolor> defines the starting gradient color, while the rr/gg/bb represents the red/green/blue values of the ending color, 808080 if missing as gray. The mode is a value between 0 and 4, 1 if missing, and blend could be 0 or 1, 0 if missing. The HTML tag can be used to define the height of the font. Any of the rrggbb, mode or blend field may not be specified. The <gra> with no fields, shows a vertical gradient color from the current text color to gray (808080). For instance the <gra FFFFFF;1;1>gradient-center</gra> generates the following picture:
<out rrggbb;width> ... </out> shows the text with outlined characters, where rr/gg/bb represents the red/green/blue values of the outline color, 808080 if missing as gray, width indicates the size of the outline, 1 if missing. The text color or <fgcolor> defines the color to show the inside text. The HTML tag can be used to define the height of the font. For instance the <out 000000><fgcolor=FFFFFF>outlined</fgcolor></out> generates the following picture:
<sha rrggbb;width;offset> ... </sha> define a text with a shadow, where rr/gg/bb represents the red/green/blue values of the shadow color, 808080 if missing as gray, width indicates the size of shadow, 4 if missing, and offset indicates the offset from the origin to display the text's shadow, 2 if missing. The text color or <fgcolor> defines the color to show the inside text. The HTML tag can be used to define the height of the font. For instance the <sha>shadow</sha> generates the following picture:
or <sha 404040;5;0><fgcolor=FFFFFF>outline anti-aliasing</fgcolor></sha> gets:

		Type	Description
		ToolTip as String	The ToolTip parameter can be any of the following: NULL(BSTR) or "<null>"(string) to indicate that the tooltip for the object being hovered is not changed A String expression that indicates the description of the tooltip, that supports built-in HTML format (adds, replaces or changes the object's tooltip)
		Title as Variant	The Title parameter can be any of the following: missing (VT_EMPTY, VT_ERROR type) or "<null>"(string) the title for the object being hovered is not changed. A String expression that indicates the title of the tooltip (no built-in HTML format) (adds, replaces or changes the object's title)
		Alignment as Variant	A long expression that indicates the alignment of the tooltip relative to the position of the cursor. If missing (VT_EMPTY, VT_ERROR) the alignment of the tooltip for the object being hovered is not changed. The Alignment parameter can be one of the following: 0 - exTopLeft 1 - exTopRight 2 - exBottomLeft 3 - exBottomRight 0x10 - exCenter 0x11 - exCenterLeft 0x12 - exCenterRight 0x13 - exCenterTop 0x14 - exCenterBottom By default, the tooltip is aligned relative to the top-left corner (0 - exTopLeft).
		X as Variant	Specifies the horizontal position to display the tooltip as one of the following: missing (VT_EMPTY, VT_ERROR type), indicates that the tooltip is shown on its default position / current cursor position (ignored) -1, indicates the current horizontal position of the cursor (current x-position) a numeric expression that indicates the horizontal screen position to show the tooltip (fixed screen x-position) a string expression that indicates the horizontal displacement relative to default position to show the tooltip (moved)
		Y as Variant	Specifies the vertical position to display the tooltip as one of the following: missing (VT_EMPTY, VT_ERROR type), indicates that the tooltip is shown on its default position / current cursor position (ignored) -1, indicates the current vertical position of the cursor (current y-position) a numeric expression that indicates the vertical screen position to show the tooltip (fixed screen y-position) a string expression that indicates the vertical displacement relative to default position to show the tooltip (displacement)