Class RadCallout

The RadCallout component can host any System.Windows.Forms.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.

Inheritance
System.Object
RadCallout
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Dialogs")]
public class RadCallout : Component

Constructors

RadCallout()

Initializes a new instance of the RadCallout class.

Declaration
public RadCallout()

Properties

AnimationManager

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.

Declaration
public CalloutAnimationManager AnimationManager { get; }
Property Value
CalloutAnimationManager

ArrowDirection

Gets or sets the direction of the callout's arrow. The arrow direction determines which side of the callout the arrow points from.

Declaration
public ArrowDirection ArrowDirection { get; set; }
Property Value
ArrowDirection

ArrowSize

Gets or sets the size of the callout's arrow. This property controls both the width and height of the arrow element.

Declaration
public Size ArrowSize { get; set; }
Property Value
System.Drawing.Size

ArrowType

Gets or sets the arrow type of the callout. Determines the visual style of the callout's pointing arrow.

Declaration
public CalloutArrowType ArrowType { get; set; }
Property Value
CalloutArrowType

AssociatedControl

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.

Declaration
public Control AssociatedControl { get; set; }
Property Value
System.Windows.Forms.Control

AutoClose

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().

Declaration
public bool AutoClose { get; set; }
Property Value
System.Boolean

CalloutForm

Gets the underlying RadCalloutForm instance that represents the callout window. This property provides access to the form for advanced configuration and manipulation.

Declaration
public RadCalloutForm CalloutForm { get; }
Property Value
RadCalloutForm

CalloutType

Gets or sets the shape type of the callout. Determines whether the callout has a rectangular or rounded rectangular appearance.

Declaration
public CalloutType CalloutType { get; set; }
Property Value
CalloutType

CloseAction

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.

Declaration
public CalloutCloseAction CloseAction { get; set; }
Property Value
CalloutCloseAction

CornerRadius

Gets or sets the corner radius for rounded rectangle callouts. This property is only applicable when CalloutType is set to RoundedRectangle.

Declaration
public int CornerRadius { get; set; }
Property Value
System.Int32

Distance

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.

Declaration
public int Distance { get; set; }
Property Value
System.Int32

DropShadow

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.

Declaration
public bool DropShadow { get; set; }
Property Value
System.Boolean

ErrorCaption

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.

Declaration
public static string ErrorCaption { get; set; }
Property Value
System.String

ErrorMessage

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.

Declaration
public static string ErrorMessage { get; set; }
Property Value
System.String

MoveWithParentForm

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.

Declaration
public bool MoveWithParentForm { get; set; }
Property Value
System.Boolean

ThemeName

Gets or sets the theme name for the callout. The theme controls the visual appearance of the callout form. If not specified, the callout will use the default theme.

Declaration
public string ThemeName { get; set; }
Property Value
System.String

Methods

Close()

Closes the callout form. The actual behavior depends on the CloseAction property setting.

Declaration
public void Close()

CreateCalloutForm()

Creates the callout form instance. This method can be overridden to provide custom callout form implementation.

Declaration
protected virtual RadCalloutForm CreateCalloutForm()
Returns
RadCalloutForm

A new instance of RadCalloutForm.

Show(Point)

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.

Declaration
public void Show(Point location)
Parameters
System.Drawing.Point location

The screen coordinates where the callout should point to.

Show(Point, String, String, String, CalloutShapeSettings)

Shows a screen tip in a callout over the provided target point.

Declaration
public static RadCallout Show(Point targetPoint, string content, string caption = "", string footer = "", CalloutShapeSettings shapeSettings = null)
Parameters
System.Drawing.Point targetPoint

The target screen location.
System.String content

The content of tool tip.
System.String caption

The header(Caption) of tool tip.
System.String footer

The footer of tool tip.
CalloutShapeSettings shapeSettings

The callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns
RadCallout

Show(Control)

Shows the callout form pointing to a specific control. If the callout form has been disposed, an error message will be displayed instead.

Declaration
public void Show(Control control)
Parameters
System.Windows.Forms.Control control

The control that the callout should point to.

Show(Control, Point, CalloutShapeSettings)

Shows a callout by given content over the provided target point.

Declaration
public static RadCallout Show(Control content, Point targetPoint, CalloutShapeSettings shapeSettings = null)
Parameters
System.Windows.Forms.Control content

