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.

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, which holds all the animation settings and is responsible for the callout animations.

Declaration
public CalloutAnimationManager AnimationManager { get; }
Property Value
CalloutAnimationManager

ArrowDirection

Gets or sets the direction of the arrow of the callout.

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

ArrowSize

Gets or sets the size of the arrow of the callout.

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

ArrowType

Gets or sets the type of the arrow of the callout.

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

AssociatedControl

Gets or sets the associated control that is displayed in the callout. Note that you can associate a single control to RadCallout. If you need to add multiple controls, add them in a container(for example RadPanel) control and associate it with RadCallout.

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. If true, the Mouse is captured in the callout. If false, user is responsible for closing the callout form either manually or with Close() method.

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

CalloutForm

Gets the callout form.

Declaration
public RadCalloutForm CalloutForm { get; }
Property Value
RadCalloutForm

CalloutType

Gets or sets the type of the shape of the callout.

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

CloseAction

Determines the executed action when the callout form is about to be closed.

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

CornerRadius

Gets or sets the size of the arrow of the callout. It is applicable when CalloutType is RoundedRectangle.

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

Distance

Gets or sets the distance between the callout and the control(element) relative to which it is shown.

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

DropShadow

Gets or sets a value indicating whether the callout drops a shadow. Note that the shadow effect cannot be customized.

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

ErrorCaption

Gets or sets the title(caption) of the error message.

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

ErrorMessage

Gets or sets the content of the error message.

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 the parent form of the placement target. This property has effect only when AutoClose is false.

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

ThemeName

Gets or sets theme name.

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

Methods

Close()

Closes the callout form.

Declaration
public void Close()

CreateCalloutForm()

Creates the callout form.

Declaration
protected virtual RadCalloutForm CreateCalloutForm()
Returns
RadCalloutForm

The callout form.

Show(Point)

Shows a callout form pointing to a specific location in screen coordinates.

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

The location to 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 a callout form pointing to a specific control.

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

The control to 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 a callout form pointing to a specific element.

Declaration
public void Show(RadElement element)
Parameters
RadElement element

The element to 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

Fires when the callout is closed.

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

Closing

Fires when the callout about to be closed. Cancellable.

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

Opened

Fires when the callout is opened.

Declaration
public event EventHandler Opened
Event Type
System.EventHandler

Opening

Fires when the callout about to be opened. Cancellable.

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

Extension Methods