TooltipBuilder

Properties

WriteAction - Func

Methods

AutoHide(System.Boolean)

Specifies if the Tooltip will be hidden when the mouse leaves the target element. If set to false, a Close button will be shown within Tooltip. If set to false, showAfter is specified, and showOn is set to mouseenter, the Tooltip will be displayed after the given timeout even if the element is no longer hovered.

Parameters

value - System.Boolean

The value for AutoHide

RETURNS

Returns the current TooltipBuilder instance.

Callout(System.Boolean)

Specifies if the Tooltip callout will be displayed.

Parameters

value - System.Boolean

The value for Callout

RETURNS

Returns the current TooltipBuilder instance.

Filter(System.String)

Specifies a selector for the elements within the container which will display the Tooltip.

Parameters

value - System.String

The value for Filter

RETURNS

Returns the current TooltipBuilder instance.

Iframe(System.Boolean)

Explicitly states whether a content iframe will be created.

Parameters

value - System.Boolean

The value for Iframe

RETURNS

Returns the current TooltipBuilder instance.

Height(System.Double)

The height (in pixels) of the Tooltip.

Parameters

value - System.Double

The value for Height

RETURNS

Returns the current TooltipBuilder instance.

Width(System.Double)

The width (in pixels) of the Tooltip.

Parameters

value - System.Double

The value for Width

RETURNS

Returns the current TooltipBuilder instance.

ShowAfter(System.Double)

Specifies the delay (in milliseconds) before the Tooltip shows. This option is ignored if showOn is set to click or focus.

Parameters

value - System.Double

The value for ShowAfter

RETURNS

Returns the current TooltipBuilder instance.

HideAfter(System.Double)

Specifies the delay (in milliseconds) before the Tooltip is hidden.

Parameters

value - System.Double

The value for HideAfter

RETURNS

Returns the current TooltipBuilder instance.

Offset(System.Double)

Specifies the offset (in pixels) between the Tooltip and the anchor. If the callout property is set to true, the offset is rendered from the callout arrow. If the callout property is set to false, the offset is rendered from the content of the Tooltip.

Parameters

value - System.Double

The value for Offset

RETURNS

Returns the current TooltipBuilder instance.

Position(Kendo.Mvc.UI.TooltipPosition)

Represents the tooltip position.

Parameters

value - TooltipPosition

The value for Position

RETURNS

Returns the current TooltipBuilder instance.

ShowOn(Kendo.Mvc.UI.TooltipShowOnEvent)

Represents the tooltip position.

Parameters

value - TooltipShowOnEvent

The value for ShowOn

RETURNS

Returns the current TooltipBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<TooltipEventBuilder>

The client events action.

RETURNS

Returns the current TooltipBuilder instance.

Example

Razor

 
            @(Html.Kendo().Tooltip()
                  .Name("Tooltip")
                  .Events(events => events
                      .ContentLoad("onContentLoad")
                  )
            )
             

For(System.String)

The selector which to match the DOM element to which the Tooltip widget will be instantiated

Parameters

selector - System.String

jQuery selector

RETURNS

Returns the current instance.

Example

Razor

 
            @(Html.Kendo().Tooltip()
                        .For("#element")
            )
             

LoadContentFrom(Microsoft.AspNetCore.Routing.RouteValueDictionary)

Sets the Url, which will be requested to return the content.

Parameters

routeValues - Microsoft.AspNetCore.Routing.RouteValueDictionary

The route values of the Action method.

RETURNS

Returns the current instance.

Example

Razor

 
             @( Html.Kendo().Tooltip()
                    .For("#element")
                    .LoadContentFrom(MVC.Home.Index().GetRouteValueDictionary());
            )
             

LoadContentFrom(System.String,System.String)

Sets the Url, which will be requested to return the content.

Parameters

actionName - System.String

The action name.

controllerName - System.String

The controller name.

RETURNS

Returns the current instance.

Example

Razor

 
             @( Html.Kendo().Tooltip()
                        .For("#element")
                        .LoadContentFrom("AjaxView_OpenSource", "Tooltip")
            )
             

LoadContentFrom(System.String,System.String,System.Object)

Sets the Url, which will be requested to return the content.

Parameters

actionName - System.String

The action name.

controllerName - System.String

The controller name.

routeValues - System.Object

Route values.

RETURNS

Returns the current instance.

Example

Razor

 
             @( Html.Kendo().Tooltip()
                        .For("#element")
                        .LoadContentFrom("AjaxView_OpenSource", "Tooltip", new { id = 10})
            )
             