The control that represents the content of the callout.
System.Drawing.Point targetPoint

The target screen location.
CalloutShapeSettings shapeSettings

The callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns
RadCallout

The callout.

Show(Control, String, String, String, CalloutShapeSettings)

Shows a screen tip in a callout over the provided target control.

Declaration
public static RadCallout Show(Control targetControl, string content, string caption = "", string footer = "", CalloutShapeSettings shapeSettings = null)
Parameters
System.Windows.Forms.Control targetControl

The target control.
System.String content

The content of tool tip.
System.String caption

The header(Caption) of tool tip.
System.String footer

The footer of tool tip.
CalloutShapeSettings shapeSettings

The callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns
RadCallout

Show(Control, Control, CalloutShapeSettings)

Shows a callout by given content over the provided target control.

Declaration
public static RadCallout Show(Control content, Control targetControl, CalloutShapeSettings shapeSettings = null)
Parameters
System.Windows.Forms.Control content

The control that represents the content of the callout.
System.Windows.Forms.Control targetControl

The target control.
CalloutShapeSettings shapeSettings

The callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns
RadCallout

The callout.

Show(Control, RadElement, CalloutShapeSettings)

Shows a callout by given content over the provided target element.

Declaration
public static RadCallout Show(Control content, RadElement targetElement, CalloutShapeSettings shapeSettings = null)
Parameters
System.Windows.Forms.Control content

The control that represents the content of the callout.
RadElement targetElement

The target element.
CalloutShapeSettings shapeSettings

The callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns
RadCallout

The callout.

Show(RadElement)

Shows the callout form pointing to a specific RadElement. If the callout form has been disposed, an error message will be displayed instead.

Declaration
public void Show(RadElement element)
Parameters
RadElement element

The RadElement that the callout should point to.

Show(RadElement, String, String, String, CalloutShapeSettings)

Shows a screen tip in a callout over the provided target element.

Declaration
public static RadCallout Show(RadElement targetElement, string content, string caption = "", string footer = "", CalloutShapeSettings shapeSettings = null)
Parameters
RadElement targetElement

The target element.
System.String content

The content of tool tip.
System.String caption

The header(Caption) of tool tip.
System.String footer

The footer of tool tip.
CalloutShapeSettings shapeSettings

The callout shape settings related to callout shape, arrow direction, arrow size etc.
Returns
RadCallout

Show(RadCallout, Point, String, String, String)

Shows a screen tip in a given callout over the provided target screen point.

Declaration
public static void Show(RadCallout callout, Point targetPoint, string content, string caption = "", string footer = "")
Parameters
RadCallout callout

The callout.
System.Drawing.Point targetPoint

The target point.
System.String content

The content of tool tip.
System.String caption

The header(Caption) of tool tip.
System.String footer

The footer of tool tip.

Show(RadCallout, Control, String, String, String)

Shows a screen tip in a given callout over the provided target control.

Declaration
public static void Show(RadCallout callout, Control targetControl, string content, string caption = "", string footer = "")
Parameters
RadCallout callout

The callout.
System.Windows.Forms.Control targetControl

The target control.
System.String content

The content of tool tip.
System.String caption

The header(Caption) of tool tip.
System.String footer

The footer of tool tip.

Show(RadCallout, RadElement, String, String, String)

Shows a screen tip in a given callout over the provided target element.

Declaration
public static void Show(RadCallout callout, RadElement targetElement, string content, string caption = "", string footer = "")
Parameters
RadCallout callout

The callout.
RadElement targetElement

The target element.
System.String content

The content of tool tip.
System.String caption

The header(Caption) of tool tip.
System.String footer

The footer of tool tip.

Events

Closed

Occurs when the callout has been closed.

Declaration
public event FormClosedEventHandler Closed
Event Type
System.Windows.Forms.FormClosedEventHandler

Closing

Occurs when the callout is about to be closed. This event is cancellable.

Declaration
public event FormClosingEventHandler Closing
Event Type
System.Windows.Forms.FormClosingEventHandler

Opened

Occurs when the callout has been opened and is visible.

Declaration
public event EventHandler Opened
Event Type
System.EventHandler

Opening

Occurs when the callout is about to be opened. This event is cancellable.

Declaration
public event CancelEventHandler Opening
Event Type
System.ComponentModel.CancelEventHandler

Extension Methods