Class Tooltip

Represents the Tooltip UI element.

Inheritance

System.Object

CommonControl

Tooltip

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonControl.RaisePostBackEvent(String)

CommonControl.OnInit(EventArgs)

CommonControl.OnLoad(EventArgs)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class Tooltip : CommonControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

Tooltip()

Declaration

public Tooltip()

Properties

AllowKeyboardNavigation

Gets and Sets whether the tooltip control to be accessed through the keyboard shortcut keys.

Declaration

public bool AllowKeyboardNavigation { get; set; }

Property Value

Type	Description
System.Boolean

Animation

Gets and sets the animation behaviour for the tooltip

Declaration

[JsonProperty("animation")]
public TipAnimation Animation { get; set; }

Property Value

Type	Description
TipAnimation

Associate

Gets and Sets the position related to target element, window, mouse or (x,y) co-ordinates.

Declaration

public Associate Associate { get; set; }

Property Value

Type	Description
Associate

AutoCloseTimeout

Gets and Sets the delay to hide Tooltip when closeMode is auto.

Declaration

public int AutoCloseTimeout { get; set; }

Property Value

Type	Description
System.Int32

ClientSideOnBeforeClose

Gets and sets the tooltip BeforeClose event.

Declaration

public string ClientSideOnBeforeClose { get; set; }

Property Value

Type	Description
System.String

ClientSideOnBeforeOpen

Gets and sets the tooltip BeforeOpen event.

Declaration

public string ClientSideOnBeforeOpen { get; set; }

Property Value

Type	Description
System.String

ClientSideOnClick

Gets and sets the tooltip Click event.

Declaration

public string ClientSideOnClick { get; set; }

Property Value

Type	Description
System.String

ClientSideOnClose

Gets and sets the tooltip Close event.

Declaration

public string ClientSideOnClose { get; set; }

Property Value

Type	Description
System.String

ClientSideOnCreate

Gets and sets the tooltip Create event.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String

ClientSideOnDestroy

Gets and sets the tooltip Destroy event.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String

ClientSideOnHover

Gets and sets the tooltip Hover event.

Declaration

public string ClientSideOnHover { get; set; }

Property Value

Type	Description
System.String

ClientSideOnOpen

Gets and sets the tooltip Open event.

Declaration

public string ClientSideOnOpen { get; set; }

Property Value

Type	Description
System.String

ClientSideOnTracking

Gets and sets the tooltip Tracking event.

Declaration

public string ClientSideOnTracking { get; set; }

Property Value

Type	Description
System.String

CloseMode

Gets and sets the closing behavior of Tooltip popup.

Declaration

public CloseMode CloseMode { get; set; }

Property Value

Type	Description
CloseMode

Collision

Gets and Sets the Tooltip in alternate position when collision occurs.

Declaration

public Collision Collision { get; set; }

Property Value

Type	Description
Collision

Containment

Gets and Sets the selector for the container element.

Declaration

public string Containment { get; set; }

Property Value

Type	Description
System.String

Content

Gets and sets the text for Tooltip.

Declaration

public string Content { get; set; }

Property Value

Type	Description
System.String

CssClass

Gets and sets the root class for Tooltip theme.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

Enabled

Gets and Sets the enabled property

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnableRTL

Gets and sets the text displayed by the control is displayed from right to left.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean

For

Gets and sets Tooltip ID selector using For

Declaration

public string For { get; set; }

Property Value

Type	Description
System.String

Height

Gets and Sets the height of the Tooltip.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

IsBalloon

Gets and sets the arrow in Tooltip.

Declaration

public bool IsBalloon { get; set; }

Property Value

Type	Description
System.Boolean

Model

Gets and sets common Tooltip Model

Declaration

public TooltipProperties Model { get; set; }

Property Value

Type	Description
TooltipProperties

Position

Gets and Sets the tooltip positions

Declaration

[JsonProperty("position")]
public TipPosition Position { get; }

Property Value

Type	Description
TipPosition

ShowRoundedCorner

Gets and sets the rounded corners to Tooltip.

Declaration

public bool ShowRoundedCorner { get; set; }

Property Value

Type	Description
System.Boolean

ShowShadow

Gets and sets the shadow effect

Declaration

public bool ShowShadow { get; set; }

Property Value

Type	Description
System.Boolean

Target

Gets and sets a selector for elements, within the container.

Declaration

public string Target { get; set; }

Property Value

Type	Description
System.String

Title

Gets and Sets the title text to be displayed in the Tooltip header.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

Trigger

Gets and sets the event action to show case the Tooltip.

Declaration

public Trigger Trigger { get; set; }

Property Value

Type	Description
Trigger

Width

Gets and Sets the width of the Tooltip.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

DependentScripts()

Gets the dependent scripts

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	the Scripts

GetDependentFiles()

Gets the dependent files

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>	the files

Overrides

CommonControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state	object state

Overrides

CommonControl.LoadViewState(Object)

OnPreRender(EventArgs)

Modifying server controls before sending them to the client.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	Event arguments

PostBackEventHandler(String, Dictionary<String, Object>)

Gets a value that indicates whether the page is being loaded in response to a postback.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName	string EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args	Argument of dictionary type

Overrides

CommonControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Renders the control

Declaration

public string Render()

Returns

Type	Description
System.String	the string

Render(HtmlTextWriter)

Render method for rendering control

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer	HtmlTextWriter

Overrides

CommonControl.Render(HtmlTextWriter)

UpdateServerModel(Dictionary<String, Object>)

Model values to retain on server side.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel	ClientModel

Overrides

CommonControl.UpdateServerModel(Dictionary<String, Object>)

Events

Click

Server side click event

Declaration

public event Tooltip.TooltipEventHandler Click

Event Type

Type	Description
Tooltip.TooltipEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService