New to Telerik UI for WinForms? Start a free 30-day trial

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

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadCalloutForm : ShapedForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IThemeChangeListener

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlFormShapedFormRadCalloutForm...

Implements: IBindableComponentIComponentIContainerControlIDisposableIDropTargetISynchronizeInvokeIThemeChangeListenerIWin32Window...

Inherited Members ShapedForm.OnThemeChanged(ThemeChangedEventArgs)ShapedForm.SetBoundsCore(int, int, int, int, BoundsSpecified)ShapedForm.SetClientSizeCore(int, int)ShapedForm.OnLoad(EventArgs)ShapedForm.OnShown(EventArgs)ShapedForm.OnPaintBackground(PaintEventArgs)ShapedForm.OnSizeChanged(EventArgs)ShapedForm.WndProc(ref Message)ShapedForm.ApplicationThemeChanged(object, ThemeChangedEventArgs)ShapedForm.ScaleControl(SizeF, BoundsSpecified)ShapedForm.OnResizeBegin(EventArgs)ShapedForm.OnResizeEnd(EventArgs)ShapedForm.OnMove(EventArgs)ShapedForm.PaintFrame(Graphics)ShapedForm.PaintBorder(Graphics)ShapedForm.GetHitTest(Point)ShapedForm.LOWORD(int)ShapedForm.ShapedControlShapedForm.WindowsSettingsShapedForm.BackColorShapedForm.BorderColorShapedForm.ForeColorShapedForm.FontShapedForm.BorderAlignmentShapedForm.AllowResizeShapedForm.ShapeShapedForm.ThemeNameShapedForm.EnableCompositionOnVistaShapedForm.FormBorderStyleShapedForm.ControlThemeClassNameShapedForm.BorderPathShapedForm.OuterPathForm.SetVisibleCore(bool)Form.Activate()Form.ActivateMdiChild(Form)Form.AddOwnedForm(Form)Form.AdjustFormScrollbars(bool)Form.CreateControlsInstance()Form.CreateHandle()Form.DefWndProc(ref Message)Form.ProcessMnemonic(char)Form.CenterToParent()Form.CenterToScreen()Form.LayoutMdi(MdiLayout)Form.OnActivated(EventArgs)Form.OnBackgroundImageChanged(EventArgs)Form.OnBackgroundImageLayoutChanged(EventArgs)Form.OnClosing(CancelEventArgs)Form.OnClosed(EventArgs)Form.OnFormClosed(FormClosedEventArgs)Form.OnCreateControl()Form.OnDeactivate(EventArgs)Form.OnEnabledChanged(EventArgs)Form.OnEnter(EventArgs)Form.OnFontChanged(EventArgs)Form.OnHandleCreated(EventArgs)Form.OnHandleDestroyed(EventArgs)Form.OnHelpButtonClicked(CancelEventArgs)Form.OnLayout(LayoutEventArgs)Form.OnMaximizedBoundsChanged(EventArgs)Form.OnMaximumSizeChanged(EventArgs)Form.OnMinimumSizeChanged(EventArgs)Form.OnInputLanguageChanged(InputLanguageChangedEventArgs)Form.OnInputLanguageChanging(InputLanguageChangingEventArgs)Form.OnMdiChildActivate(EventArgs)Form.OnMenuStart(EventArgs)Form.OnMenuComplete(EventArgs)Form.OnPaint(PaintEventArgs)Form.OnResize(EventArgs)Form.OnDpiChanged(DpiChangedEventArgs)Form.OnGetDpiScaledSize(int, int, ref Size)Form.OnRightToLeftLayoutChanged(EventArgs)Form.OnTextChanged(EventArgs)Form.ProcessCmdKey(ref Message, Keys)Form.ProcessDialogKey(Keys)Form.ProcessDialogChar(char)Form.ProcessKeyPreview(ref Message)Form.ProcessTabKey(bool)Form.RemoveOwnedForm(Form)Form.Select(bool, bool)Form.GetScaledBounds(Rectangle, SizeF, BoundsSpecified)Form.SetDesktopBounds(int, int, int, int)Form.SetDesktopLocation(int, int)Form.Show(IWin32Window)Form.ShowDialog()Form.ShowDialog(IWin32Window)Form.ToString()Form.UpdateDefaultButton()Form.OnStyleChanged(EventArgs)Form.ValidateChildren()Form.ValidateChildren(ValidationConstraints)Form.AcceptButtonForm.ActiveFormForm.ActiveMdiChildForm.AllowTransparencyForm.AutoScrollForm.AutoSizeForm.AutoSizeModeForm.AutoValidateForm.CancelButtonForm.ClientSizeForm.ControlBoxForm.DefaultImeModeForm.DefaultSizeForm.DesktopBoundsForm.DesktopLocationForm.DialogResultForm.HelpButtonForm.IconForm.IsMdiChildForm.IsMdiContainerForm.IsRestrictedWindowForm.KeyPreviewForm.LocationForm.MaximizedBoundsForm.MaximumSizeForm.MainMenuStripForm.MenuForm.MinimumSizeForm.MaximizeBoxForm.MdiChildrenForm.MdiParentForm.MergedMenuForm.MinimizeBoxForm.ModalForm.OpacityForm.OwnedFormsForm.OwnerForm.RestoreBoundsForm.RightToLeftLayoutForm.ShowInTaskbarForm.ShowIconForm.ShowWithoutActivationForm.SizeForm.SizeGripStyleForm.StartPositionForm.TextForm.TopLevelForm.TopMostForm.TransparencyKeyForm.WindowStateForm.AutoSizeChangedForm.AutoValidateChangedForm.HelpButtonClickedForm.MaximizedBoundsChangedForm.MaximumSizeChangedForm.MinimumSizeChangedForm.ActivatedForm.DeactivateForm.FormClosingForm.FormClosedForm.LoadForm.MdiChildActivateForm.MenuCompleteForm.MenuStartForm.InputLanguageChangedForm.InputLanguageChangingForm.RightToLeftLayoutChangedForm.ShownForm.DpiChangedForm.ResizeBeginForm.ResizeEnd...