LoadContentFrom(System.String,System.String,Microsoft.AspNetCore.Routing.RouteValueDictionary)

Define the endpoint that will return HTML content that can be loaded in the content area of the Tooltip.

Parameters

actionName - System.String

controllerName - System.String

routeValues - Microsoft.AspNetCore.Routing.RouteValueDictionary

RETURNS

Returns the current instance.

LoadContentFrom(System.String)

Sets the Url, which will be requested to return the content.

Parameters

value - System.String

The url.

RETURNS

Returns the current instance.

Example

Razor

 
             @( Html.Kendo().Tooltip()
                        .For("#element")
                        .LoadContentFrom(Url.Action("AjaxView_OpenSource", "Tooltip"))
            )
             

Content(System.String)

Sets the HTML content which the tooltip should display as a string.

Parameters

value - System.String

The action which renders the content.

RETURNS

Returns the current instance.

Example

Razor

 
             @( Html.Kendo().Tooltip()
                        .For("#element")
                        .Content("<strong> First Item Content</strong>")
            )
             

ContentTemplateId(System.String)

Sets the id of kendo template which will be used as tooltip content.

Parameters

value - System.String

The id of the template

RETURNS

Returns the current instance.

Example

Razor

 
             @( Html.Kendo().Tooltip()
                        .For("#element")
                        .Content("template")
            )
             

ContentHandler(System.Func)

Sets JavaScript function which to return the content for the tooltip.

Parameters

handler - System.Func<Object,Object>

RETURNS

Returns the current instance.

ContentHandler(System.String)

Sets JavaScript function which to return the content for the tooltip.

Parameters

handler - System.String

JavaScript function name

RETURNS

Returns the current instance.

Content(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Sets the HTML content which the tooltip should display as a string via TemplateBuilder.

Parameters

template - TemplateBuilder<TModel>

The TemplateBuilder instance.

RETURNS

Returns the current instance.

Animation(System.Boolean)

Configures the animation effects of the window.

Parameters

enable - System.Boolean

Whether the component animation is enabled.

RETURNS

Returns the current instance.

Example

Razor

 
            @( Html.Kendo().Tooltip()
                        .For("#element")
                        .Animation(false))
             

Animation(System.Action)

Configures the animation effects of the panelbar.

Parameters

animationAction - System.Action<PopupAnimationBuilder>

The action that configures the animation.

RETURNS

Returns the current instance.

Example

Razor

 
            @( Html.Kendo().Tooltip()
                        .For("#element")
                        .Animation(animation => animation.Expand))
             

AutoHide(System.Boolean)

Specifies if the Tooltip will be hidden when mouse leaves the target element. If set to false a close button will be shown within Tooltip. If set to false, showAfter is specified and the showOn is set to "mouseenter" the Tooltip will be displayed after the given timeout even if the element is no longer hovered.

Parameters

value - System.Boolean

The value for AutoHide

Callout(System.Boolean)

Specifies if the Tooltip callout will be displayed.

Parameters

value - System.Boolean

The value for Callout

Filter(System.String)

Specifies a selector for elements, within the container, for which the Tooltip will be displayed.

Parameters

value - System.String

The value for Filter

Iframe(System.Boolean)

Explicitly states whether content iframe should be created.

Parameters

value - System.Boolean

The value for Iframe

Height(System.Double)

The height (in pixels) of the Tooltip.

Parameters

value - System.Double

The value for Height

Width(System.Double)

The width (in pixels) of the Tooltip.

Parameters

value - System.Double

The value for Width

ShowAfter(System.Double)

Specify the delay in milliseconds before the Tooltip is shown. This option is ignored if showOn is set to "click" or "focus".

Parameters

value - System.Double

The value for ShowAfter

Position(Kendo.Mvc.UI.TooltipPosition)

Represents the tooltip position.

Parameters

value - TooltipPosition

The value for Position

ShowOn(Kendo.Mvc.UI.TooltipShowOnEvent)

Represents the tooltip position.

Parameters

value - TooltipShowOnEvent

The value for ShowOn

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<TooltipEventBuilder>

The client events action.

Example

Razor

 
            @(Html.Kendo().Tooltip()
                  .Name("Tooltip")
                  .Events(events => events
                      .ContentLoad("onContentLoad")
                  )
            )
             

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

RETURNS

Returns the current instance.

ScriptAttributes(System.Object,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Object

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter

encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.