CalloutPopupSettings

The CalloutPopupSettings class provides properties to control the display of RadCallout.

This article will list the key properties provided by the CalloutPopupSettings class.

• AutoClose: A boolean property that gets or sets a value indicating whether the host Popup of the callout will automatically close. By default, the control will capture the mouse, so clicking outside of the RadCallout, will close it. When this behavior is disabled, the control can be closed from the CalloutPopupService.Close() or CloseAll() method.

• ShowAnimationType: A property of type CalloutAnimation that gets or sets the type of shown animation.

• CloseAnimationType: A property of type CalloutAnimation that gets or sets the type of close animation.

  The CalloutAnimation is an enumeration and it allows the following values:

  • None
  • Fade
  • Move
  • FadeAndMove
  • Reveal
  • FadeAndReveal
  • Scale
  • FadeAndScale

• ShowAnimationDuration: A property of type double that gets or sets a duration of the animation when shown, in seconds.

• CloseAnimationDuration: A property of type double that gets or sets a duration of the animation when closed, in seconds.

• ShowAnimationEasing: A property of type IEasingFunction that gets or sets the easing function of the shown animation.

• CloseAnimationEasing: A property of type IEasingFunction that gets or sets the easing function of the close animation.

• ShowAnimationDelay: A property of type double that gets or sets a delay of the animation when shown, in seconds.

• CloseAnimationDelay: A property of type double that gets or sets a delay of the animation when closed, in seconds.

• MoveWithPlacementTargetParentWindow: A boolean property that gets or sets a value indicating whether the host popup will move along with the parent window of the placement target.

This property has effect only when Telerik.Windows.Controls.CalloutPopupSettings.AutoClose is false.

• ShowPopupExceedingScreen: A boolean property that gets or sets a value indicating whether the popup will be shown in intended placement position even if it exceeds the monitor boundaries. Default value is false.

• Placement: A property of type PlacementMode that gets or sets the placement of the Popup host. The PlacementMode is an enumeration and it allows the following values:

  • Absolute: The Popup will be positioned in the top-left corner of the screen. If the screen edge obscures the Popup, the control then repositions itself to align with the edge.
  • Relative: The Popup will be positioned in the top-left corner of the PlacementTarget element.
  • Bottom: The Popup control will align its upper/left edge with the lower/left edge of the PlacementTarget element.
  • Center: The Popup control will be centered over the PlacementTarget element.
  • Right: The Popup control will align its left/upper edge with the right/upper edge of the PlacementTarget element.
  • AbsolutePoint: The Popup will be positioned in the top-left corner of the screen. If the screen edge obscures the Popup, the control extends opposite the axis defined by the HorizontalOffset or VerticalOffset property.
  • RelativePoint: The Popup control will align its upper/left edge with the lower/left edge of the PlacementTarget element. If the screen edge obscures the Popup, the control extends opposite the axis defined by the HorizontalOffset or VerticalOffset property.
  • Mouse: The Popup control will align with the lower edge of the mouse's bounding box and align its left edge with the left edge of the mouse's bounding box.
  • MousePoint: The Popup control will be placed in position relative to the tip of the mouse cursor.
  • Left: The Popup control will align its right edge with the left edge of the PlacementTarget and align its upper edge with the upper edge of the PlacementTarget element.
  • Top: The Popup control will align its lower edge with the upper edge of the PlacementTarget and align its left edge with the left edge of the PlacementTarget.
  • Custom: The Popup will be positioned and repositioned depending on the CustomPopupPlacementCallback property of the Popup.

• AutoCenter: A boolean property that gets or sets a value indicating whether the Popup will be auto-centered to the placement target. By default, this behavior is enabled and will offset the control so that it is centered to its target. The RadCallout can be additionally offset by using the following properties.

• VerticalOffset: A boolean property that gets or sets the vertical offset of the host Popup. Default value is 0.

• HorizontalOffset: A boolean property that gets or sets the horizontal offset of the host Popup. Default value is 0.

• CanPopupExceedScreen: Indicates if the callout popup can exceed the screen bounds. The default behavior of the WPF Popup element is to automatically re-position when it reaches the screen bounds in order to remain inside the screen. Setting the property to true disables this behavior and the popup visual can be displayed outside of the monitor. The default value is false.

See Also

• Getting Started
• CalloutPopupService