WPF

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

    Show / Hide Table of Contents

    Class DockedElementsContainer

    Represent a container that can position and arrange child docked elements.

    Inheritance
    System.Object
    DockedElementsContainer
    Implements
    IDesiredSize
    System.IDisposable
    Namespace: Syncfusion.Windows.Tools.Controls
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    public class DockedElementsContainer : Panel, IRemoveChild, IChildrenResize, IDesiredSize, IDisposable

    Constructors

    DockedElementsContainer(DockingManager)

    Initializes a new instance of the DockedElementsContainer class.

    Declaration
    public DockedElementsContainer(DockingManager dockingManager)
    Parameters
    Type Name Description
    DockingManager dockingManager

    The docking manager.

    Fields

    DockingManagerProperty

    Represents the DockingManager dependency property

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

    ElementAfterSplitterProperty

    Identifies ElementAfterSplitter dependency property of the DockedElementsContainer.

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

    ElementBeforeSplitterProperty

    Identifies ElementBeforeSplitter dependency property of the DockedElementsContainer.

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

    OrientationProperty

    Identifies Orientation dependency property of the DockedElementsContainer.

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

    SplitterTargetSideProperty

    Identifies SplitterTargetSide attached property of the DockedElementsContainer.

    Declaration
    public static readonly DependencyProperty SplitterTargetSideProperty
    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.

    Orientation

    Gets or sets Orientation for the DockedElementsContainer that is used in measure and arrange processes. This is a dependency property.

    Declaration
    public Orientation Orientation { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.Orientation

    VisualChildrenCount

    Gets the number of child System.Windows.Media.Visual objects in this instance of DockedElementsContainer.

    Declaration
    protected override int VisualChildrenCount { get; }
    Property Value
    Type Description
    System.Int32

    Methods

    ArrangeOverride(Size)

    Positions child elements and determines a size for a DockedElementsContainer and derived class.

    Declaration
    protected override Size ArrangeOverride(Size finalSize)
    Parameters
    Type Name Description
    System.Windows.Size finalSize

    The final area within the parent that this element should use to arrange itself and its children.

    Returns
    Type Description
    System.Windows.Size

    The actual size used.

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public void Dispose()

    Finalize()

    Releases unmanaged resources and performs other cleanup operations before the DockedElementsContainer is reclaimed by garbage collection.

    Declaration
    protected override void Finalize()

    GetElementAfterSplitter(DependencyObject)

    Gets the element located after splitter. This is a dependency property.

    Declaration
    public static FrameworkElement GetElementAfterSplitter(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element from which to read the property value.

    Returns
    Type Description
    System.Windows.FrameworkElement

    The value of the DockedElementsContainer.ElementAfterSplitter�dependency property.

    GetElementBeforeSplitter(DependencyObject)

    Gets the element located before splitter. This is a dependency property.

    Declaration
    public static FrameworkElement GetElementBeforeSplitter(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element from which to read the property value.

    Returns
    Type Description
    System.Windows.FrameworkElement

    The value of the DockedElementsContainer.ElementBeforeSplitter�dependency property.

    GetSplitterTargetSide(DependencyObject)

    Gets the value of the DockedElementsContainer.GetSplitterTargetSide�attached property from a given DependencyObject.

    Declaration
    public static SplitterTargetSide GetSplitterTargetSide(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The element from which to read the property value.

    Returns
    Type Description
    SplitterTargetSide

    The value of the DockedElementsContainer.GetSplitterTargetSide�attached property.

    GetVisualChild(Int32)

    Returns a child at the specified index from a collection of child elements.

    Declaration
    protected override Visual GetVisualChild(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index of the requested child element in the collection.

    Returns
    Type Description
    System.Windows.Media.Visual

    The requested child element.

    MeasureOverride(Size)

    Measures the size in layout required for child elements and determines a size for the DockedElementsContainer and derived class.

    Declaration
    protected override Size MeasureOverride(Size availableSize)
    Parameters
    Type Name Description
    System.Windows.Size availableSize

    The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

    Returns
    Type Description
    System.Windows.Size

    The size that this element determines it needs during layout, based on its calculations of child element sizes.

    OnMouseDown(MouseButtonEventArgs)

    Invoked when an unhandled System.Windows.Input.Mouse.MouseDown�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 OnMouseDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e

    The System.Windows.Input.MouseButtonEventArgs that contains the event data. This event data reports details about the mouse button that was pressed and the handled state.

    OnOrientationChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache.

    Declaration
    protected virtual void OnOrientationChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property changes details, such as old value and new value.

    SetElementAfterSplitter(DependencyObject, FrameworkElement)

    Sets the element located after splitter. This is a dependency property.

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

    The element on which to set the DockedElementsContainer.ElementAfterSplitter�dependency property.

    System.Windows.FrameworkElement value

    The property value to set.

    SetElementBeforeSplitter(DependencyObject, FrameworkElement)

    Sets the element located before splitter. This is a dependency property.

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

    The element on which to set the DockedElementsContainer.ElementBeforeSplitter�dependency property.

    System.Windows.FrameworkElement value

    The property value to set.

    SetSplitterTargetSide(DependencyObject, SplitterTargetSide)

    Sets the value of the DockedElementsContainer.GetSplitterTargetSide�attached property to a given DependencyObject.

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

    The element on which to set the DockedElementsContainer.GetSplitterTargetSide�attached property.

    SplitterTargetSide value

    The property value to set.

    Explicit Interface Implementations

    IDesiredSize.DesiredSize

    Gets or sets the size that this element computed during the measure pass of the layout process.

    Declaration
    Size IDesiredSize.DesiredSize { get; set; }
    Returns
    Type Description
    System.Windows.Size

    IDisposable.Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    void IDisposable.Dispose()

    Implements

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