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

Provides shared association, positioning, and lifetime handling for overlay and flyout screens.

Definition

Constructors

Initializes overlay behavior and enables reactivation of the associated form when the overlay closes.

C#
public BaseOverlayScreen()

Fields

The form or child control whose visible bounds the overlay follows.

C#
protected Control associatedControl

The form that contains the associated control and whose lifetime and bounds are tracked.

C#
protected Form associatedControlForm

Indicates whether the associated control is itself a form.

C#
protected bool isAssociatedForm

Properties

Gets or sets whether the associated form is activated when the overlay or flyout closes.

C#
public bool ActivateAssociatedFormOnClose { get; set; }

Methods

Closes the overlay form.

C#
public virtual void Close()

Creates an overlay form.

C#
public override RadOverlayForm CreateFrom()
Returns:

RadOverlayForm

The created form.

Overrides: BaseSplash<RadOverlayForm>.CreateFrom()

Creates the action that applies the overlay's placement for an associated visible region.

C#
protected abstract Action CreateUpdateAction(Point location, Rectangle rect)
Parameters:locationPoint

The screen location at which the overlay region begins.

rectRectangle

The visible bounds, in screen coordinates for an associated form or top-level-ancestor client coordinates for a child control.

Returns:

Action

An action that updates the overlay form.

Closes the overlay when its associated form has closed.

C#
protected virtual void OnAssociatedFormClosed(object sender, FormClosedEventArgs e)
Parameters:senderobject

The form that raised the closed event.

eFormClosedEventArgs

The form-closed event data.

Validates and records a visible form or control, then subscribes to the events needed to track it.

C#
protected virtual bool PrepareAndAttachAssociatedControl(Control controlToAssociate)
Parameters:controlToAssociateControl

The visible form or a control hosted by a form.

Returns:

bool

true if the association was established; false if the control is not visible.

Exceptions: ArgumentException

The argument is null, or is a visible non-form control that is not hosted by a form.

Recalculates the overlay bounds from the associated form or the visible portion of its child control. Child-control bounds are clipped to the client areas of their ancestors.

C#
protected virtual void UpdateOverlayFormPosition()