New to Telerik UI for ASP.NET Core? Download free 30-day trial

TooltipBuilder

Defines the fluent API for configuring the Kendo UI Tooltip

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

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 the elements within the container which will display the Tooltip.

Parameters

value - System.String

The value for Filter

Iframe(System.Boolean)

Explicitly states whether a content iframe will 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)

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

HideAfter(System.Double)

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

Parameters

value - System.Double

The value for HideAfter

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

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


            @(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

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.

Example


             <%= 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.

Example


             <%= 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.

Example


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

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

Parameters

actionName - System.String
controllerName - System.String
routeValues - Microsoft.AspNetCore.Routing.RouteValueDictionary

LoadContentFrom(System.String)

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

Parameters

value - System.String

The url.

Example


             <%= 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.

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

ContentHandler(System.Func)

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

Parameters

handler - System.Func<Object,Object>

ContentHandler(System.String)

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

Parameters

handler - System.String

JavaScript function name

Animation(System.Boolean)

Configures the animation effects of the window.

Parameters

enable - System.Boolean

Whether the component animation is enabled.

Example


            <%= 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.

Example


            <%= 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


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

ToComponent()

Returns the internal view component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

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

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

Deferred(System.Boolean)

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

Parameters

deferred - System.Boolean

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

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

The HTML attributes.

Render()

Renders the component in place.

ToHtmlString()

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

Parameters

writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

In this article
Not finding the help you need?