Class TDILayoutPanel

Presents panel for TDI support in DocumentContainer

Inheritance

System.Object

PanelBase

TDILayoutPanel

Implements

ILayoutPanel

System.IDisposable

Inherited Members

PanelBase.GetElement(Boolean)

PanelBase.GetOppositeElement(UIElement)

PanelBase.HasElement(UIElement, Boolean)

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public class TDILayoutPanel : PanelBase, ILayoutPanel, IDisposable

Constructors

TDILayoutPanel()

Initializes a new instance of the TDILayoutPanel class.

Declaration

public TDILayoutPanel()

Fields

ContainerProperty

Presents Container property.

Declaration

protected static readonly DependencyProperty ContainerProperty

Field Value

Type
System.Windows.DependencyProperty

ContainerPropertyKey

Represents the key for Container Property

Declaration

protected static readonly DependencyPropertyKey ContainerPropertyKey

Field Value

Type
System.Windows.DependencyPropertyKey

ContentProperty

Presents content of panel.

Declaration

public static readonly DependencyProperty ContentProperty

Field Value

Type
System.Windows.DependencyProperty

m_nameSufix

Presents Name suffix

Declaration

public static int m_nameSufix

Field Value

Type
System.Int32

SplitPanelOffsetProperty

Identifies the SplitPanelOffsetProperty dependency property.

Declaration

public static readonly DependencyProperty SplitPanelOffsetProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

Container

Gets or sets the value of the Container dependency property.

Declaration

public DocumentContainer Container { get; protected set; }

Property Value

Type
DocumentContainer

Content

Gets or sets the value of the Content dependency property.

Declaration

public UIElement Content { get; set; }

Property Value

Type
System.Windows.UIElement

LogicalChildren

Gets an enumerator for logical child elements of this element.

Declaration

protected override IEnumerator LogicalChildren { get; }

Property Value

Type
System.Collections.IEnumerator

VisualChildrenCount

Gets the number of visual child elements within this element.

Declaration

protected override int VisualChildrenCount { get; }

Property Value

Type
System.Int32

Methods

AddElement(UIElement)

Adds the element.

Declaration

public override void AddElement(UIElement element)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element.

Overrides

PanelBase.AddElement(UIElement)

ArrangeOverride(Size)

When overridden in a derived class, positions child elements and determines a size for a System.Windows.FrameworkElement 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.

BackforwardSwitchImmediate()

Back forward the switch immediate.

Declaration

public void BackforwardSwitchImmediate()

CanSwitch()

Determines whether this instance can switch.

Declaration

public bool CanSwitch()

Returns

Type	Description
System.Boolean	true if this instance can switch; otherwise, false.

CreateChildDocumentParams(FrameworkElement, Boolean)

Creates the child document params.

Declaration

public ChildDocumentParams CreateChildDocumentParams(FrameworkElement element, bool isActive)

Parameters

Type	Name	Description
System.Windows.FrameworkElement	element	The element.
System.Boolean	isActive	if set to true [is active].

Returns

Type	Description
ChildDocumentParams	ChildDocument Params isActive

Dispose()

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

Declaration

public void Dispose()

ForwardSwitchImmediate(Boolean, Boolean)

Forwards the switch immediate.

Declaration

public void ForwardSwitchImmediate(bool firstTabulation, bool isKeepCircle)

Parameters

Type	Name	Description
System.Boolean	firstTabulation	if set to true [first tabulation].
System.Boolean	isKeepCircle	if set to true [is keep circle].

GetContent(Control)

Gets the Content.

Declaration

public UIElement GetContent(Control wrapper)

Parameters

Type	Name	Description
System.Windows.Controls.Control	wrapper	The wrapper.

Returns

Type	Description
System.Windows.UIElement	UIElement TabItemExt

GetIsSelected(DependencyObject)

Gets the is selected.

Declaration

public static bool GetIsSelected(DependencyObject obj)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The obj.

Returns

Type
System.Boolean

GetOrderedItems()

Gets the ordered items.

Declaration

public IList<Control> GetOrderedItems()

Returns

Type	Description
System.Collections.Generic.IList<System.Windows.Controls.Control>	IList Control

GetSplitPanelOffset(DependencyObject)

Gets the value of the SplitPanelOffset attached property from the specified System.Windows.DependencyObject.

Declaration

public static double GetSplitPanelOffset(DependencyObject obj)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The object from which to retrieve the property value.

Returns

Type	Description
System.Double	The offset value of the split panel.

GetTDIGroupOrientation(DependencyObject)

Gets the TDI group orientation.

Declaration

public static Orientation GetTDIGroupOrientation(DependencyObject obj)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The obj.

Returns

Type
System.Windows.Controls.Orientation

GetTDIIndex(DependencyObject)

Gets the TDI group orientation.

Declaration

public static int GetTDIIndex(DependencyObject obj)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The obj.

Returns

Type
System.Int32

GetVisualChild(Int32)

Overrides System.Windows.Media.Visual.GetVisualChild(System.Int32), and 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. This should not return null; if the provided index is out of range, an exception is thrown.

GetWayOfTDIGroup(DependencyObject)

Gets the way of TDI group.

Declaration

public static string GetWayOfTDIGroup(DependencyObject obj)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The obj.

