WPF

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

    Show / Hide Table of Contents

    Class SidePanel

    Represents SidePanel of the DockingManager.

    Inheritance
    System.Object
    SidePanel
    Namespace: Syncfusion.Windows.Tools.Controls
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    public class SidePanel : TabControl
    Remarks

    SidePanel is useful to implement auto-hide behavior of docked windows. When you click auto-hide button in the docked window it hides to the side panel. Side panel can be placed on top, bottom, right or left side of docking container.

    Examples

    This example shows how to use the SidePanel in XAML.

    <Syncfusion:SidePanel Name="PART_TopPanel" panelSide="Top" Grid.Row="0" Grid.Column="1"
    TabStripPlacement="Top" ContentRenderTransformY="1">
    <Syncfusion:SidePanel.Triggers>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.ShowEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopShowAnimation"
    Storyboard.TargetProperty="ContentRenderTransformY"
    To="0" BeginTime="{StaticResource ShadowTimeSpan}"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.HideEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopHideAnimation"
    Storyboard.TargetProperty="ContentRenderTransformY" To="1"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    </Syncfusion:SidePanel.Triggers>
    </Syncfusion:SidePanel>

    Constructors

    SidePanel()

    Initializes a new instance of the SidePanel class.

    Declaration
    public SidePanel()

    Fields

    ContentOpacityProperty

    Identifies ContentOpacity dependency property of the SidePanel.

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

    ContentRenderTransformXProperty

    Identifies ContentRenderTransformX dependency property of the SidePanel.

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

    ContentRenderTransformYProperty

    Identifies ContentRenderTransformY dependency property of the SidePanel.

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

    ContentScaleXProperty

    Identifies ContentScaleX dependency property of the SidePanel.

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

    ContentScaleYProperty

    Identifies ContentScaleY dependency property of the SidePanel.

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

    DockingManagerProperty

    Identifies the Docking Manager dependency property

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

    EndPageCommand

    Initializes command to execute next page command

    Declaration
    public static RoutedUICommand EndPageCommand
    Field Value
    Type Description
    System.Windows.Input.RoutedUICommand

    Hide

    Initializes event to hide auto hidden window.

    Declaration
    public static readonly RoutedEvent Hide
    Field Value
    Type Description
    System.Windows.RoutedEvent

    HomePageCommand

    Initializes command to execute Home page command

    Declaration
    public static RoutedUICommand HomePageCommand
    Field Value
    Type Description
    System.Windows.Input.RoutedUICommand

    IsContentHidenProperty

    Identifies IsContentHiden dependency property of the SidePanel.

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

    IsShowedFocusedItemProperty

    Identifies IsShowedFocusedItem dependency property of the SidePanel.

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

    IsTabGroupOwnerProperty

    Identifies IsTabGroupOwner attached property of the SidePanel.

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

    This property can be attached to a docking manager child and specifies whether element is a group owner. If it is set to true it means that element will be located first in the side panel group and will have some separation from the previous group for visual differentiating between them. The default value is false.

    NextCommand

    Initializes command to execute next command

    Declaration
    public static RoutedUICommand NextCommand
    Field Value
    Type Description
    System.Windows.Input.RoutedUICommand

    PanelSideProperty

    Identifies panelSide dependency property of the SidePanel.

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

    PreviousCommand

    Initializes command to execute previous command

    Declaration
    public static RoutedUICommand PreviousCommand
    Field Value
    Type Description
    System.Windows.Input.RoutedUICommand

    Show

    Declaration
    public static readonly RoutedEvent Show
    Field Value
    Type Description
    System.Windows.RoutedEvent

    TabChildOrderProperty

    Identifies TabChildOrder attached property of the SidePanel.

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

    This property can be attached to a docking manager child and is used to determine the ordering of tabs in the SidePanel. The default number is 0.

    TabChildrenProperty

    Identifies TabChildren dependency property of the SidePanel.

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

    TabGroupNameProperty

    Identifies TabGroupName attached property of the SidePanel.

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

    This property can be attached to a docking manager child and is used to determine the group name for tabbed elements in the SidePanel. SidePanel arranges its children by groups and makes margins between them for visual differentiating. New group is created when user auto hide one element or several elements that are tabbed.

    Properties

    ContentOpacity

    Gets or sets ContentOpacity of the SidePanel. This is a dependency property.

    Declaration
    public double ContentOpacity { get; set; }
    Property Value
    Type Description
    System.Double
    Remarks

    The ContentOpacity property is usable only when you override the template of the MainHost class or template of the SidePanel class. To override the template of the MainHost you have to set MainHostStyleProperty property of the DockingManager and then, in this style set the overridden template reference. To override the template of the SidePanel you have to set SidePanelStyleProperty property of the DockingManager and then, in this style set the overridden template reference. Also you can set binding on ContentOpacity property to initialize System.Windows.UIElement.OpacityProperty of the OpacityDockPanel when overriding SidePanel template. The ContentOpacity property is used for Fade animation.

    Examples

    Using ContentOpacity property in XAML.

    <Syncfusion:SidePanel Name="PART_TopPanel" panelSide="Top" Grid.Row="0" Grid.Column="1" TabStripPlacement="Top" ContentOpacity="0">
    <Syncfusion:SidePanel.Triggers>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.ShowEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopShowAnimation" Storyboard.TargetProperty="ContentOpacity" To="1"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.HideEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopHideAnimation" Storyboard.TargetProperty="ContentOpacity" To="0"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    </Syncfusion:SidePanel.Triggers>
    </Syncfusion:SidePanel>

    ContentRenderTransformX

    Gets or sets ContentRenderTransformX of the SidePanel. This is a dependency property.

    Declaration
    public double ContentRenderTransformX { get; set; }
    Property Value
    Type Description
    System.Double
    Remarks

    The ContentRenderTransformX property is usable only when you override the template of the MainHost class. To override the template of the MainHost you have to set MainHostStyleProperty property of the DockingManager and then, in this style set the overridden template reference. ContentRenderTransformX is useful only for left and right side panels. Also ContentRenderTransformX is used for Slide animation.

    Examples

    This example shows how to use ContentRenderTransformX in XAML.

    <Syncfusion:SidePanel Name="PART_LeftPanel" panelSide="Left" Grid.Row="1" Grid.Column="0" TabStripPlacement="Left" ContentRenderTransformX="1">
    <Syncfusion:SidePanel.Triggers>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.ShowEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard >
    <DoubleAnimation x:Name="PART_LeftShowAnimation" Storyboard.TargetProperty="ContentRenderTransformX" To="0"  BeginTime="0:0:0.2"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.HideEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_LeftHideAnimation" Storyboard.TargetProperty="ContentRenderTransformX" To="1"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    </Syncfusion:SidePanel.Triggers>
    </Syncfusion:SidePanel>
    See Also
    System.Double

    ContentRenderTransformY

    Gets or sets ContentRenderTransformY of the SidePanel. This is a dependency property.

    Declaration
    public double ContentRenderTransformY { get; set; }
    Property Value
    Type Description
    System.Double
    Remarks

    The ContentRenderTransformY property is usable only when you override the template of the MainHost class. To override the template of the MainHost you have to set MainHostStyleProperty property of the DockingManager and then, in this style set the overridden template reference. ContentRenderTransformY is useful only for top and bottom side panels. Also ContentRenderTransformY is used for Slide animation.

    Examples

    This example shows how to use ContentRenderTransformY in XAML.

    <Syncfusion:SidePanel Name="PART_TopPanel" panelSide="Top" Grid.Row="0" Grid.Column="1" TabStripPlacement="Top" ContentRenderTransformY="1">
    <Syncfusion:SidePanel.Triggers>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.ShowEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopShowAnimation" Storyboard.TargetProperty="ContentRenderTransformY" To="0" BeginTime="0:0:0.2"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.HideEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopHideAnimation" Storyboard.TargetProperty="ContentRenderTransformY" To="1"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    </Syncfusion:SidePanel.Triggers>
    </Syncfusion:SidePanel>
    See Also
    System.Double

    ContentScaleX

    Gets or sets ContentScaleX of the SidePanel. This is a dependency property.

    Declaration
    public double ContentScaleX { get; set; }
    Property Value
    Type Description
    System.Double
    Remarks

    The ContentScaleX property is usable only when you override the template of the MainHost class or template of the SidePanel class. To override the template of the MainHost you have to set MainHostStyleProperty property of the DockingManager and then, in this style set the overridden template reference. To override the template of the SidePanel you have to set SidePanelStyleProperty property of the DockingManager and then, in this style set the overridden template reference. When overriding template of the SidePanel, you can use ContentScaleX property to initialize System.Windows.Media.ScaleTransform.ScaleXProperty property of the System.Windows.Media.ScaleTransform. How to initialize System.Windows.Media.ScaleTransform.ScaleXProperty property of the System.Windows.Media.ScaleTransform see the example below. ContentScaleX is useful only for left and right side panels. Also ContentScaleX is used for Scale animation.

    Examples

    How to initialize System.Windows.Media.ScaleTransform.ScaleXProperty property of the System.Windows.Media.ScaleTransform in XAML.

    <ScaleTransform ScaleX="{Binding Path=ContentScaleX, RelativeSource={RelativeSource TemplatedParent}}"
    ScaleY="{Binding Path=ContentScaleY, RelativeSource={RelativeSource TemplatedParent}}"/>

    Using ContentScaleX property in XAML.

    <Syncfusion:SidePanel Name="PART_LeftPanel" panelSide="Left" Grid.Row="1" Grid.Column="0" TabStripPlacement="Left" ContentScaleX="0">
    <Syncfusion:SidePanel.Triggers>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.ShowEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard >
    <DoubleAnimation x:Name="PART_LeftShowAnimation" Storyboard.TargetProperty="ContentScaleX" To="1"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.HideEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_LeftHideAnimation" Storyboard.TargetProperty="ContentScaleX" To="0"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    </Syncfusion:SidePanel.Triggers>
    </Syncfusion:SidePanel>

    ContentScaleY

    Gets or sets ContentScaleY of the SidePanel. This is a dependency property.

    Declaration
    public double ContentScaleY { get; set; }
    Property Value
    Type Description
    System.Double
    Remarks

    The ContentScaleY property is usable only when you override the template of the MainHost class or template of the SidePanel class. To override the template of the MainHost you have to set MainHostStyleProperty property of the DockingManager and then, in this style set the overridden template reference. To override the template of the SidePanel you have to set SidePanelStyleProperty property of the DockingManager and then, in this style set the overridden template reference. When overriding template of the SidePanel, you can use ContentScaleY property to initialize System.Windows.Media.ScaleTransform.ScaleYProperty property of the System.Windows.Media.ScaleTransform. How to initialize System.Windows.Media.ScaleTransform.ScaleYProperty property of the System.Windows.Media.ScaleTransform see the example of the ContentScaleX property. ContentScaleY is useful only for top and bottom side panels. Also ContentScaleY is used for Scale animation.

    Examples

    How to initialize ScaleXProperty property of the ScaleTransform in XAML please see the example of the ContentScaleX property.

    Using ContentScaleY property in XAML.

    <Syncfusion:SidePanel Name="PART_TopPanel" panelSide="Top" Grid.Row="0" Grid.Column="1" TabStripPlacement="Top" ContentScaleY="0">
    <Syncfusion:SidePanel.Triggers>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.ShowEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopShowAnimation" Storyboard.TargetProperty="ContentScaleY" To="1"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    <EventTrigger RoutedEvent="Syncfusion:SidePanel.HideEvent" >
    <EventTrigger.Actions>
    <BeginStoryboard>
    <Storyboard>
    <DoubleAnimation x:Name="PART_TopHideAnimation" Storyboard.TargetProperty="ContentScaleY" To="0"
    Duration="{Binding Path=(TabControl.SelectedItem).(Syncfusion:DockingManager.AnimationDelay)
    , RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type Syncfusion:SidePanel}}}" />
    </Storyboard>
    </BeginStoryboard>
    </EventTrigger.Actions>
    </EventTrigger>
    </Syncfusion:SidePanel.Triggers>
    </Syncfusion:SidePanel>

    DockingManager

    Gets or sets the docking manager.

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

    The docking manager.

    IsContentHiden

    Gets a value indicating whether or internally sets IsContentHiden of the SidePanel. This is a dependency property.

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

    This property returns true if all windows that are docked to SidePanel are auto hidden otherwise, false. Default value of this property is true. This property can be useful when you override the template of the SidePanel. You can use IsContentHiden property for DoubleAnimation in the SidePanel.

    IsShowedFocusedItem

    Gets a value indicating whether or internally sets IsShowedFocusedItem of the SidePanel. This is a dependency property.

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

    This property returns true if focused window of the SidePanel is visible; otherwise, false. Default value of this property is false. This property can be useful when you override the template of the SidePanel. You can use IsShowedFocusedItem property for the DockHeaderPresenter implementation in the SidePanel.

    PanelSide

    Gets or sets panelSide of the SidePanel. This is a dependency property.

    Declaration
    public Dock PanelSide { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.Dock
    Remarks

    The panelSide property is usable when you want to set the side of the SidePanel. One of the next values can be set to the panelSide property: Dock.Top, Dock.Bottom, Dock.Left or Dock.Right.

    Examples

    To use PanelSide property in XAML please see examples of the next properties: ContentOpacity,ContentScaleY,ContentScaleX,ContentRenderTransformY,ContentRenderTransformX

    TabChildren

    Gets or sets TabChildren of the SidePanel. This is a dependency property.

    Declaration
    public ObservableFrameworkElements TabChildren { get; set; }
    Property Value
    Type Description
    ObservableFrameworkElements
    Remarks

    The TabChildren property contains all tabbed children of the SidePanel. You can use TabChildren property to get tabbed children for some ItemSourceProperty. For example, you can set ItemSourceProperty in the Context Menu when overriding SidePanel template.

    Examples

    Using TabChildren property in XAML.

    <ContextMenu ItemsSource="{TemplateBinding TabChildren}"/>

    Methods

    AutoHideTab(FrameworkElement)

    Invoke when Auto hide the tab.

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

    The element which need to AutoHide.

    GetIsTabGroupOwner(DependencyObject)

    Gets the value of the SidePanel.IsTabGroupOwner�attached property from a given DependencyObject.

    Declaration
    public static bool GetIsTabGroupOwner(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element from which to read the property value.

    Returns
    Type Description
    System.Boolean

    The value of the SidePanel.IsTabGroupOwner�attached property.

    GetTabChildOrder(DependencyObject)

    Gets the value of the SidePanel.TabChildOrder�attached property from a given DependencyObject.

    Declaration
    public static int GetTabChildOrder(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element from which to read the property value.

    Returns
    Type Description
    System.Int32

    The value of the SidePanel.TabChildOrder�attached property.

    GetTabGroupName(DependencyObject)

    Gets the value of the SidePanel.TabGroupName�attached property from a given DependencyObject.

    Declaration
    public static string GetTabGroupName(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element from which to read the property value.

    Returns
    Type Description
    System.String

    The value of the SidePanel.TabGroupName�attached property.

    OnApplyTemplate()

    Builds the current template's visual tree.

    Declaration
    public override void OnApplyTemplate()

    OnContextMenuClosing(ContextMenuEventArgs)

    Invoked when an unhandled ContextMenuClosing�routed event reaches an element.

    Declaration
    protected override void OnContextMenuClosing(ContextMenuEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Controls.ContextMenuEventArgs e

    The ContextMenuEventArgs that contains the event data.

    OnCreateAutomationPeer()

    Represents the OncreateAutomationpeer method

    Declaration
    protected override AutomationPeer OnCreateAutomationPeer()
    Returns
    Type Description
    System.Windows.Automation.Peers.AutomationPeer

    OnDragEnter(DragEventArgs)

    Declaration
    protected override void OnDragEnter(DragEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DragEventArgs e

    OnDragLeave(DragEventArgs)

    Declaration
    protected override void OnDragLeave(DragEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DragEventArgs e

    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.

    OnLostFocus(RoutedEventArgs)

    Hides docked window when it lost focus.

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

    EventArgs to find focused window element

    OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)

    Hides docked window when user first clicks child of the window and then clicks content.

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

    The System.Windows.Input.KeyboardFocusChangedEventArgs that contains event data.

    OnMouseEnter(MouseEventArgs)

    Occurs when mouse enters the tab. Shows hidden window.

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

    EventArgs to find window element

    OnMouseLeave(MouseEventArgs)

    Occurs when mouse leaves side panel.

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

    EventArgs to find side panel that must be leaved.

    OnMouseLeftButtonUp(MouseButtonEventArgs)

    Gives focus to showed window when user clicks the tab of this window.

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

    EventArgs to find window element that must be focused

    OnMouseMove(MouseEventArgs)

    Invoked when an unhandled Mouse.MouseMove attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

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

    The MouseEventArgs that contains the event data.

    OnMouseRightButtonDown(MouseButtonEventArgs)

    Invoked when an unhandled MouseRightButtonDown�routed event reaches an element.

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

    The MouseButtonEventArgs that contains the event data. The event data reports that the mouse button was released.

    OnPreviewMouseDown(MouseButtonEventArgs)

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

    OnPreviewMouseLeftButtonDown(MouseButtonEventArgs)

    Invoked when an unhandled PreviewMouseLeftButtonDown�routed event reaches an element.

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

    The MouseButtonEventArgs that contains the event data. The event data reports that the mouse button was released.

    OnSelectionChanged(SelectionChangedEventArgs)

    Invoked when an unhandled SelectionChanged�attached event reaches an element of the side panel.

    Declaration
    protected override void OnSelectionChanged(SelectionChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Controls.SelectionChangedEventArgs e

    The SelectionChangedEventArgs that contains the event data.

    SelectTab(FrameworkElement)

    Method invokes when selects the tab.

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

    Element to select the tab.

    SetIsTabGroupOwner(DependencyObject, Boolean)

    Sets the value of the SidePanel.IsTabGroupOwner�attached property of a given DependencyObject.

    Declaration
    public static void SetIsTabGroupOwner(DependencyObject obj, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element that contains this property.

    System.Boolean value

    New value to set.

    SetTabChildOrder(DependencyObject, Int32)

    Sets the value of the SidePanel.TabChildOrder�attached property of a given DependencyObject.

    Declaration
    public static void SetTabChildOrder(DependencyObject obj, int value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element that contains this property.

    System.Int32 value

    New value to set.

    SetTabGroupName(DependencyObject, String)

    Sets the value of the SidePanel.TabGroupName�attached property of a given DependencyObject.

    Declaration
    public static void SetTabGroupName(DependencyObject obj, string value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element that contains this property.

    System.String value

    New value to set.

    Events

    HideEvent

    ShowEvent event. Initializes event to show auto hidden window.

    Declaration
    public event RoutedEventHandler HideEvent
    Event Type
    Type Description
    System.Windows.RoutedEventHandler

    ShowEvent

    ShowEvent event. Initializes event to show auto hidden window.

    Declaration
    public event RoutedEventHandler ShowEvent
    Event Type
    Type Description
    System.Windows.RoutedEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved