Inheritance diagram for Ext.Net.DataTip.Builder< TDataTip, TBuilder >:

Public Member Functions
	Builder (TDataTip component)

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	AnchorOffset (int anchorOffset)
	A numeric pixel value used to offset the default position of the anchor arrow. When the anchor position is on the top or bottom of the tooltip, anchorOffset will be used as a horizontal offset. Likewise, when the anchor position is on the left or right side, anchorOffset will be used as a vertical offset. Defaults to: 0 More...

virtual TBuilder	AnchorToTarget (bool anchorToTarget)
	True to anchor the tooltip to the target element, false to anchor it relative to the mouse coordinates. When anchorToTarget is true, use defaultAlign to control tooltip alignment to the target element. When anchorToTarget is false, use anchor instead to control alignment. Defaults to: true 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	DismissDelay (int dismissDelay)
	Delay in milliseconds before the tooltip automatically hides (defaults to 5000). To disable automatic hiding, set dismissDelay = 0. More...

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	TrackMouse (bool trackMouse)
	True to have the tooltip follow the mouse as it moves over the target element (defaults to false). More...

virtual TBuilder	Closable (bool closable)
	True to render a close tool button into the tooltip header (defaults to false). More...

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	DefaultAlign (string defaultAlign)
	Experimental. The default Ext.Element.alignTo anchor position value for this tip relative to its element of origin. Defaults to: "tl-bl?" More...

virtual TBuilder	MaxWidth (int? maxWidth)
	The maximum width of the tip in pixels. The maximum supported value is 500. More...

virtual TBuilder	MinWidth (int? minWidth)
	The minimum width of the tip in pixels (defaults to 40). More...

virtual TBuilder	Data (object data)
	The initial set of data to apply to the tpl to update the content area of the AbstractComponent. More...

virtual TBuilder	Tpl (XTemplate tpl)
	An XTemplate used to create the internal structure inside this AbstractComponent's encapsulating Element. More...

virtual TBuilder	TplWriteMode (TemplateWriteMode tplWriteMode)
	The Ext.(X)Template method to use when updating the content area of the AbstractComponent. Defaults to 'overwrite' More...

virtual TBuilder	Cls (string cls)
	An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules. More...

virtual TBuilder	Height (Unit height)
	The height of this component in pixels. More...

virtual TBuilder	ShrinkWrap (ShrinkWrap shrinkWrap)
	In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed to a block-level element. Some container layouts always shrink-wrap their children, effectively ignoring this property (e.g., Ext.layout.container.HBox, Ext.layout.container.VBox, Ext.layout.component.Dock). The Default is "Height". More...

virtual TBuilder	StyleSpec (string styleSpec)
	A custom style specification to be applied to this component's Element. More...

virtual TBuilder	UI (string uI)
	A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string added to the baseCls with an extra '-'. More...

virtual TBuilder	Listeners (Action< PanelListeners > action)
	Client-side JavaScript Event Handlers More...

virtual TBuilder	DirectEvents (Action< PanelDirectEvents > action)
	Server-side Ajax Event Handlers More...

virtual TBuilder	BeforeShowTip (Action< JFunction > action)

	Builder ()

	Builder (DataTip component)

	Builder (DataTip.Config config)

Public Member Functions inherited from Ext.Net.Plugin.Builder< TDataTip, TBuilder >
	Builder (TPlugin component)

Static Public Member Functions
static implicit	operator Builder (DataTip component)

Detailed Description

Type Constraints

TDataTip	:	DataTip
TBuilder	:	Builder
TBuilder	:	TDataTip
TBuilder	:	TBuilder

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Builder ( TDataTip component )

inline

◆ Builder() [2/4]

Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Builder ( )

inline

◆ Builder() [3/4]

Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Builder ( DataTip component )

inline

◆ Builder() [4/4]

Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Builder ( DataTip.Config config )

inline

Member Function Documentation

◆ Anchor()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, 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.

◆ AnchorOffset()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.AnchorOffset ( int anchorOffset )

inlinevirtual

A numeric pixel value used to offset the default position of the anchor arrow. When the anchor position is on the top or bottom of the tooltip, anchorOffset will be used as a horizontal offset. Likewise, when the anchor position is on the left or right side, anchorOffset will be used as a vertical offset. Defaults to: 0

◆ AnchorToTarget()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.AnchorToTarget ( bool anchorToTarget )

inlinevirtual

