RadToolTipManager
RadTooltipManager class
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[RequiredScript(typeof(RadToolTipScripts))]
[ClientScriptResource("Telerik.Web.UI.RadToolTipManager", "Telerik.Web.UI.ToolTip.Scripts.RadToolTipManager.js")]
[TelerikToolboxCategory("Container")]
[ToolboxBitmap(typeof(RadToolTipManager), "Toolbox.Icons.ToolTip.png")]
public class RadToolTipManager : RadToolTipBase, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControlInheritance: objectControlWebControlRadWebControlRadToolTipBaseRadToolTipManager...
Derived Classes:
Implements:
Inherited Members
Constructors
public RadToolTipManager()Properties
Gets or sets a value whether the RadToolTipManager, when its TargetControls collection is empty will tooltipify automatically all elements on the page that have a 'title' attribute
[ClientControlProperty]
[Browsable(true)]
[Bindable(true)]
public bool AutoTooltipify { get; set; }Gets or sets a value indicating whether the content of loaded on demand tooltip should be cached after the first request.
[ClientControlProperty]
[ClientPropertyName("enableDataCaching")]
public bool EnableDataCaching { get; set; }True if data should be cached; otherwise false. The default value is false.
When caching is enabled only one request will be performed for each target, regardless of how many times the tooltip will be shown. By default a new request is performed each time the tooltip must be shown (caching is disabled).
Gets or sets a value indicating the client-side event handler that is called when the RadToolTipManager when a call to a WebService is initiated or AJAX request is started.
[ClientControlEvent]
[ClientPropertyName("requestStart")]
public virtual string OnClientRequestStart { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClientRequestStart client-side event handler is called when the request is started Two parameters are passed to the handler:
- sender, the RadToolTipManager object.
- args.
This event can be cancelled.
Gets or sets a value indicating the client-side event handler that is called when the RadToolTipManager receives the server response from a WebService or AJAX request.
[ClientControlEvent]
[ClientPropertyName("requestEnd")]
public virtual string OnClientResponseEnd { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClientResponseEnd client-side event handler is called before the RadToolTipManager displays the content returned from the server. Two parameters are passed to the handler:
- sender, the RadToolTipManager object.
- args.
This event cannot be cancelled.
Gets or sets a value indicating the client-side event handler that is called when the Load On Demand call to the WebService or the AJAX request is interrupted by an error.
[ClientPropertyName("responseError")]
[ClientControlEvent]
public virtual string OnClientResponseError { get; set; }The collection of TargetControl objects that allows for specifying the objects for which tooltips will be created on the client-side.
[PersistenceMode(PersistenceMode.InnerProperty)]
public ToolTipTargetControlCollection TargetControls { get; }The collection of TargetControl objects that allows for specifying the objects for which tooltips will be created on the client-side.
Use the TargetControls collection to programmatically control which objects should be tooltipified on the client-side.
Gets or sets the id (ClientID if a runat=server is used) of a html element whose children will be tooltipified
[ClientControlProperty]
[Browsable(true)]
[Bindable(true)]
public string ToolTipZoneID { get; set; }Gets a reference to the UpdatePanel property of RadToolTipManager. The UpdatePanel allows for sending AJAX content to the client-side during the OnAjaxUpdate event.
public UpdatePanel UpdatePanel { get; }Gets a reference to the UpdatePanel property of RadToolTipManager. The UpdatePanel allows for sending AJAX content to the client-side during the OnAjaxUpdate event.
Gets the settings for the web service used to populate items.
[PersistenceMode(PersistenceMode.InnerProperty)]
public WebServiceSettings WebServiceSettings { get; }An WebServiceSettings that represents the web service used for populating items.
Use the WebServiceSettings property to configure the web service used to populate items on demand. You must specify both Path and Method to fully describe the service.
In order to use the integrated support, the web service should have the following signature:
<pre><code class="lang-csharp">[ScriptService]public class WebServiceName : WebService { [WebMethod] public string WebServiceMethodName(object context) { // We cannot use a dictionary as a parameter, because it is only supported by script services. // The context object should be cast to a dictionary at runtime. IDictionary<string, object> contextDictionary = (IDictionary<string, object>) context;
//... }}
Methods
Allows for dynamic content to be set into the tooltip with an ajax request. The tooltip triggers the event when it is shown on the client.
protected virtual void OnAjaxUpdate(ToolTipUpdateEventArgs e)If specified, the OnAjaxUpdate is triggered when the tooltip is shown on the client. Two parameters are passed to the handler:
- sender, the RadToolTip object.
- args.
This event cannot be cancelled.
Events
The event is used to load content on-demand in the tooltip via AJAX
public event ToolTipUpdateEventHandler AjaxUpdateThe event handler takes two parameters - an object for the sender and an object of type ToolTipUpdateEventArgs for the event arguments. The event cannot be cancelled.