Class FloatingForm

The floating form control.

Inheritance
System.Object
FloatingForm
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class FloatingForm : Form, IDraggable, IDockingManagerDesignerMouseHook, IDockable

Constructors

FloatingForm(DockingManager)

Constructor of the floating form.

Declaration
public FloatingForm(DockingManager dmgr)
Parameters
Type Name Description
DockingManager dmgr

The DockingManager instance.

Fields

bActive

Declaration
protected bool bActive
Field Value
Type Description
System.Boolean

bAutoHideButtonVisibility

Declaration
protected bool bAutoHideButtonVisibility
Field Value
Type Description
System.Boolean

bCloseButtonVisibility

Declaration
protected bool bCloseButtonVisibility
Field Value
Type Description
System.Boolean

formCaption

Declaration
protected string formCaption
Field Value
Type Description
System.String

m_bUsed

Declaration
protected bool m_bUsed
Field Value
Type Description
System.Boolean

m_owner

Declaration
protected DockStateControllerBase m_owner
Field Value
Type Description
DockStateControllerBase

nNamingCount

Declaration
protected static int nNamingCount
Field Value
Type Description
System.Int32

rcDrag

Declaration
protected Rectangle rcDrag
Field Value
Type Description
System.Drawing.Rectangle

Properties

AutoHideButtonVisibility

Gets/Sets value to display AutoHideButton in Floating Form

Declaration
public bool AutoHideButtonVisibility { get; set; }
Property Value
Type Description
System.Boolean

AutoHideMode

Gets/Sets value to define AutoHideMode in Floating Form

Declaration
public AutoHideStatus AutoHideMode { get; set; }
Property Value
Type Description
AutoHideStatus

CloseButtonVisibility

Gets / Sets the CloseButtonVisibility

Declaration
public bool CloseButtonVisibility { get; set; }
Property Value
Type Description
System.Boolean

CreateParams

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

DragDockInfo

Gets / Sets the DragDockInfo

Declaration
public DockInfo DragDockInfo { get; set; }
Property Value
Type Description
DockInfo

DragRectangle

Gets / Sets the DragRectangle

Declaration
public Rectangle DragRectangle { get; set; }
Property Value
Type Description
System.Drawing.Rectangle

FormBorderStyle

Gets or sets the border style of the form.

Declaration
public FormBorderStyle FormBorderStyle { get; set; }
Property Value
Type Description
System.Windows.Forms.FormBorderStyle

ImageRect

Gets the Image rectangle.

Declaration
public Rectangle ImageRect { get; }
Property Value
Type Description
System.Drawing.Rectangle

Text

Gets / Sets the Text

Declaration
public override string Text { get; set; }
Property Value
Type Description
System.String

Methods

AbortDrag()

Cancel the Drag operation.

Declaration
public void AbortDrag()

AllowedDragAxis(ref Point, Point)

Returns the allowed drag axis.

Declaration
public DragAxis AllowedDragAxis(ref Point ptdrag, Point ptdelta)
Parameters
Type Name Description
System.Drawing.Point ptdrag

The mouse point of the drag location.
System.Drawing.Point ptdelta

The mouse point.
Returns
Type Description
DragAxis

The dragged axis.

CreateAccessibilityInstance()

Creates a new accessibility object in FloatingForm.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

A new System.Windows.Forms.AccessibleObject for the FloatingForm, when AccessibilityEnabled for DockingManager is set as true

Disable()

Disable the control.

Declaration
public void Disable()

Dispose(Boolean)

Declaration
protected override void Dispose(bool bdisposing)
Parameters
Type Name Description
System.Boolean bdisposing

DrawHollow()

Returns the DrawHollow

Declaration
public bool DrawHollow()
Returns
Type Description
System.Boolean

DrawWindowTextAndImage(ref Message)

Declaration
protected void DrawWindowTextAndImage(ref Message msg)
Parameters
Type Name Description
System.Windows.Forms.Message msg

Enable()

Indicates the enable.

Declaration
public void Enable()

Enable(Boolean)

Indicates the enable.

Declaration
public void Enable(bool show)
Parameters
Type Name Description
System.Boolean show

Indicates whether it needs to be enable or not.

GetCaptionFont()

Declaration
protected Font GetCaptionFont()
Returns
Type Description
System.Drawing.Font

GetController()

Gets the controller.

Declaration
public DockControllerBase GetController()
Returns
Type Description
DockControllerBase

GetDesignMode()

Gets the design mode of the FloatingForm.

Declaration
public bool GetDesignMode()
Returns
Type Description
System.Boolean

GetImageRect(Rectangle)