True to anchor the tooltip to the target element, false to anchor it relative to the mouse coordinates. When anchorToTarget is true, use defaultAlign to control tooltip alignment to the target element. When anchorToTarget is false, use anchor instead to control alignment. Defaults to: true

◆ AutoHide()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, 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.

◆ BeforeShowTip()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.BeforeShowTip ( Action< JFunction > action )

inlinevirtual

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ Closable()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Closable ( bool closable )

inlinevirtual

True to render a close tool button into the tooltip header (defaults to false).

◆ Cls()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Cls ( string cls )

inlinevirtual

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

◆ ConstrainPosition()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.ConstrainPosition ( bool constrainPosition )

inlinevirtual

If true, then the tooltip will be automatically constrained to stay within the browser viewport. Defaults to: true

◆ Data()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Data ( object data )

inlinevirtual

The initial set of data to apply to the tpl to update the content area of the AbstractComponent.

◆ DefaultAlign()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.DefaultAlign ( string defaultAlign )

inlinevirtual

Experimental. The default Ext.Element.alignTo anchor position value for this tip relative to its element of origin. Defaults to: "tl-bl?"

◆ DirectEvents()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.DirectEvents ( Action< PanelDirectEvents > action )

inlinevirtual

Server-side Ajax Event Handlers

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ DismissDelay()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.DismissDelay ( int dismissDelay )

inlinevirtual

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

◆ Height()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Height ( Unit height )

inlinevirtual

The height of this component in pixels.

◆ HideDelay()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, 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.

◆ Listeners()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Listeners ( Action< PanelListeners > action )

inlinevirtual

Client-side JavaScript Event Handlers

Parameters

action The action delegate

Returns: An instance of TBuilder

◆ MaxWidth()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.MaxWidth ( int? maxWidth )

inlinevirtual

The maximum width of the tip in pixels. The maximum supported value is 500.

◆ MinWidth()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.MinWidth ( int? minWidth )

inlinevirtual

The minimum width of the tip in pixels (defaults to 40).

◆ MouseOffset()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.MouseOffset ( int[] mouseOffset )

inlinevirtual

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

◆ operator Builder()

static implicit Ext.Net.DataTip.Builder< TDataTip, TBuilder >.operator Builder ( DataTip component )

inlinestatic

◆ ShowDelay()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.ShowDelay ( int showDelay )

inlinevirtual

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

◆ ShrinkWrap()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.ShrinkWrap ( ShrinkWrap shrinkWrap )

inlinevirtual

In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed to a block-level element. Some container layouts always shrink-wrap their children, effectively ignoring this property (e.g., Ext.layout.container.HBox, Ext.layout.container.VBox, Ext.layout.component.Dock). The Default is "Height".

◆ StyleSpec()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.StyleSpec ( string styleSpec )

inlinevirtual

A custom style specification to be applied to this component's Element.

◆ Tpl()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.Tpl ( XTemplate tpl )

inlinevirtual

An XTemplate used to create the internal structure inside this AbstractComponent's encapsulating Element.

◆ TplWriteMode()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.TplWriteMode ( TemplateWriteMode tplWriteMode )

inlinevirtual

The Ext.(X)Template method to use when updating the content area of the AbstractComponent. Defaults to 'overwrite'

◆ TrackMouse()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.TrackMouse ( bool trackMouse )

inlinevirtual

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

◆ UI()

virtual TBuilder Ext.Net.DataTip.Builder< TDataTip, TBuilder >.UI ( string uI )

inlinevirtual

A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string added to the baseCls with an extra '-'.

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

DataTipBuilder.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Builder() [1/4]

◆ Builder() [2/4]

◆ Builder() [3/4]

◆ Builder() [4/4]

Member Function Documentation

◆ Anchor()

◆ AnchorOffset()

◆ AnchorToTarget()

◆ AutoHide()

◆ BeforeShowTip()

◆ Closable()

◆ Cls()

◆ ConstrainPosition()

◆ Data()

◆ DefaultAlign()

◆ DirectEvents()

◆ DismissDelay()

◆ Height()

◆ HideDelay()

◆ Listeners()

◆ MaxWidth()

◆ MinWidth()

◆ MouseOffset()

◆ operator Builder()

◆ ShowDelay()

◆ ShrinkWrap()

◆ StyleSpec()

◆ Tpl()

◆ TplWriteMode()

◆ TrackMouse()

◆ UI()