RadCallout
The RadCallout component can host any Control and is used to display additional information, warnings, hints, or to highlight relevant data. It provides a flexible way to create callout forms with customizable appearance, arrow direction, and animation effects.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Dialogs")]
public class RadCallout : Component, IComponent, IDisposableInheritance: objectMarshalByRefObjectComponentRadCallout
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadCallout class.
public RadCallout()Properties
Gets the animation manager for the callout, which controls all animation settings and is responsible for showing and hiding animations. Use this property to configure the callout's animation behavior.
public CalloutAnimationManager AnimationManager { get; }Gets or sets the direction of the callout's arrow. The arrow direction determines which side of the callout the arrow points from.
public ArrowDirection ArrowDirection { get; set; }Gets or sets the size of the callout's arrow. This property controls both the width and height of the arrow element.
public Size ArrowSize { get; set; }Gets or sets the arrow type of the callout. Determines the visual style of the callout's pointing arrow.
public CalloutArrowType ArrowType { get; set; }Gets or sets the control that is displayed inside the callout. Only a single control can be associated with RadCallout. If you need to display multiple controls, add them to a container control such as RadPanel and associate the container with the callout.
public Control AssociatedControl { get; set; }Gets or sets a value indicating whether the callout will automatically close when the user clicks outside of it. When true, the mouse is captured by the callout. When false, the user must close the callout manually or by calling Close().
public bool AutoClose { get; set; }Gets the underlying RadCalloutForm instance that represents the callout window. This property provides access to the form for advanced configuration and manipulation.
[Browsable(false)]
public RadCalloutForm CalloutForm { get; }Gets or sets the shape type of the callout. Determines whether the callout has a rectangular or rounded rectangular appearance.
public CalloutType CalloutType { get; set; }Gets or sets the action to perform when the callout form is about to be closed. Determines whether the callout form is hidden or disposed when closing.
public CalloutCloseAction CloseAction { get; set; }Gets or sets the corner radius for rounded rectangle callouts. This property is only applicable when CalloutType is set to RoundedRectangle.
public int CornerRadius { get; set; }Gets or sets the distance between the callout and the target control or element. This distance is measured in pixels and affects the positioning of the callout relative to its target.
public int Distance { get; set; }Gets or sets a value indicating whether the callout displays a drop shadow effect. The shadow appearance cannot be customized beyond enabling or disabling it.
public bool DropShadow { get; set; }Gets or sets the title for error messages displayed when the callout form is disposed. This message is shown when attempting to display a callout that has already been disposed.
public static string ErrorCaption { get; set; }Gets or sets the content for error messages displayed when the callout form is disposed. This message is shown when attempting to display a callout that has already been disposed.
public static string ErrorMessage { get; set; }Gets or sets a value indicating whether the callout will move along with its parent form when the form is moved. This property only has effect when AutoClose is set to false.
public bool MoveWithParentForm { get; set; }Methods
Closes the callout form. The actual behavior depends on the CloseAction property setting.
public void Close()Creates the callout form instance. This method can be overridden to provide custom callout form implementation.
Releases the resources used by the component and its associated callout form.
protected override void Dispose(bool disposing)true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides:
Shows a callout by given content over the provided target control.
public static RadCallout Show(Control content, Control targetControl, CalloutShapeSettings shapeSettings = null)The control that represents the content of the callout.
targetControlControlThe target control.
shapeSettingsCalloutShapeSettingsThe callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns:The callout.
Shows a callout by given content over the provided target point.
public static RadCallout Show(Control content, Point targetPoint, CalloutShapeSettings shapeSettings = null)The control that represents the content of the callout.
targetPointPointThe target screen location.
shapeSettingsCalloutShapeSettingsThe callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns:The callout.
Shows a callout by given content over the provided target element.
public static RadCallout Show(Control content, RadElement targetElement, CalloutShapeSettings shapeSettings = null)The control that represents the content of the callout.
targetElementRadElementThe target element.
shapeSettingsCalloutShapeSettingsThe callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns:The callout.
Shows a screen tip in a callout over the provided target control.
public static RadCallout Show(Control targetControl, string content, string caption = "", string footer = "", CalloutShapeSettings shapeSettings = null)The target control.
contentstringThe content of tool tip.
captionstringThe header(Caption) of tool tip.
footerstringThe footer of tool tip.
shapeSettingsCalloutShapeSettingsThe callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns:Shows the callout form pointing to a specific control. If the callout form has been disposed, an error message will be displayed instead.
public void Show(Control control)The control that the callout should point to.
Shows a screen tip in a callout over the provided target point.
public static RadCallout Show(Point targetPoint, string content, string caption = "", string footer = "", CalloutShapeSettings shapeSettings = null)The target screen location.
contentstringThe content of tool tip.
captionstringThe header(Caption) of tool tip.
footerstringThe footer of tool tip.
shapeSettingsCalloutShapeSettingsThe callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns:Shows the callout form pointing to a specific location in screen coordinates. If the callout form has been disposed, an error message will be displayed instead.
public void Show(Point location)The screen coordinates where the callout should point to.
Shows a screen tip in a given callout over the provided target control.
public static void Show(RadCallout callout, Control targetControl, string content, string caption = "", string footer = "")The callout.
targetControlControlThe target control.
contentstringThe content of tool tip.
captionstringThe header(Caption) of tool tip.
footerstringThe footer of tool tip.
Shows a screen tip in a given callout over the provided target screen point.
public static void Show(RadCallout callout, Point targetPoint, string content, string caption = "", string footer = "")The callout.
targetPointPointThe target point.
contentstringThe content of tool tip.
captionstringThe header(Caption) of tool tip.
footerstringThe footer of tool tip.
Shows a screen tip in a given callout over the provided target element.
public static void Show(RadCallout callout, RadElement targetElement, string content, string caption = "", string footer = "")The callout.
targetElementRadElementThe target element.
contentstringThe content of tool tip.
captionstringThe header(Caption) of tool tip.
footerstringThe footer of tool tip.
Shows a screen tip in a callout over the provided target element.
public static RadCallout Show(RadElement targetElement, string content, string caption = "", string footer = "", CalloutShapeSettings shapeSettings = null)The target element.
contentstringThe content of tool tip.
captionstringThe header(Caption) of tool tip.
footerstringThe footer of tool tip.
shapeSettingsCalloutShapeSettingsThe callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns:Shows the callout form pointing to a specific RadElement. If the callout form has been disposed, an error message will be displayed instead.
public void Show(RadElement element)The RadElement that the callout should point to.
Events
Occurs when the callout has been closed.
public event FormClosedEventHandler ClosedOccurs when the callout is about to be closed. This event is cancellable.
public event FormClosingEventHandler ClosingOccurs when the callout has been opened and is visible.
public event EventHandler OpenedOccurs when the callout is about to be opened. This event is cancellable.
public event CancelEventHandler Opening