Returns

Type
System.String

MeasureOverride(Size)

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the System.Windows.FrameworkElement-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.

OnApplyTemplate()

Invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration

public override void OnApplyTemplate()

OnContainerChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises ContainerChanged event.

Declaration

protected virtual void OnContainerChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnContentChanged(DependencyPropertyChangedEventArgs)

Raises ContentChanged event.

Declaration

protected virtual void OnContentChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnMouseLeave(MouseEventArgs)

Handles the MouseLeave event. Notifies the DockingManager when the mouse leaves the layout panel.

Declaration

protected override void OnMouseLeave(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	The event data for the mouse leave event.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Handles the MouseLeftButtonDown event. Captures the mouse start position for drag operations within the DockingManager.

Declaration

protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The event data for the mouse button down event.

OnMouseLeftButtonUp(MouseButtonEventArgs)

Handles the MouseLeftButtonUp event. Updates the active tab control when a tab item is clicked, particularly when the container is not part of a DockingManager.

Declaration

protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The event data for the mouse left button up event.

OnMouseMove(MouseEventArgs)

Handles the MouseMove event. Delegates mouse movement handling to the DockingManager.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	The event data for the mouse move event.

OnPreviewMouseDown(MouseButtonEventArgs)

Invoked when an unhandled PreviewMouseDown attached routed 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 OnPreviewMouseDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that one or more mouse buttons were pressed.

OnPreviewTouchDown(TouchEventArgs)

Handles the PreviewTouchDown event. Prepares the control for touch interaction if enabled.

Declaration

protected override void OnPreviewTouchDown(TouchEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TouchEventArgs	e	The event data for the preview touch down event.

OnPreviewTouchUp(TouchEventArgs)

Handles the PreviewTouchUp event. Updates the active document based on the touched tab or content.

Declaration

protected override void OnPreviewTouchUp(TouchEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TouchEventArgs	e	The event data for the preview touch up event.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Handles changes to dependency properties. Specifically updates the System.Windows.FlowDirection of the active tab control when the FlowDirection property of the current element changes.

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e

OnTouchLeave(TouchEventArgs)

Handles the TouchLeave event. Notifies the DockingManager when a touch leaves the layout panel.

Declaration

protected override void OnTouchLeave(TouchEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TouchEventArgs	e	The event data for the touch leave event.

OnTouchMove(TouchEventArgs)

Handles the TouchMove event. Processes touch movement within the layout panel and delegates to the DockingManager.

Declaration

protected override void OnTouchMove(TouchEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TouchEventArgs	e	The event data for the touch move event.

OnTouchUp(TouchEventArgs)

Handles the TouchUp event. Processes tap gestures and updates the active document in the container.

Declaration

protected override void OnTouchUp(TouchEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TouchEventArgs	e	The event data for the touch up event.

RemoveElement(UIElement)

Removes the element.

Declaration

public override void RemoveElement(UIElement element)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element.

Overrides

PanelBase.RemoveElement(UIElement)

ResetVisibleList()

Resets the visible list.

Declaration

public void ResetVisibleList()

SetActiveDocument(UIElement)

Sets the active document.

Declaration

public void SetActiveDocument(UIElement element)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element.

SetActiveItem(FrameworkElement)

Sets the specified activeItem as the active item within the appropriate DocumentTabControl. This method searches through the tab list to find the tab control containing the item, updates its index and order if necessary, and assigns it as the active tab control.

Declaration

public void SetActiveItem(FrameworkElement activeItem)

Parameters

Type	Name	Description
System.Windows.FrameworkElement	activeItem	The item to be set as active, typically a FrameworkElement within a tab control.

SetActiveWindow(Control)

Sets the active window.

Declaration

public void SetActiveWindow(Control wrapper)

Parameters

Type	Name	Description
System.Windows.Controls.Control	wrapper	The wrapper.

SetFocus()

Sets the focus.

Declaration

public void SetFocus()

SetSplitPanelOffset(DependencyObject, Double)

Sets the value of the SplitPanelOffset attached property on the specified System.Windows.DependencyObject.

Declaration

public static void SetSplitPanelOffset(DependencyObject obj, double value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The object on which to set the property value.
System.Double	value	The offset value to set for the split panel.

SetTDIGroupOrientation(DependencyObject, Orientation)

Sets the TDI group orientation.

Declaration

public static void SetTDIGroupOrientation(DependencyObject obj, Orientation value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The obj.
System.Windows.Controls.Orientation	value	The value.

SetTDIIndex(DependencyObject, Int32)

Sets the TDI group orientation.

Declaration

public static void SetTDIIndex(DependencyObject obj, int value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The obj.
System.Int32	value	The value.

SetWayOfTDIGroup(DependencyObject, String)

Sets the way of TDI group.

Declaration

public static void SetWayOfTDIGroup(DependencyObject obj, string value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	The obj.
System.String	value	The value.

UpdateAfterPersistLoad()

Sets the focus after persist load.

Declaration

public void UpdateAfterPersistLoad()

Events

ContentChanged

Event that is raised when Content property is changed.

Declaration

public event PropertyChangedCallback ContentChanged

Event Type

Type
System.Windows.PropertyChangedCallback

Implements

ILayoutPanel

System.IDisposable