Constructors

Initializes a new instance of the RadCalloutForm.

C#
public RadCalloutForm()

Properties

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

C#
public CalloutAnimationManager AnimationManager { get; set; }

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

C#
public ArrowDirection ArrowDirection { get; set; }

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

C#
public Size ArrowSize { get; set; }

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

C#
public CalloutArrowType ArrowType { get; set; }

Gets or sets the associated control that is displayed in the callout.

C#
public Control AssociatedControl { get; set; }

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.

C#
public bool AutoClose { get; set; }

Gets or sets the border width of callout.

C#
[Browsable(true)]
public override int BorderWidth { get; set; }

Overrides: ShapedForm.BorderWidth

Gets or sets the CalloutShapeSettings used when creating callout shape.

C#
public CalloutShapeSettings CalloutShapeSettings { get; }

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

C#
public CalloutType CalloutType { get; set; }

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

C#
public CalloutCloseAction CloseAction { get; set; }

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

C#
public int CornerRadius { get; set; }

Adds the native drop-shadow class style when DropShadow is enabled and the operating system supports it.

C#
protected override CreateParams CreateParams { get; }

Overrides: ShapedForm.CreateParams

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

C#
public int Distance { get; set; }

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

C#
public bool DropShadow { get; set; }

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.

C#
public bool MoveWithParentForm { get; set; }

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

C#
public CalloutTargetManager TargetManager { get; }

Methods

Applies the current shape and refreshes the form so the callout outline is redrawn.

C#
protected override void ApplyShape()

Overrides: ShapedForm.ApplyShape()

Applies the specified theme to the form and its control tree.

C#
protected override void ApplyTheme(string themeName)
Parameters:themeNamestring

The theme name to apply.

Overrides: ShapedForm.ApplyTheme(string)

When visible, raises CalloutClosing and then hides or closes the form according to CloseAction. A canceled notification leaves the callout open. If already hidden, only the Close action closes the form.

C#
public void Close()

Adjusts the proposed callout location to fit the working area of the screen containing the anchor point.

C#
protected virtual Point CorrectShowPoint(Point calloutLocation, Point anchorPoint, out Point offset)
Parameters:calloutLocationPoint

The proposed top-left location.

anchorPointPoint

The screen-space point used to select the working area.

offsetPoint

Receives the adjustment applied to the proposed location.

Returns:

Point

The corrected top-left location.

Creates the form border path from the callout shape, or uses the base path if no callout shape is available.

C#
protected override GraphicsPath CreateBorderPath()
Returns:

GraphicsPath

The path used to draw the form border.

Overrides: ShapedForm.CreateBorderPath()

Creates the callout element shape.

C#
protected virtual CalloutElementShape CreateCalloutShape()
Returns:

CalloutElementShape

The element shape.

Disposes the callout's created animation, message-listener, and target managers before disposing the form.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

true when managed resources should be disposed.

Overrides: ShapedForm.Dispose(bool)

Initializes all fields/properties with their default values.

C#
protected virtual void InitializeFields()

Reports whether the current callout can use rectangular-form handling; triangular arrows require a custom shape. For rounded rectangles, sets radius to twice the configured corner radius.

C#
protected override bool IsRectangularShape(ref int radius)
Parameters:radiusint

Receives the corner radius used by rectangular-form handling.

Returns:

bool

true when the callout has no triangular arrow; otherwise, false.

Overrides: ShapedForm.IsRectangularShape(ref int)

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

C#
protected virtual void OnCalloutClosed(FormClosedEventArgs e)
Parameters:eFormClosedEventArgs

The event arguments.

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

C#
protected virtual void OnCalloutClosing(FormClosingEventArgs e)
Parameters:eFormClosingEventArgs

The event arguments.

Occurs when the callout form is about to be closed.

C#
protected override void OnFormClosing(FormClosingEventArgs e)
Parameters:eFormClosingEventArgs

The event arguments.

Overrides: Form.OnFormClosing(FormClosingEventArgs)

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

C#
protected virtual void OnOpened(EventArgs e)
Parameters:eEventArgs

The event arguments.

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

C#
protected virtual void OnOpening(CancelEventArgs e)
Parameters:eCancelEventArgs

The event arguments.

Starts the show or close animation when the form's visibility changes.

C#
protected override void OnVisibleChanged(EventArgs e)
Parameters:eEventArgs

The event data.

Overrides: Form.OnVisibleChanged(EventArgs)

Sets the associated control. Adds the control to the form's Controls collection.

C#
protected virtual void SetAssociatedControl(Control control)
Parameters:controlControl

The control to associate with.

Shows a callout form pointing to a specific control.

C#
public void Show(Control control)
Parameters:controlControl

The control to point to.

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

C#
public void Show(Point arrowTargetPoint)
Parameters:arrowTargetPointPoint

The target location to point to.

Shows a callout form pointing to a specific element.

C#
public void Show(RadElement element)
Parameters:elementRadElement

The element to point to.

If an associated control is set, positions the callout against the screen-space anchor and raises Opening. The form is not shown when no control is associated or when the opening event is canceled.

C#
protected virtual void ShowCore(Rectangle anchorRectangle)
Parameters:anchorRectangleRectangle

The target rectangle in screen coordinates.

Updates the location of associated control.

C#
protected virtual void UpdateAssociatedControlPosition()

Events

Fires when the callout is closed.

C#
public event FormClosedEventHandler CalloutClosed

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

C#
public event FormClosingEventHandler CalloutClosing

Fires when the callout is opened.

C#
public event EventHandler Opened

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

C#
public event CancelEventHandler Opening