Class TooltipPropertiesBuilder

Inheritance

System.Object

TooltipPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class TooltipPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

TooltipPropertiesBuilder()

Initializes a new instance of the TooltipPropertiesBuilder class.

Declaration

public TooltipPropertiesBuilder()

TooltipPropertiesBuilder(Tooltip)

Initializes a new instance of the TooltipPropertiesBuilder class by the specified tooltip object.

Declaration

public TooltipPropertiesBuilder(Tooltip tooltip)

Parameters

Type	Name	Description
Tooltip	tooltip

Fields

tooltip

Specifies the instance of the Tooltip class.

Declaration

public Tooltip tooltip

Field Value

Type	Description
Tooltip

Methods

AllowKeyboardNavigation()

Tooltip control can be accessed through the keyboard shortcut keys.

Declaration

public TooltipPropertiesBuilder AllowKeyboardNavigation()

Returns

Type	Description
TooltipPropertiesBuilder

AllowKeyboardNavigation(Boolean)

Represents the Tooltip Keyboard Navigation with specified boolean argument.

Declaration

public TooltipPropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)

Parameters

Type	Name	Description
System.Boolean	allowKeyboardNavigation

Returns

Type	Description
TooltipPropertiesBuilder	This method returns boolean value

Animation(Action<TipAnimationBuilder>)

Specifies the animation behavior in Tooltip. It contains the following sub properties.

Declaration

public TooltipPropertiesBuilder Animation(Action<TipAnimationBuilder> animation)

Parameters

Type	Name	Description
System.Action<TipAnimationBuilder>	animation

Returns

Type	Description
TooltipPropertiesBuilder	This method returns object value

Associate(Associate)

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

Declaration

public TooltipPropertiesBuilder Associate(Associate associate)

Parameters

Type	Name	Description
Associate	associate

Returns

Type	Description
TooltipPropertiesBuilder	This method returns enum value

AutoCloseTimeout(Int32)

Specified the delay to hide Tooltip when closeMode is auto.

Declaration

public TooltipPropertiesBuilder AutoCloseTimeout(int autoCloseTimeout)

Parameters

Type	Name	Description
System.Int32	autoCloseTimeout

Returns

Type	Description
TooltipPropertiesBuilder	This method returns integer value

ClientSideEvents(Action<TooltipClientSideEventsBuilder>)

Specifies to trigger the tooltip client side events.

Declaration

public TooltipPropertiesBuilder ClientSideEvents(Action<TooltipClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<TooltipClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
TooltipPropertiesBuilder

CloseMode(CloseMode)

Specifies the closing behavior of Tooltip popup.

Declaration

public TooltipPropertiesBuilder CloseMode(CloseMode closeMode)

Parameters

Type	Name	Description
CloseMode	closeMode

Returns

Type	Description
TooltipPropertiesBuilder	This method returns enum value

Collision(Collision)

Sets the Tooltip in alternate position when collision occurs.

Declaration

public TooltipPropertiesBuilder Collision(Collision collision)

Parameters

Type	Name	Description
Collision	collision

Returns

Type	Description
TooltipPropertiesBuilder	This method returns enum value

Containment(String)

Specifies the selector for the tooltip container element.

Declaration

public TooltipPropertiesBuilder Containment(string containment)

Parameters

Type	Name	Description
System.String	containment

Returns

Type	Description
TooltipPropertiesBuilder	This method returns string value

Content(String)

Specifies the text for Tooltip.

Declaration

public TooltipPropertiesBuilder Content(string content)

Parameters

Type	Name	Description
System.String	content

Returns

Type	Description
TooltipPropertiesBuilder	This method returns string value

CssClass(String)

Specifies the root CSS class to tooltip for theme customization with specified string argument.

Declaration

public TooltipPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
TooltipPropertiesBuilder	This method returns string value

Enabled()

Allows the tooltip control to respond for user interaction.

Declaration

public TooltipPropertiesBuilder Enabled()

Returns

Type	Description
TooltipPropertiesBuilder

Enabled(Boolean)

Allows the tooltip control to respond for user interaction with specified boolean argument.

Declaration

public TooltipPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
TooltipPropertiesBuilder	This method returns boolean value

EnableRTL()

Specifies to align the tooltip control in right to left direction.

Declaration

public TooltipPropertiesBuilder EnableRTL()

Returns

Type	Description
TooltipPropertiesBuilder

EnableRTL(Boolean)

Specifies to align the tooltip control in right to left direction with specified boolean argument.

Declaration

public TooltipPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
TooltipPropertiesBuilder	This method returns boolean value

Height(String)

Specifies the height of the tooltip with specified string argument.

Declaration

public TooltipPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height	height

Returns

Type	Description
TooltipPropertiesBuilder	This method returns string value

IsBalloon()

Enables the arrow in Tooltip.

Declaration

public TooltipPropertiesBuilder IsBalloon()

Returns

Type	Description
TooltipPropertiesBuilder

IsBalloon(Boolean)

Represents the arrow in tooltip with specified boolean argument.

Declaration

public TooltipPropertiesBuilder IsBalloon(bool isBalloon)

Parameters

Type	Name	Description
System.Boolean	isBalloon	isBalloon

Returns

Type	Description
TooltipPropertiesBuilder	This method returns boolean value

Position(Action<TipPositionBuilder>)

defines various attributes of the Tooltip position

Declaration

public TooltipPropertiesBuilder Position(Action<TipPositionBuilder> position)

Parameters

Type	Name	Description
System.Action<TipPositionBuilder>	position

Returns

Type	Description
TooltipPropertiesBuilder	This method returns object value

Render()

Renders the tooltip instance.

Declaration

public void Render()

ShowRoundedCorner()

Displays the tooltip with rounded corners.

Declaration

public TooltipPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
TooltipPropertiesBuilder

ShowRoundedCorner(Boolean)

Displays the tooltip with rounded corners by the specified boolean argument.

Declaration

public TooltipPropertiesBuilder ShowRoundedCorner(bool showRoundedCorner)

Parameters

Type	Name	Description
System.Boolean	showRoundedCorner	showRoundedCorner

Returns

Type	Description
TooltipPropertiesBuilder	This method returns boolean value

ShowShadow()

Enables the shadow in Tooltip.

Declaration

public TooltipPropertiesBuilder ShowShadow()

Returns

Type	Description
TooltipPropertiesBuilder

ShowShadow(Boolean)

Represents the shadow in Tooltip with specified boolean argument.

Declaration

public TooltipPropertiesBuilder ShowShadow(bool showShadow)

Parameters

Type	Name	Description
System.Boolean	showShadow

Returns

Type	Description
TooltipPropertiesBuilder	This method returns boolean value

Target(String)

Specified a selector for elements, within the container.

Declaration

public TooltipPropertiesBuilder Target(string target)

Parameters

Type	Name	Description
System.String	target

Returns

Type	Description
TooltipPropertiesBuilder	This method returns string value

Title(String)

The title text to be displayed in the Tooltip header.

Declaration

public TooltipPropertiesBuilder Title(string title)

Parameters

Type	Name	Description
System.String	title

Returns

Type	Description
TooltipPropertiesBuilder	This method returns string value

ToHtmlString()

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Trigger(Trigger)

Specified the event action to show case the Tooltip.

Declaration

public TooltipPropertiesBuilder Trigger(Trigger trigger)

Parameters

Type	Name	Description
Trigger	trigger

Returns

Type	Description
TooltipPropertiesBuilder	This method returns enum value

Width(String)

Specifies the width of the tooltip with specified string argument.

Declaration

public TooltipPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	width

Returns

Type	Description
TooltipPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString