Class TabLayoutPanel

Panel that is responsible for tab layout logic.

Inheritance

System.Object

TabLayoutPanel

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public class TabLayoutPanel : Panel

Constructors

TabLayoutPanel()

Initializes a new instance of the TabLayoutPanel class.

Declaration

public TabLayoutPanel()

Fields

ScrollOffsetProperty

Represents the ScrollOffset Dependency Property

Declaration

protected static readonly DependencyProperty ScrollOffsetProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

LogicalChildren

Gets an enumerator that can iterate the logical child elements of this System.Windows.Controls.Panel element.

Declaration

protected override IEnumerator LogicalChildren { get; }

Property Value

Type
System.Collections.IEnumerator

ScrollOffset

Gets or sets the scroll offset.

Declaration

protected double ScrollOffset { get; set; }

Property Value

Type	Description
System.Double	The scroll offset.

Methods

ArrangeOverride(Size)

Called to arrange and size tabs of a TabControlExt object.

Declaration

protected override Size ArrangeOverride(Size finalSize)

Parameters

Type	Name	Description
System.Windows.Size	finalSize	The computed size that is used to arrange tabs.

Returns

Type	Description
System.Windows.Size	The size of the control.

CheckToUpdatePosition(Size, TabItemExt)

Determines whether the position of the specified TabItemExt should be updated based on the available size and layout configuration.

Declaration

public bool CheckToUpdatePosition(Size arrangesize, TabItemExt tabitem)

Parameters

Type	Name	Description
System.Windows.Size	arrangesize	The available size for arranging tab items.
TabItemExt	tabitem	The TabItemExt to check for position update.

Returns

Type
System.Boolean

GetLayoutClip(Size)

Returns an alternative clipping geometry that represents the region that would be clipped if ClipToBounds were set to true.

Declaration

protected override Geometry GetLayoutClip(Size layoutSlotSize)

Parameters

Type	Name	Description
System.Windows.Size	layoutSlotSize	The available size provided by the element.

Returns

Type	Description
System.Windows.Media.Geometry	The potential clipping geometry.

MeasureOverride(Size)

Called to remeasure a control.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Type	Name	Description
System.Windows.Size	availableSize	Measurement constraints, a control cannot return a size larger than the constraint.

Returns

Type	Description
System.Windows.Size	The size of the control.

OnDragEnter(DragEventArgs)

Invoked when an unhandled System.Windows.DragDrop.DragEnter�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 OnDragEnter(DragEventArgs e)

Parameters

Type	Name	Description
System.Windows.DragEventArgs	e	The System.Windows.DragEventArgs that contains the event data.

OnDragLeave(DragEventArgs)

Invoked when an unhandled System.Windows.DragDrop.DragLeave�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 OnDragLeave(DragEventArgs e)

Parameters

Type	Name	Description
System.Windows.DragEventArgs	e	The System.Windows.DragEventArgs that contains the event data.

OnDragOver(DragEventArgs)

Invoked when an unhandled System.Windows.DragDrop.DragOver�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 OnDragOver(DragEventArgs e)

Parameters

Type	Name	Description
System.Windows.DragEventArgs	e	The System.Windows.DragEventArgs that contains the event data.

OnDrop(DragEventArgs)

Invoked when an unhandled System.Windows.DragDrop.DragEnter�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 OnDrop(DragEventArgs e)

Parameters

Type	Name	Description
System.Windows.DragEventArgs	e	The System.Windows.DragEventArgs that contains the event data.

OnGiveFeedback(GiveFeedbackEventArgs)

Invoked when an unhandled System.Windows.DragDrop.GiveFeedback�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 OnGiveFeedback(GiveFeedbackEventArgs e)

Parameters

Type	Name	Description
System.Windows.GiveFeedbackEventArgs	e	The System.Windows.GiveFeedbackEventArgs that contains the event data.

OnInitialized(EventArgs)

Raises the Initialized event. This method is invoked whenever 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.

OnMouseEnter(MouseEventArgs)

Handles the System.Windows.UIElement.MouseEnter event.

Declaration

protected override void OnMouseEnter(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e

OnMouseMove(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.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 System.Windows.Input.MouseEventArgs that contains the event data.

OnMouseWheel(MouseWheelEventArgs)

Handles mouse wheel even for ColorPickerPalette

Declaration

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseWheelEventArgs	e

OnPreviewMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.PreviewMouseLeftButtonDown�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 OnPreviewMouseLeftButtonDown(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 the left mouse button was pressed.

OnPreviewMouseLeftButtonUp(MouseButtonEventArgs)

Handles the System.Windows.UIElement.PreviewMouseLeftButtonUp event to manage tab item interactions, including drag cancellation and double-click floating behavior.

Declaration

protected override void OnPreviewMouseLeftButtonUp(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The System.Windows.Input.MouseButtonEventArgs instance containing the event data.

Remarks

This method performs the following actions:

• Resets drag information and enables drop on the parent tab control.
• Identifies the clicked TabItemExt and its container.
• If a double-click is detected, and floating is allowed, it triggers the float behavior for the tab item.
• If not a double-click, it records the click position for future reference.

The condition e.StylusDevice == null || e.StylusDevice != null is always true and may be redundant.

OnPreviewMouseRightButtonDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.PreviewMouseRightButtonDown�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 OnPreviewMouseRightButtonDown(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 the right mouse button was pressed.

OnPreviewMouseRightButtonUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.PreviewMouseRightButtonUp�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 OnPreviewMouseRightButtonUp(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 the right mouse button was released.

OnPreviewQueryContinueDrag(QueryContinueDragEventArgs)

Handles the System.Windows.UIElement.PreviewQueryContinueDrag event to manage drag cancellation behavior.

Declaration

protected override void OnPreviewQueryContinueDrag(QueryContinueDragEventArgs e)

Parameters

Type	Name	Description
System.Windows.QueryContinueDragEventArgs	e	The System.Windows.QueryContinueDragEventArgs instance containing the event data.

OnRenderSizeChanged(SizeChangedInfo)

Raises the System.Windows.FrameworkElement.SizeChanged event, using the specified information as part of the eventual event data.

Declaration

protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)

Parameters

Type	Name	Description
System.Windows.SizeChangedInfo	sizeInfo	Details of the old and new size involved in the change.

OnStylusSystemGesture(StylusSystemGestureEventArgs)

Handles the System.Windows.UIElement.StylusSystemGesture event to capture and store the current stylus system gesture.

Declaration

protected override void OnStylusSystemGesture(StylusSystemGestureEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.StylusSystemGestureEventArgs	e

OnVisualChildrenChanged(DependencyObject, DependencyObject)

Invoked when the System.Windows.Media.VisualCollection of a visual object is modified.

Declaration

protected override void OnVisualChildrenChanged(DependencyObject visualAdded, DependencyObject visualRemoved)

Parameters

Type	Name	Description
System.Windows.DependencyObject	visualAdded	The System.Windows.Media.Visual that was added to the collection.
System.Windows.DependencyObject	visualRemoved	The System.Windows.Media.Visual that was removed from the collection.

ScrollToPrevPage()

Launch scroll int to the previous page.

Declaration

public void ScrollToPrevPage()