RadCalloutForm
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
Initializes a new instance of the RadCalloutForm.
public RadCalloutForm()
Properties
Gets or sets the animation manager, which holds the animation settings and is responsible for the animation.
public CalloutAnimationManager AnimationManager { get; set; }
Gets or sets the direction of the arrow of the callout.
public ArrowDirection ArrowDirection { get; set; }
Gets or sets the size of the arrow of the callout.
public Size ArrowSize { get; set; }
Gets or sets the type of the arrow of the callout.
public CalloutArrowType ArrowType { get; set; }
Gets or sets the associated control that is displayed in the callout.
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.
public bool AutoClose { get; set; }
Gets or sets the border width of callout.
[Browsable(true)]
public override int BorderWidth { get; set; }
Overrides:
Gets or sets the CalloutShapeSettings used when creating callout shape.
public CalloutShapeSettings CalloutShapeSettings { get; }
Gets or sets the type of the shape of the callout.
public CalloutType CalloutType { get; set; }
Determines the executed action when the callout form is about to be closed.
public CalloutCloseAction CloseAction { get; set; }
Gets or sets the size of the arrow of the callout. It is applicable when CalloutType is RoundedRectangle.
public int CornerRadius { get; set; }
protected override CreateParams CreateParams { get; }
Overrides:
Gets or sets the distance between the callout and the control(element) relative to which it is shown.
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.
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.
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.
public CalloutTargetManager TargetManager { get; }
Methods
protected override void ApplyShape()
Overrides:
public void Close()
Creates the callout element shape.
protected virtual CalloutElementShape CreateCalloutShape()
The element shape.
Clean up any resources being used.
protected override void Dispose(bool disposing)
true if managed resources should be disposed; otherwise, false.
Overrides:
Initializes all fields/properties with their default values.
protected virtual void InitializeFields()
Occurs when the callout form is closed. Fires the closed event.
protected virtual void OnCalloutClosed(FormClosedEventArgs e)
The event arguments.
Occurs when the callout form is about to be closed. Fires the closing event.
protected virtual void OnCalloutClosing(FormClosingEventArgs e)
The event arguments.
Occurs when the callout form is about to be closed.
protected override void OnFormClosing(FormClosingEventArgs e)
The event arguments.
Overrides:
Occurs when the callout form is opened. Fires the opened event.
Occurs when the callout form is about to be opened. Fires the opening event.
protected virtual void OnOpening(CancelEventArgs e)
The event arguments.
Shows a callout form pointing to a specific control.
Shows a callout form pointing to a specific location in screen coordinates.
public void Show(Point arrowTargetPoint)
The target location to point to.
Shows a callout form pointing to a specific element.
Updates the location of associated control.
protected virtual void UpdateAssociatedControlPosition()
Events
Fires when the callout is closed.
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.
public event FormClosingEventHandler CalloutClosing
Fires when the callout is opened.
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.
public event CancelEventHandler Opening