Class Tooltip

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

Tooltip

Namespace: Syncfusion.EJ2.Popups

Assembly: Syncfusion.EJ2.dll

Syntax

public class Tooltip : EJTagHelper

Constructors

Tooltip()

Declaration

public Tooltip()

Properties

AfterClose

We can trigger afterClose event when the Tooltip Component gets closed.

Declaration

public string AfterClose { get; set; }

Property Value

Type	Description
System.String	The default value is null

AfterOpen

We can trigger afterOpen event after the Tooltip Component gets opened.

Declaration

public string AfterOpen { get; set; }

Property Value

Type	Description
System.String	The default value is null

Animation

We can set the same or different animation option to Tooltip while it is in open or close state. Refer the documentation here to know more about this property with demo.

Declaration

public object Animation { get; set; }

Property Value

Type	Description
System.Object	The default value is null

BeforeClose

We can trigger beforeClose event before the Tooltip hides from the screen. If returned false, then the Tooltip is no more hidden.

Declaration

public string BeforeClose { get; set; }

Property Value

Type	Description
System.String	The default value is null

BeforeCollision

We can trigger beforeCollision event for every collision fit calculation.

Declaration

public string BeforeCollision { get; set; }

Property Value

Type	Description
System.String	The default value is null

BeforeOpen

We can trigger beforeOpen event before the Tooltip is displayed over the target element. When one of its arguments cancel is set to true, the Tooltip display can be prevented. This event is mainly used for the purpose of refreshing the Tooltip positions dynamically or to set customized styles in it and so on.

Declaration

public string BeforeOpen { get; set; }

Property Value

Type	Description
System.String	The default value is null

BeforeRender

We can trigger beforeRender event before the Tooltip and its contents are added to the DOM. When one of its arguments cancel is set to true, the Tooltip can be prevented from rendering on the page. This event is mainly used for the purpose of customizing the Tooltip before it shows up on the screen. For example, to load the AJAX content or to set new animation effects on the Tooltip, this event can be opted. Refer the documentation here to know more about this property with demo.

Declaration

public string BeforeRender { get; set; }

Property Value

Type	Description
System.String	The default value is null

CloseDelay

It is used to close the Tooltip after a specified delay in milliseconds.

Declaration

public double CloseDelay { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

Container

It is used to set the container element in which the Tooltip’s pop-up will be appended. It accepts value as both string and HTML Element. It's default value is body, in which the Tooltip’s pop-up will be appended.

Declaration

public string Container { get; set; }

Property Value

Type	Description
System.String	The default value is null

Content

It is used to display the content of Tooltip which can be both string and HTML Elements. Refer the documentation here to know more about this property with demo.

Declaration

public string Content { get; set; }

Property Value

Type	Description
System.String	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

Created

We can trigger created event after the Tooltip component is created.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

CssClass

It is used to customize the Tooltip which accepts custom CSS class names that defines specific user-defined styles and themes to be applied on the Tooltip element.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is null

Destroyed

We can trigger destroyed event when the Tooltip component is destroyed.

Declaration

public string Destroyed { get; set; }

Property Value

Type	Description
System.String	The default value is null

EnableHtmlParse

It enables or disables the parsing of HTML string content into HTML DOM elements for Tooltip. If the value of the property is set to false, the tooltip content will be displayed as HTML string instead of HTML DOM elements.

Declaration

public bool EnableHtmlParse { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableHtmlSanitizer

Specifies whether to display or remove the untrusted HTML values in the Tooltip component. If 'enableHtmlSanitizer' set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.

Declaration

public bool EnableHtmlSanitizer { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Height

It is used to set the height of Tooltip component which accepts both string and number values. When Tooltip content gets overflow due to height value then the scroll mode will be enabled. Refer the documentation here to know more about this property with demo.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

HtmlAttributes

Allows additional HTML attributes such as tabindex, title, name, etc. to root element of the Tooltip popup, and accepts n number of attributes in a key-value pair format.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type	Description
System.Object	The default value is null

IsSticky

It is used to display the Tooltip in an open state until closed by manually. Refer the documentation here to know more about this property with demo.

Declaration

public bool IsSticky { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The default value is ""

MouseTrail

It allows the Tooltip to follow the mouse pointer movement over the specified target element. Refer the documentation here to know more about this property with demo.

Declaration

public bool MouseTrail { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

OffsetX

It sets the space between the target and Tooltip element in X axis.

Declaration

public double OffsetX { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

OffsetY

It sets the space between the target and Tooltip element in Y axis.

Declaration

public double OffsetY { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

OpenDelay

It is used to open the Tooltip after the specified delay in milliseconds.

Declaration

public double OpenDelay { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

OpensOn

It is used to determine the device mode to display the Tooltip content. If it is in desktop, it will show the Tooltip content when hovering on the target element. If it is in touch device, it will show the Tooltip content when tap and holding on the target element.

Declaration

public string OpensOn { get; set; }

Property Value

Type	Description
System.String	The default value is "Auto"

Position

It is used to set the position of Tooltip element, with respect to Target element.

Declaration

public Position Position { get; set; }

Property Value

Type	Description
Position	The default value is null

ShowTipPointer

It is used to show or hide the tip pointer of Tooltip.

Declaration

public bool ShowTipPointer { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Target

It is used to denote the target selector where the Tooltip need to be displayed. The target element is considered as parent container.

Declaration

public string Target { get; set; }

Property Value

Type	Description
System.String	The default value is null

TipPointerPosition

It is used to set the position of tip pointer on tooltip. When it sets to auto, the tip pointer auto adjusts within the space of target's length and does not point outside. Refer the documentation here to know more about this property with demo.

Declaration

public TipPointerPosition TipPointerPosition { get; set; }

Property Value

Type	Description
TipPointerPosition	The default value is TipPointerPosition.Auto

Width

It is used to set the width of Tooltip component which accepts both string and number values. When set to auto, the Tooltip width gets auto adjusted to display its content within the viewable screen.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

WindowCollision

It is used to set the collision target element as page viewport (window) or Tooltip element, when using the target. If this property is enabled, tooltip will perform the collision calculation between the target elements and viewport(window) instead of Tooltip element.

Declaration

public bool WindowCollision { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false