BaseOverlayScreen
Provides shared association, positioning, and lifetime handling for overlay and flyout screens.
Definition
Namespace:Telerik.WinControls.UI.SplashScreen
Assembly:Telerik.WinControls.UI.dll
Syntax:
public abstract class BaseOverlayScreen : BaseSplash<RadOverlayForm>, IDisposable
Inheritance: objectBaseSplash<RadOverlayForm>BaseOverlayScreen
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes overlay behavior and enables reactivation of the associated form when the overlay closes.
public BaseOverlayScreen()
Fields
The form or child control whose visible bounds the overlay follows.
protected Control associatedControl
The form that contains the associated control and whose lifetime and bounds are tracked.
protected Form associatedControlForm
Indicates whether the associated control is itself a form.
protected bool isAssociatedForm
Properties
Gets or sets whether the associated form is activated when the overlay or flyout closes.
public bool ActivateAssociatedFormOnClose { get; set; }
Methods
Closes the overlay form.
public virtual void Close()
Creates an overlay form.
Creates the action that applies the overlay's placement for an associated visible region.
protected abstract Action CreateUpdateAction(Point location, Rectangle rect)
The screen location at which the overlay region begins.
rectRectangleThe visible bounds, in screen coordinates for an associated form or top-level-ancestor client coordinates for a child control.
Returns:An action that updates the overlay form.
Closes the overlay when its associated form has closed.
protected virtual void OnAssociatedFormClosed(object sender, FormClosedEventArgs e)
The form that raised the closed event.
eFormClosedEventArgsThe form-closed event data.
Validates and records a visible form or control, then subscribes to the events needed to track it.
protected virtual bool PrepareAndAttachAssociatedControl(Control controlToAssociate)
The visible form or a control hosted by a form.
Returns:true if the association was established; false if the control is not visible.
Exceptions: ArgumentExceptionThe 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.
protected virtual void UpdateOverlayFormPosition()