WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class FloatWindow

    Show / Hide Table of Contents

    Class FloatWindow

    Represents docking manager's floating window and helper frame internal window.

    Inheritance
    System.Object
    NonStickingPopup
    FloatWindow
    Implements
    IWindow
    Inherited Members
    NonStickingPopup.Removehandle()
    Namespace: Syncfusion.Windows.Tools.Controls
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    public class FloatWindow : NonStickingPopup, IWindow
    Examples

    This example shows how to use FloatWindow in C#.

    FloatWindow fw = new FloatWindow( dockingManager, true );
    fw.Height = 100;
    fw.Width = 50;
    dockingManager.Children.Add( fw );

    This example shows how to initialize the style of the FloatWindow class in XAML.

    <Style x:Key="{x:Type Syncfusion:FloatWindow}" TargetType="{x:Type ContentControl}">
    <Setter Property="Template" Value="{StaticResource FloatWindowTemplate}" />
    </Style>

    This example shows how to initialize the template of the FloatWindow class in XAML.

    <ControlTemplate x:Key="FloatWindowTemplate" TargetType="{x:Type ContentControl}">
    <AdornerDecorator>
    <DockPanel Focusable="False" LastChildFill="True" >
    <Border Name="FloatWindowOutBorder"  Focusable="False" BorderBrush="Red" BorderThickness="5" Background="Gray">
    <Grid Focusable="False">
    <Grid.RowDefinitions>
    <RowDefinition Name="TopRow" Height="25" />
    <RowDefinition Height="*" />
    <RowDefinition Name="BottomRow" Height="4" />
    </Grid.RowDefinitions>
    <Grid.ColumnDefinitions>
    <ColumnDefinition Name="LeftCol" Width="4" />
    <ColumnDefinition Width="*" />
    <ColumnDefinition Name="RightCol" Width="4" />
    </Grid.ColumnDefinitions>
    <Syncfusion:FloatWindowBorder BorderMode="LeftTop" Name="BorderLeftTop" Grid.Column="0" Grid.Row="0" />
    <Syncfusion:FloatWindowBorder BorderMode="Header" Name="BorderHeader" Grid.Column="1" Grid.Row="0" />
    <Syncfusion:FloatWindowBorder BorderMode="RightTop" Name="BorderRightTop" Grid.Column="2" Grid.Row="0" />
    <Syncfusion:FloatWindowBorder BorderMode="Left" Name="BorderLeft" Grid.Column="0" Grid.Row="1" />
    <ContentPresenter Name="ContentPresenter"  Grid.Column="1" Grid.Row="1"
    ContentTemplate="{TemplateBinding ContentControl.ContentTemplate}"
    Content="{TemplateBinding ContentControl.Content}" />
    <Syncfusion:FloatWindowBorder BorderMode="Right" Name="BorderRight" Grid.Column="2" Grid.Row="1" />
    <Syncfusion:FloatWindowBorder BorderMode="LeftBottom" Name="BorderLeftBottom" Grid.Column="0" Grid.Row="2" />
    <Syncfusion:FloatWindowBorder BorderMode="Bottom" Name="BorderBottom" Grid.Column="1" Grid.Row="2" />
    <Syncfusion:FloatWindowBorder BorderMode="RightBottom" Name="BorderRightBottom" Grid.Column="2" Grid.Row="2" />
    </Grid>
    </Border>
    </DockPanel>
    </AdornerDecorator>
    </ControlTemplate>

    Constructors

    FloatWindow(DockingManager, Boolean)

    Initializes a new instance of the FloatWindow class.

    Declaration
    public FloatWindow(DockingManager docking, bool isAllowsTransparency)
    Parameters
    Type Name Description
    DockingManager docking

    The docking.

    System.Boolean isAllowsTransparency

    if set to true [is allows transparency].

    Fields

    DockingManagerProperty

    Identifies DockingManager dependency property of the FloatWindow.

    Declaration
    public static readonly DependencyProperty DockingManagerProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IsCalled

    protected variable for iscalled flag

    Declaration
    protected bool IsCalled
    Field Value
    Type Description
    System.Boolean

    IsDraggingProperty

    Identifies IsDragging dependency property of the FloatWindow.

    Declaration
    public static readonly DependencyProperty IsDraggingProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    PrimaryElementProperty

    Identifies PrimaryElement dependency property of the FloatWindow.

    Declaration
    public static readonly DependencyProperty PrimaryElementProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    DockingManager

    Gets or sets the docking manager.

    Declaration
    public DockingManager DockingManager { get; set; }
    Property Value
    Type Description
    DockingManager

    The docking manager.

    FloatChild

    Gets or sets a value indicating whether Float container for window.

    Declaration
    public FrameworkElement FloatChild { get; set; }
    Property Value
    Type Description
    System.Windows.FrameworkElement

    The float child.

    Header

    Gets or sets the header.

    Declaration
    public UIElement Header { get; set; }
    Property Value
    Type Description
    System.Windows.UIElement

    The header.

    HitTestDisabled

    Gets or sets a value indicating whether HitTestDisabled of the FloatWindow.

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

    true if [hit test disabled]; otherwise, false.

    Is64bitOS

    Gets a value indicating whether [is64bit OS].

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

    true if [is64bit OS]; otherwise, false.

    IsDragging

    Gets or sets a value indicating whether IsDragging of the FloatWindow.

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

    true if this instance is dragging; otherwise, false.

    IsMultiHostsContainer

    Gets or sets a value indicating whether this instance is multi hosts container.

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

    true if this instance is multi hosts container; otherwise, false.

    PrimaryElement

    Gets or sets PrimaryElement of the FloatWindow.This is a dependency property.

    Declaration
    public FrameworkElement PrimaryElement { get; set; }
    Property Value
    Type Description
    System.Windows.FrameworkElement

    Methods

    CompleteDragging()

    Invoke when the dragging completes.

    Declaration
    public void CompleteDragging()

    GetForegroundWindow()

    Gets the foreground window.

    Declaration
    public static IntPtr GetForegroundWindow()
    Returns
    Type Description
    System.IntPtr

    return Intptr value.

    getParentWindow()

    Gets the parent window.

    Declaration
    protected Window getParentWindow()
    Returns
    Type Description
    System.Windows.Window

    GetVisibleHostsCount(DockedElementsContainer)

    Mehtod used to get the visible hosts count.

    Declaration
    public int GetVisibleHostsCount(DockedElementsContainer container)
    Parameters
    Type Name Description
    DockedElementsContainer container

    The container.

    Returns
    Type Description
    System.Int32

    return count of visible host.

    OnClosed(EventArgs)

    Represents the OnClosed Method

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

    OnGotFocus(RoutedEventArgs)

    Raises the GotFocus event.

    Declaration
    protected override void OnGotFocus(RoutedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.RoutedEventArgs e

    An RoutedEventArgs that contains the event data.

    OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

    Raises the GotKeyboardFocus event.

    Declaration
    protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyboardFocusChangedEventArgs e

    An KeyboardFocusChangedEventArgs that contains the event data.

    OnGotMouseCapture(MouseEventArgs)

    Invoked when an unhandled GotMouseCapture�attached event reaches an element in its route that is derived from this class.

    Declaration
    protected override void OnGotMouseCapture(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e

    The MouseEventArgs that contains the event data.

    OnInitialized(EventArgs)

    Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever DockingManager.IsInitialized is set to true internally.

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

    The System.Windows.RoutedEventArgs that contains the event data.

    OnMouseDown(MouseButtonEventArgs)

    Represents the OnMouseDown event

    Declaration
    protected override void OnMouseDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    OnOpened(EventArgs)

    Raises the Opened event.

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

    An EventArgs that contains the event data.

    Overrides
    NonStickingPopup.OnOpened(EventArgs)

    OnPreviewMouseDown(MouseButtonEventArgs)

    Represents the OnPreviewMouseDown event

    Declaration
    protected override void OnPreviewMouseDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    OnPreviewTouchDown(TouchEventArgs)

    Represents the OnPreviewTouchDown method.

    Declaration
    protected override void OnPreviewTouchDown(TouchEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TouchEventArgs e

    OnStylusSystemGesture(StylusSystemGestureEventArgs)

    Declaration
    protected override void OnStylusSystemGesture(StylusSystemGestureEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.StylusSystemGestureEventArgs e

    OnTouchEnter(TouchEventArgs)

    Represent the OnTouchEnter method

    Declaration
    protected override void OnTouchEnter(TouchEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TouchEventArgs e

    OnTouchLeave(TouchEventArgs)

    Represents the OnTouchLeave method

    Declaration
    protected override void OnTouchLeave(TouchEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TouchEventArgs e

    OnTouchMove(TouchEventArgs)

    Declaration
    protected override void OnTouchMove(TouchEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TouchEventArgs e

    OnTouchUp(TouchEventArgs)

    Represents the OnTouchUp method

    Declaration
    protected override void OnTouchUp(TouchEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TouchEventArgs e

    SetNewPrimaryElement(FrameworkElement)

    Inovke when set the new primary element.

    Declaration
    public void SetNewPrimaryElement(FrameworkElement element)
    Parameters
    Type Name Description
    System.Windows.FrameworkElement element

    The element.

    SetWindowOnTop()

    Puts the popup on the top of all other floating windows.

    Declaration
    public void SetWindowOnTop()

    UpdateDataContext()

    Invoke when the data context updates.

    Declaration
    public void UpdateDataContext()

    UpdateIsMultiHostProperty()

    Invoke IsMultiHost property updates.

    Declaration
    public void UpdateIsMultiHostProperty()

    Explicit Interface Implementations

    IWindow.get_AllowsTransparency()

    Declaration
    bool IWindow.get_AllowsTransparency()
    Returns
    Type Description
    System.Boolean

    IWindow.get_Child()

    Declaration
    UIElement IWindow.get_Child()
    Returns
    Type Description
    System.Windows.UIElement

    IWindow.get_IsOpen()

    Declaration
    bool IWindow.get_IsOpen()
    Returns
    Type Description
    System.Boolean

    IWindow.get_Opacity()

    Declaration
    double IWindow.get_Opacity()
    Returns
    Type Description
    System.Double

    IWindow.get_PlacementRectangle()

    Declaration
    Rect IWindow.get_PlacementRectangle()
    Returns
    Type Description
    System.Windows.Rect

    IWindow.set_AllowsTransparency(Boolean)

    Declaration
    void IWindow.set_AllowsTransparency(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    IWindow.set_Child(UIElement)

    Declaration
    void IWindow.set_Child(UIElement value)
    Parameters
    Type Name Description
    System.Windows.UIElement value

    IWindow.set_IsOpen(Boolean)

    Declaration
    void IWindow.set_IsOpen(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    IWindow.set_Opacity(Double)

    Declaration
    void IWindow.set_Opacity(double value)
    Parameters
    Type Name Description
    System.Double value

    IWindow.set_PlacementRectangle(Rect)

    Declaration
    void IWindow.set_PlacementRectangle(Rect value)
    Parameters
    Type Name Description
    System.Windows.Rect value

    Implements

    IWindow
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved