Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >:
Ext.Net.Tip.Builder< TToolTipBase, TBuilder >

Public Member Functions

 Builder (TToolTipBase component)
 
virtual TBuilder DefaultAlign (string defaultAlign)
 A string which specifies how this ToolTip is to align with regard to its currentTarget by means of identifying the point of the tooltip to join to the point of the target. More...
 
virtual TBuilder ForceRendering (bool forceRendering)
 
virtual TBuilder FadeOutDuration (int fadeOutDuration)
 
virtual TBuilder ShowOnTap (bool? showOnTap)
 On touch platforms, if showOnTap is true, a tap on the target shows the tip. In this case any showDelay is ignored. More...
 
virtual TBuilder TargetOffset (List< int > targetOffset)
 When anchorToTarget is being used to position this tip relative to its target element, this may be used as an extra XY offset from the target element. More...
 
virtual TBuilder Anchor (string anchor)
 If specified, indicates that the tip should be anchored to a particular side of the target element or mouse pointer ("top", "right", "bottom", or "left"), with an arrow pointing back at the target or mouse pointer. If constrainPosition is enabled, this will be used as a preferred value only and may be flipped as needed. More...
 
virtual TBuilder AutoHide (bool autoHide)
 True to automatically hide the tooltip after the mouse exits the target element or after the dismissDelay has expired if set (defaults to true). If closable = true a close tool button will be rendered into the tooltip header. More...
 
virtual TBuilder Delegate (string _delegate)
 A DomQuery selector which allows selection of individual elements within the target element to trigger showing and hiding the ToolTip as the mouse moves within the target. More...
 
virtual TBuilder DismissDelay (int dismissDelay)
 Delay in milliseconds before the tooltip automatically hides (defaults to 5000). To disable automatic hiding, set dismissDelay = 0. More...
 
virtual TBuilder HideAction (string hideAction)
 
virtual TBuilder HideDelay (int hideDelay)
 Delay in milliseconds after the mouse exits the target element but before the tooltip actually hides (defaults to 200). Set to 0 for the tooltip to hide immediately. More...
 
virtual TBuilder MouseOffset (int[] mouseOffset)
 An XY offset from the mouse position where the tooltip should be shown (defaults to [15,18]). More...
 
virtual TBuilder ShowDelay (int showDelay)
 Delay in milliseconds before the tooltip displays after the mouse enters the target element (defaults to 500). More...
 
virtual TBuilder TargetControl (Action< Control > action)
 
virtual TBuilder Target (string target)
 The target id to associate with this tooltip. More...
 
virtual TBuilder TrackMouse (bool trackMouse)
 True to have the tooltip follow the mouse as it moves over the target element (defaults to false). More...
 
virtual TBuilder AfterShow ()
 
virtual TBuilder RealignToTarget ()
 
virtual TBuilder ShowBy (ComponentBase by)
 
virtual TBuilder ShowBy (Element by)
 
virtual TBuilder ShowBy (object byEvent)
 
- Public Member Functions inherited from Ext.Net.Tip.Builder< TToolTipBase, TBuilder >
 Builder (TTip component)
 
virtual TBuilder ConstrainPosition (bool constrainPosition)
 If true, then the tooltip will be automatically constrained to stay within the browser viewport. Defaults to: true More...
 
virtual TBuilder ShowAt (Unit x, Unit y)
 
virtual TBuilder ShowBy (string id)
 
virtual TBuilder ShowBy (string id, string position)
 

Detailed Description

Type Constraints
TToolTipBase :ToolTipBase 
TBuilder :Builder 
TBuilder :TToolTipBase 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder()

Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.Builder ( TToolTipBase  component)
inline

Member Function Documentation

◆ AfterShow()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.AfterShow ( )
inlinevirtual

◆ Anchor()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.Anchor ( string  anchor)
inlinevirtual

If specified, indicates that the tip should be anchored to a particular side of the target element or mouse pointer ("top", "right", "bottom", or "left"), with an arrow pointing back at the target or mouse pointer. If constrainPosition is enabled, this will be used as a preferred value only and may be flipped as needed.

◆ AutoHide()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.AutoHide ( bool  autoHide)
inlinevirtual

True to automatically hide the tooltip after the mouse exits the target element or after the dismissDelay has expired if set (defaults to true). If closable = true a close tool button will be rendered into the tooltip header.

◆ DefaultAlign()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.DefaultAlign ( string  defaultAlign)
inlinevirtual

A string which specifies how this ToolTip is to align with regard to its currentTarget by means of identifying the point of the tooltip to join to the point of the target.

◆ Delegate()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.Delegate ( string  _delegate)
inlinevirtual

A DomQuery selector which allows selection of individual elements within the target element to trigger showing and hiding the ToolTip as the mouse moves within the target.

◆ DismissDelay()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.DismissDelay ( int  dismissDelay)
inlinevirtual

Delay in milliseconds before the tooltip automatically hides (defaults to 5000). To disable automatic hiding, set dismissDelay = 0.

◆ FadeOutDuration()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.FadeOutDuration ( int  fadeOutDuration)
inlinevirtual

◆ ForceRendering()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.ForceRendering ( bool  forceRendering)
inlinevirtual

◆ HideAction()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.HideAction ( string  hideAction)
inlinevirtual

◆ HideDelay()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.HideDelay ( int  hideDelay)
inlinevirtual

Delay in milliseconds after the mouse exits the target element but before the tooltip actually hides (defaults to 200). Set to 0 for the tooltip to hide immediately.

◆ MouseOffset()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.MouseOffset ( int[]  mouseOffset)
inlinevirtual

An XY offset from the mouse position where the tooltip should be shown (defaults to [15,18]).

◆ RealignToTarget()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.RealignToTarget ( )
inlinevirtual

◆ ShowBy() [1/3]

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.ShowBy ( ComponentBase  by)
inlinevirtual

◆ ShowBy() [2/3]

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.ShowBy ( Element  by)
inlinevirtual

◆ ShowBy() [3/3]

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.ShowBy ( object  byEvent)
inlinevirtual

◆ ShowDelay()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.ShowDelay ( int  showDelay)
inlinevirtual

Delay in milliseconds before the tooltip displays after the mouse enters the target element (defaults to 500).

◆ ShowOnTap()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.ShowOnTap ( bool?  showOnTap)
inlinevirtual

On touch platforms, if showOnTap is true, a tap on the target shows the tip. In this case any showDelay is ignored.

◆ Target()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.Target ( string  target)
inlinevirtual

The target id to associate with this tooltip.

◆ TargetControl()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.TargetControl ( Action< Control >  action)
inlinevirtual

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ TargetOffset()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.TargetOffset ( List< int >  targetOffset)
inlinevirtual

When anchorToTarget is being used to position this tip relative to its target element, this may be used as an extra XY offset from the target element.

◆ TrackMouse()

virtual TBuilder Ext.Net.ToolTipBase.Builder< TToolTipBase, TBuilder >.TrackMouse ( bool  trackMouse)
inlinevirtual

True to have the tooltip follow the mouse as it moves over the target element (defaults to false).


The documentation for this class was generated from the following file: