ClassRadCalloutForm
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:
public class RadCalloutForm : ShapedForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IThemeChangeListener
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlFormShapedFormRadCalloutForm
Implements:
Inherited Members
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
ArrowDirection
Gets or sets the direction of the arrow of the callout.
Declaration
public ArrowDirection ArrowDirection { get; set; }
Property Value
ArrowSize
Gets or sets the size of the arrow of the callout.
ArrowType
Gets or sets the type of the arrow of the callout.
Declaration
public CalloutArrowType ArrowType { get; set; }
Property Value
AssociatedControl
Gets or sets the associated control that is displayed in the callout.
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.
BorderWidth
Gets or sets the border width of callout.
Declaration
[Browsable(true)]
public override int BorderWidth { get; set; }
Property Value
Overrides
CalloutShapeSettings
Gets or sets the CalloutShapeSettings used when creating callout shape.
Declaration
public CalloutShapeSettings CalloutShapeSettings { get; }
Property Value
CalloutType
Gets or sets the type of the shape of the callout.
Declaration
public CalloutType CalloutType { get; set; }
Property Value
CloseAction
Determines the executed action when the callout form is about to be closed.
Declaration
public CalloutCloseAction CloseAction { get; set; }
Property Value
CornerRadius
Gets or sets the size of the arrow of the callout. It is applicable when CalloutType is RoundedRectangle.
CreateParams
Declaration
protected override CreateParams CreateParams { get; }
Property Value
Overrides
Distance
Gets or sets the distance between the callout and the control(element) relative to which it is shown.
DropShadow
Gets or sets a value indicating whether the callout drops a shadow. Note that the shadow effect cannot be customized.
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.
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
Methods
ApplyShape()
Declaration
protected override void ApplyShape()
Overrides
ApplyTheme(string)
Declaration
protected override void ApplyTheme(string themeName)
Parameters
themeName
Overrides
Close()
Declaration
public void Close()
CreateBorderPath()
Declaration
protected override GraphicsPath CreateBorderPath()
Returns
Overrides
CreateCalloutShape()
Creates the callout element shape.
Declaration
protected virtual CalloutElementShape CreateCalloutShape()
Returns
The element shape.
Dispose(bool)
Clean up any resources being used.
Declaration
protected override void Dispose(bool disposing)
Parameters
disposing
true if managed resources should be disposed; otherwise, false.
Overrides
InitializeFields()
Initializes all fields/properties with their default values.
Declaration
protected virtual void InitializeFields()
OnCalloutClosed(FormClosedEventArgs)
Occurs when the callout form is closed. Fires the closed event.
Declaration
protected virtual void OnCalloutClosed(FormClosedEventArgs e)
Parameters
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
e
The event arguments.
OnFormClosing(FormClosingEventArgs)
Occurs when the callout form is about to be closed.
Declaration
protected override void OnFormClosing(FormClosingEventArgs e)
Parameters
e
The event arguments.
Overrides
OnOpened(EventArgs)
Occurs when the callout form is opened. Fires the opened event.
Declaration
protected virtual void OnOpened(EventArgs e)
Parameters
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
e
The event arguments.
OnVisibleChanged(EventArgs)
Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
e
Overrides
SetAssociatedControl(Control)
Sets the associated control. Adds the control to the form's Controls collection.
Declaration
protected virtual void SetAssociatedControl(Control control)
Parameters
control
The control to associate with.
Show(Control)
Shows a callout form pointing to a specific control.
Declaration
public void Show(Control control)
Parameters
control
The control to point to.
Show(Point)
Shows a callout form pointing to a specific location in screen coordinates.
Declaration
public void Show(Point arrowTargetPoint)
Parameters
arrowTargetPoint
The target location to point to.
Show(RadElement)
Shows a callout form pointing to a specific element.
Declaration
public void Show(RadElement element)
Parameters
element
The element to point to.
ShowCore(Rectangle)
Declaration
protected virtual void ShowCore(Rectangle anchorRectangle)
Parameters
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 Value
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 Value
Opened
Fires when the callout is opened.
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 Value