Class FloatingWindow

Represents a popup form that is used to host floating DockWindow instances.

Inheritance
System.Object
RadFormControlBase
RadForm
DockPopupForm
FloatingWindow
Inherited Members
Namespace: Telerik.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock.dll

Syntax

public class FloatingWindow : DockPopupForm, IComponentTreeHandler, ILayoutHandler, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged, IAnalyticsProvider

Constructors

FloatingWindow()

Initializes a new instance of the FloatingWindow class. This method supports internal RadDock infrastructure and should not be called directly from your code.

Declaration
public FloatingWindow()

FloatingWindow(RadDock)

Initializes a new instance of the FloatingWindow class with the specified dock manager.

Declaration
public FloatingWindow(RadDock dockManager)
Parameters
RadDock dockManager

The RadDock instance that will own and manage this floating window.

Fields

DefaultFloatingSize

Defines the default size for floating windows.

Declaration
public static readonly Size DefaultFloatingSize
Field Value
System.Drawing.Size

Properties

CreateParams

Gets the required creation parameters when the control handle is created.

Declaration
protected override CreateParams CreateParams { get; }
Property Value
System.Windows.Forms.CreateParams

A CreateParams object containing the required creation parameters when the handle is created.
Overrides

DockContainer

Gets the RadSplitContainer instance that is the root of the hierarchy of DockWindows inside this FloatingWindow.

Declaration
public RadSplitContainer DockContainer { get; }
Property Value
RadSplitContainer

The RadSplitContainer that hosts the docked windows.

SnapOnMove

Gets or sets a value indicating whether this window should snap to edges while being moved.

Declaration
public bool SnapOnMove { get; set; }
Property Value
System.Boolean

true if snapping while moving is enabled; otherwise, false.

SnapOnResize

Gets or sets a value indicating whether this window should snap to edges while being resized.

Declaration
public bool SnapOnResize { get; set; }
Property Value
System.Boolean

true if snapping while resizing is enabled; otherwise, false.

SnapThreshold

Gets or sets the distance in pixels between window edges at which snapping occurs.

Declaration
public int SnapThreshold { get; set; }
Property Value
System.Int32

The distance threshold in pixels that triggers the snapping behavior.

SnapToOthers

Gets or sets a value indicating whether this window should snap to other windows when moved or resized.

Declaration
public bool SnapToOthers { get; set; }
Property Value
System.Boolean

true if snapping to other windows is enabled; otherwise, false.

SnapToScreen

Gets or sets a value indicating whether this window should snap to the screen's edges when moved or resized.

Declaration
public bool SnapToScreen { get; set; }
Property Value
System.Boolean

true if snapping to screen edges is enabled; otherwise, false.

Standalone

Gets or sets a value indicating whether the floating form should be shown in the task bar and behave like a normal form, or it should be kept as a child form of the form which owns the RadDock.

Declaration
public bool Standalone { get; set; }
Property Value
System.Boolean

true if the window should appear in the taskbar as a standalone window; otherwise, false to keep it as a child window of the form containing the RadDock.

ThemeClassName

Gets or sets the theme class name for this floating window.

Declaration
public override string ThemeClassName { get; set; }
Property Value
System.String

The fully qualified name of the FloatingWindow type.
Overrides
Remarks

This override enables separate theming for floating windows distinct from standard RadForm controls.

Methods

ControlDefinesThemeForElement(RadElement)

Determines whether this control defines the theme for a given element.

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

The element to check for theme definition.
Returns
System.Boolean

true if the element is a RadFormTitleBarElement; otherwise, the result of the base implementation.
Overrides
Remarks

This override enables separate styling of the title bar in floating windows.

Dispose(Boolean)

Releases the unmanaged resources used by the FloatingWindow and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

EndInit()

Signals the object that initialization is complete.

Declaration
public override void EndInit()
Overrides
Remarks

This method is called at the end of initialization and updates the visibility of the window.

GetSnappedBounds(Rectangle, ResizeDirection, Boolean)

Gets the target bounds when the window snaps to another one.

Declaration
public virtual Rectangle GetSnappedBounds(Rectangle desired, ResizeDirection direction, bool resize)
Parameters
System.Drawing.Rectangle desired

The original window bounds.
ResizeDirection direction

The direction in which the window is being resized/moved.
System.Boolean resize

[true] if this is a resize operation, [false] otherwise.
Returns
System.Drawing.Rectangle

The bounds of the window after snapping.

OnActivated(EventArgs)

Raises the System.Windows.Forms.Form.Activated event and manages z-ordering of all popup forms.

Declaration
protected override void OnActivated(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Remarks

This override provides support for proper z-ordering of all popup forms belonging to the owning form.

OnClosing(CancelEventArgs)

Raises the System.Windows.Forms.Form.Closing event.

Declaration
protected override void OnClosing(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

A System.ComponentModel.CancelEventArgs that contains the event data.
Remarks

This method cancels the default closing behavior and delegates the closing process to the dock manager.

OnLoad(EventArgs)

Raises the System.Windows.Forms.Form.Load event.

Declaration
protected override void OnLoad(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnShown(EventArgs)

Raises the System.Windows.Forms.Form.Shown event.

Declaration
protected override void OnShown(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnThemeChanged()

Notifies the control that its theme has changed.

Declaration
protected override void OnThemeChanged()
Overrides
Remarks

This method delegates the theme change event to all nested ToolTabStrip instances.

UpdateCloseButton()

Updates the enabled state of the close button based on the contained dock windows.

Declaration
public void UpdateCloseButton()

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

Overrides

Extension Methods