Declaration
protected Rectangle GetImageRect(Rectangle rcBounds)
Parameters
Type Name Description
System.Drawing.Rectangle rcBounds
Returns
Type Description
System.Drawing.Rectangle

GetImageRect(RectangleF)

Declaration
protected Rectangle GetImageRect(RectangleF rcBoundsF)
Parameters
Type Name Description
System.Drawing.RectangleF rcBoundsF
Returns
Type Description
System.Drawing.Rectangle

GetTextRectFromBounds(RectangleF, ref Rectangle)

Declaration
protected Rectangle GetTextRectFromBounds(RectangleF bounds, ref Rectangle imageRect)
Parameters
Type Name Description
System.Drawing.RectangleF bounds
System.Drawing.Rectangle imageRect
Returns
Type Description
System.Drawing.Rectangle

HandleDoubleClick(Point)

Handles the double click.

Declaration
public void HandleDoubleClick(Point ptscreen)
Parameters
Type Name Description
System.Drawing.Point ptscreen

The mouse point.

HandleMouseDown(MouseButtons, Point)

Handles the mouse down.

Declaration
public void HandleMouseDown(MouseButtons button, Point ptscreen)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The MouseButtons.
System.Drawing.Point ptscreen

The mouse point.

HandleMouseLeave()

Handles the mouse leave.

Declaration
public void HandleMouseLeave()

HandleMouseMove(MouseButtons, Point)

Handles the mouse move.

Declaration
public void HandleMouseMove(MouseButtons button, Point ptscreen)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The MouseButtons.
System.Drawing.Point ptscreen

The mouse point.

HandleMouseUp(MouseButtons, Point)

Handles the mouse up.

Declaration
public void HandleMouseUp(MouseButtons button, Point ptscreen)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The MouseButtons.
System.Drawing.Point ptscreen

The mouse point.

InitiateDrag(MouseAction, Point)

Initiate the drag

Declaration
public bool InitiateDrag(MouseAction action, Point ptscreen)
Parameters
Type Name Description
MouseAction action

The mouse action.
System.Drawing.Point ptscreen

The mouse point
Returns
Type Description
System.Boolean

InitiateFloatingResize(Point, Int32)

Initiate the FloatingResize.

Declaration
public void InitiateFloatingResize(Point ptscreen, int nchittest)
Parameters
Type Name Description
System.Drawing.Point ptscreen

The mouse point
System.Int32 nchittest

IsDefaultRendering()

Indicates if the Default//VS2005 style is set with Vista Aero Theme enabled.

Declaration
public bool IsDefaultRendering()
Returns
Type Description
System.Boolean

IsSuitableDockTarget(DockControllerBase)

Implementation of the IDraggable interface methods

Declaration
public bool IsSuitableDockTarget(DockControllerBase dc)
Parameters
Type Name Description
DockControllerBase dc

The DockControllerBase instance.
Returns
Type Description
System.Boolean

OnControlAdded(ControlEventArgs)

Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

OnControlRemoved(ControlEventArgs)

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

OnHandleDestroyed(EventArgs)

Declaration
protected override void OnHandleDestroyed(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnLoad(EventArgs)

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

OnLocationChanged(EventArgs)

Declaration
protected override void OnLocationChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnMouseLeave(EventArgs)

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

OnVisibleChanged(EventArgs)

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

ProcessCmdKey(ref Message, Keys)

Declaration
protected override bool ProcessCmdKey(ref Message m, Keys keydata)
Parameters
Type Name Description
System.Windows.Forms.Message m
System.Windows.Forms.Keys keydata
Returns
Type Description
System.Boolean

QueryDragProceedWithDock()

Returns the QueryDragProceedWithDock.

Declaration
public bool QueryDragProceedWithDock()
Returns
Type Description
System.Boolean

Refresh()

Overrides the Refresh.

Declaration
public override void Refresh()

UpdateControlBoxVisibility()

Update the control box visibility.

Declaration
public void UpdateControlBoxVisibility()

UpdateFormBorderStyle()

Updates Form BorderStyles, Icon and caption text for Vista Aero Themed OS.

Declaration
public void UpdateFormBorderStyle()

UpdateFormMinimumSize()

Declaration
protected void UpdateFormMinimumSize()

UpdateFormPosition(Int32, Int32)

Declaration
protected void UpdateFormPosition(int nScreenWidth, int nScreenHeight)
Parameters
Type Name Description
System.Int32 nScreenWidth
System.Int32 nScreenHeight

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message msg)
Parameters
Type Name Description
System.Windows.Forms.Message msg

Implements