Class RadCalloutForm

The callout form is a ShapedForm and provides a form with integrated arrow, which points to a specific location, control or element.

Inheritance
System.Object
ShapedForm
RadCalloutForm
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadCalloutForm : ShapedForm, IThemeChangeListener

Constructors

RadCalloutForm()

Initializes a new instance of the RadCalloutForm.

Declaration
public RadCalloutForm()

Properties

AnimationManager

Gets or sets the animation manager, which holds the animation settings and is responsible for the animation.

Declaration
public CalloutAnimationManager AnimationManager { get; set; }
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.

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

BorderWidth

Gets or sets the border width of callout.

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

Overrides

CalloutShapeSettings

Gets or sets the CalloutShapeSettings used when creating callout shape.

Declaration
public CalloutShapeSettings CalloutShapeSettings { get; }
Property Value
CalloutShapeSettings

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

CreateParams

Declaration
protected override CreateParams CreateParams { get; }
Property Value
System.Windows.Forms.CreateParams

Overrides

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

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

Shape

This property is not intended to be used in this class. RadCalloutForm uses a CalloutElementShape.

Declaration
public override ElementShape Shape { get; set; }
Property Value
ElementShape

Overrides

TargetManager

Gets the class responsible for following changes of the size and location of the target control or element when the callout is shown.

Declaration
public CalloutTargetManager TargetManager { get; }
Property Value
CalloutTargetManager

Methods

ApplyShape()

Declaration
protected override void ApplyShape()
Overrides

ApplyTheme(String)

Declaration
protected override void ApplyTheme(string themeName)
Parameters
System.String themeName

Overrides

Close()

Declaration
public void Close()

CorrectShowPoint(Point, Point, out Point)

Declaration
protected virtual Point CorrectShowPoint(Point calloutLocation, Point anchorPoint, out Point offset)
Parameters
System.Drawing.Point calloutLocation

System.Drawing.Point anchorPoint

System.Drawing.Point offset

Returns
System.Drawing.Point

CreateBorderPath()

Declaration
protected override GraphicsPath CreateBorderPath()
Returns
System.Drawing.Drawing2D.GraphicsPath

Overrides

CreateCalloutShape()

Creates the callout element shape.

Declaration
protected virtual CalloutElementShape CreateCalloutShape()
Returns
CalloutElementShape

The element shape.

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

InitializeFields()

Initializes all fields/properties with their default values.

Declaration
protected virtual void InitializeFields()

IsRectangularShape(ref Int32)

Declaration
protected override bool IsRectangularShape(ref int radius)
Parameters
System.Int32 radius

Returns
System.Boolean

Overrides

OnCalloutClosed(FormClosedEventArgs)

Occurs when the callout form is closed. Fires the closed event.

Declaration
protected virtual void OnCalloutClosed(FormClosedEventArgs e)
Parameters
System.Windows.Forms.FormClosedEventArgs e

The event arguments.

OnCalloutClosing(FormClosingEventArgs)

Occurs when the callout form is about to be closed. Fires the closing event.

Declaration
protected virtual void OnCalloutClosing(FormClosingEventArgs e)
Parameters
System.Windows.Forms.FormClosingEventArgs e

The event arguments.

OnFormClosing(FormClosingEventArgs)

Occurs when the callout form is about to be closed.

Declaration
protected override void OnFormClosing(FormClosingEventArgs e)
Parameters
System.Windows.Forms.FormClosingEventArgs e

The event arguments.

OnOpened(EventArgs)

Occurs when the callout form is opened. Fires the opened event.

Declaration
protected virtual void OnOpened(EventArgs e)
Parameters
System.EventArgs e

The event arguments.

OnOpening(CancelEventArgs)

Occurs when the callout form is about to be opened. Fires the opening event.

Declaration
protected virtual void OnOpening(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

The event arguments.

OnVisibleChanged(EventArgs)

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
System.EventArgs e

SetAssociatedControl(Control)

Sets the associated control. Adds the control to the form's System.Windows.Forms.Control.Controls collection.

Declaration
protected virtual void SetAssociatedControl(Control control)
Parameters
System.Windows.Forms.Control control

The control to associate with.

Show()

Declaration
public void Show()

Show(Point)

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

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

The target location to point to.

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

Declaration
public void Show(IWin32Window owner)
Parameters
System.Windows.Forms.IWin32Window owner

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.

ShowCore(Rectangle)

Declaration
protected virtual void ShowCore(Rectangle anchorRectangle)
Parameters
System.Drawing.Rectangle anchorRectangle

UpdateAssociatedControlPosition()

Updates the location of associated control.

Declaration
protected virtual void UpdateAssociatedControlPosition()

Events

CalloutClosed

Fires when the callout is closed.

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

CalloutClosing

Fires when the callout is about to be closed. The closing action can be canceled by modifying the arguments of this event.

Declaration
public event FormClosingEventHandler CalloutClosing
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 is about to be opened. The opening action can be canceled by modifying the arguments of this event.

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

Extension Methods