Class

RadCallout

Initializes a new instance of the RadCallout class.

Declaration

public RadCallout()

Gets the animation manager for the callout, which controls all animation settings and is responsible for showing and hiding animations. Use this property to configure the callout's animation behavior.

Declaration

public CalloutAnimationManager AnimationManager { get; }

Property Value

Gets or sets the direction of the callout's arrow. The arrow direction determines which side of the callout the arrow points from.

Declaration

public ArrowDirection ArrowDirection { get; set; }

Property Value

Gets or sets the size of the callout's arrow. This property controls both the width and height of the arrow element.

Declaration

public Size ArrowSize { get; set; }

Property Value

Gets or sets the arrow type of the callout. Determines the visual style of the callout's pointing arrow.

Declaration

public CalloutArrowType ArrowType { get; set; }

Property Value

Gets or sets the control that is displayed inside the callout. Only a single control can be associated with RadCallout. If you need to display multiple controls, add them to a container control such as RadPanel and associate the container with the callout.

Declaration

public Control AssociatedControl { get; set; }

Property Value

Gets or sets a value indicating whether the callout will automatically close when the user clicks outside of it. When true, the mouse is captured by the callout. When false, the user must close the callout manually or by calling Close().

Declaration

public bool AutoClose { get; set; }

Property Value

Gets the underlying RadCalloutForm instance that represents the callout window. This property provides access to the form for advanced configuration and manipulation.

Declaration

[Browsable(false)]
public RadCalloutForm CalloutForm { get; }

Property Value

Gets or sets the shape type of the callout. Determines whether the callout has a rectangular or rounded rectangular appearance.

Declaration

public CalloutType CalloutType { get; set; }

Property Value

Gets or sets the action to perform when the callout form is about to be closed. Determines whether the callout form is hidden or disposed when closing.

Declaration

public CalloutCloseAction CloseAction { get; set; }

Property Value

Gets or sets the corner radius for rounded rectangle callouts. This property is only applicable when CalloutType is set to RoundedRectangle.

Declaration

public int CornerRadius { get; set; }

Property Value

Gets or sets the distance between the callout and the target control or element. This distance is measured in pixels and affects the positioning of the callout relative to its target.

Declaration

public int Distance { get; set; }

Property Value

Gets or sets a value indicating whether the callout displays a drop shadow effect. The shadow appearance cannot be customized beyond enabling or disabling it.

Declaration

public bool DropShadow { get; set; }

Property Value

Gets or sets the title for error messages displayed when the callout form is disposed. This message is shown when attempting to display a callout that has already been disposed.

Declaration

public static string ErrorCaption { get; set; }

Property Value

Gets or sets the content for error messages displayed when the callout form is disposed. This message is shown when attempting to display a callout that has already been disposed.

Declaration

public static string ErrorMessage { get; set; }

Property Value

Gets or sets a value indicating whether the callout will move along with its parent form when the form is moved. This property only has effect when AutoClose is set to false.

Declaration

public bool MoveWithParentForm { get; set; }

Property Value

Gets or sets the theme name for the callout. The theme controls the visual appearance of the callout form. If not specified, the callout will use the default theme.

Declaration

[Browsable(true)]
public string ThemeName { get; set; }

Property Value

Closes the callout form. The actual behavior depends on the CloseAction property setting.

Declaration

public void Close()

Creates the callout form instance. This method can be overridden to provide custom callout form implementation.

Declaration

protected virtual RadCalloutForm CreateCalloutForm()

Returns

Releases the resources used by the component and its associated callout form.

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides Component.Dispose(bool)

Shows the callout form pointing to a specific control. If the callout form has been disposed, an error message will be displayed instead.

Declaration

public void Show(Control control)

Parameters

Shows a callout by given content over the provided target control.

Declaration

public static RadCallout Show(Control content, Control targetControl, CalloutShapeSettings shapeSettings = null)

Parameters

Returns

Shows a callout by given content over the provided target point.

Declaration

public static RadCallout Show(Control content, Point targetPoint, CalloutShapeSettings shapeSettings = null)

Parameters

Returns

Shows a callout by given content over the provided target element.

Declaration

public static RadCallout Show(Control content, RadElement targetElement, CalloutShapeSettings shapeSettings = null)

Parameters

Returns

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

Returns

Shows the callout form pointing to a specific location in screen coordinates. If the callout form has been disposed, an error message will be displayed instead.

Declaration

public void Show(Point location)

Parameters

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

Returns

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

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

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

Shows the callout form pointing to a specific RadElement. If the callout form has been disposed, an error message will be displayed instead.

Declaration

public void Show(RadElement element)

Parameters

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

Returns

Occurs when the callout has been closed.

Declaration

public event FormClosedEventHandler Closed

Event Value

Occurs when the callout is about to be closed. This event is cancellable.

Declaration

public event FormClosingEventHandler Closing

Event Value

Occurs when the callout has been opened and is visible.

Declaration

public event EventHandler Opened

Event Value

Occurs when the callout is about to be opened. This event is cancellable.

Declaration

public event CancelEventHandler Opening

Event Value