Class TabBarSplitterControl

Provides functionality for displaying several TabBarPage controls in an Excel-like workbook control. Each TabBarPage might optionally support splitting its view with a dynamic splitter frame.

Inheritance
System.Object
SplitterControl
TabBarSplitterControl
WorkbookView
Inherited Members
Namespace: Syncfusion.Windows.Forms
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class TabBarSplitterControl : SplitterControl, IControlToolTipProvider, IInternalSplitterParent, IScrollBarFrame, IDynamicSplitterFrame, IThemedControl, IContainerControl, INonClientPaintingSupport, IThemeProvider, IVisualStyle

Constructors

TabBarSplitterControl()

Initializes a new TabBarSplitterControl.

Declaration
public TabBarSplitterControl()

Properties

ActivePage

Gets or sets the currently visible TabBarPage.

Declaration
public TabBarPage ActivePage { get; set; }
Property Value
Type Description
TabBarPage

ActivePageBorderColor

Specifies the color with which the ActivePageBorder bottom border should be drawn.

Declaration
public Color ActivePageBorderColor { get; set; }
Property Value
Type Description
System.Drawing.Color

ActivePageIndex

Gets or sets the index of the active page.

Declaration
public int ActivePageIndex { get; set; }
Property Value
Type Description
System.Int32

AddButtonHoverColor

Gets/Sets the Hover color for AddButton.

Declaration
public Color AddButtonHoverColor { get; set; }
Property Value
Type Description
System.Drawing.Color

AddNewButtonImage

Gets/Sets background image for AddNewTabBarPageButton

Declaration
public Image AddNewButtonImage { get; set; }
Property Value
Type Description
System.Drawing.Image

Bar

Returns the tab bar.

Declaration
public TabBar Bar { get; }
Property Value
Type Description
TabBar

CreateParams

Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type Description
System.Windows.Forms.CreateParams
Overrides

DisabledColor

Gets or sets the color of the arrows in the disabled buttons.

Declaration
public Color DisabledColor { get; set; }
Property Value
Type Description
System.Drawing.Color

EditOnTab

Enable the edit mode in Selected TabBar

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

EnabledColor

Gets or sets the color of the arrows in the enabled buttons.

Declaration
public Color EnabledColor { get; set; }
Property Value
Type Description
System.Drawing.Color

EnableOffice2013Style

Gets or sets value to enable or disable the EnableOffice2013Style in MetroStyle

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

EnableTouchMode

Gets or sets value to enable or disable the Touchmode to the controls.

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

Scale factor will be updated automatically if scalefactor is equal to 1

IsVisualStyleEnabled

Gets a value indicating whether the visual style based theme is applied to the control and also indicates whether the theme files are referred from external assemblies or not.

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

Return true, if the visual style based theme is applied to the control. Otherwise returns false.

LabelEdit

Enable the edit mode when Double Click on TabBarPage

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

Office2007ColorScheme

Gets or sets office 2007 color scheme.

Declaration
public Office2007Theme Office2007ColorScheme { get; set; }
Property Value
Type Description
Office2007Theme

Office2007ScrollBars

Gets or sets office 2007 style scroll bars. (overridden property)

Declaration
public override bool Office2007ScrollBars { get; set; }
Property Value
Type Description
System.Boolean
Overrides

Office2007ScrollBarsColorScheme

Gets or sets office 2007 scroll bars colorScheme. (overridden property)

Declaration
public override Office2007ColorScheme Office2007ScrollBarsColorScheme { get; set; }
Property Value
Type Description
Office2007ColorScheme
Overrides

RelativeWidth

Gets or sets the width of the tab bar relative to the width of the client bounds.

Declaration
public int RelativeWidth { get; set; }
Property Value
Type Description
System.Int32

RepeatClickDelay

Gets or sets the number of milliseconds to wait before repeatedly firing scroll event.

Declaration
public int RepeatClickDelay { get; set; }
Property Value
Type Description
System.Int32

Resizable

Enables or disables the resizing of tab bar.

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

ScrollBehavior

Gets or sets the scroll behavior of this tab bar: pixel or tabs.

Declaration
public InternalTabBarScrollBehavior ScrollBehavior { get; set; }
Property Value
Type Description
Syncfusion.Windows.Forms.InternalTabBarScrollBehavior

ScrollButtons

Gets or sets the arrow buttons to be shown in an arrow bar.

Declaration
public DisplayArrowButtons ScrollButtons { get; set; }
Property Value
Type Description
DisplayArrowButtons

ShowAddNewTabBarPageOption

Gets/Sets whether to display AddNewPageTabBarPage Option or not

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

ShowIcons

Indicates whether Icons should be displayed in the tabs.

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

ShowMetroSeperator

Gets or sets whether to show/hide the Seperator in MetroStyle

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

SizeFactor

Gets or sets the size factor with that TabBar size to be increased

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

Style

Gets or sets the visual style of the tabBarSplitterControl.

Declaration
public TabBarSplitterStyle Style { get; set; }
Property Value
Type Description
TabBarSplitterStyle

TabBarPages

Returns the list of TabBarPages displayed in the TabBar. Each TabBarPage will have a tab associated with it.

Declaration
public TabBarPageCollection TabBarPages { get; }
Property Value
Type Description
TabBarPageCollection

TabFolderDelta

Gets or sets the delta used for drawing the tabs.

Declaration
public int TabFolderDelta { get; set; }
Property Value
Type Description
System.Int32

ThemeName

Gets or sets the theme name of the control.

Declaration
public string ThemeName { get; set; }
Property Value
Type Description
System.String

The default value is null.
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

ThemeStyle

Gets or sets the SplitterControlVisualStyle value used to customize the appearance of the .

Declaration
public TabBarSplitterVisualStyle ThemeStyle { get; set; }
Property Value
Type Description
TabBarSplitterVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

Methods

ActivateNextPage(Boolean)

Activates the next or previous page.

Declaration
public void ActivateNextPage(bool prev)
Parameters
Type Name Description
System.Boolean prev

True if previous pane should be activated; False if next pane should be activated.

ApplyScaleToControl(Single)

Scale the control based on the scale factor passed in the argument.

Declaration
public void ApplyScaleToControl(float scaleFactor)
Parameters
Type Name Description
System.Single scaleFactor

value to scale the factor based upon.

CreateControlsInstance()

Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
Type Description
System.Windows.Forms.Control.ControlCollection

CreateScrollBarContainer(ScrollBars, Int32)

Declaration
protected override Control CreateScrollBarContainer(ScrollBars sbType, int index)
Parameters
Type Name Description
System.Windows.Forms.ScrollBars sbType
System.Int32 index
Returns
Type Description
System.Windows.Forms.Control
Overrides

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

HidePage(TabBarPage)

Hides the TabBarPage.

Declaration
public void HidePage(TabBarPage page)
Parameters
Type Name Description
TabBarPage page

InitLayout()

Declaration
protected override void InitLayout()

MoveTabBarPage(TabBarPage, TabBarPage)

Move the Tabbarpage with respect to given pages.

Declaration
public void MoveTabBarPage(TabBarPage tabpage, TabBarPage destTabPage)
Parameters
Type Name Description
TabBarPage tabpage
TabBarPage destTabPage

MoveTabBarPage(Int32, Int32)

Move Tabbarpage with respect to given index.

Declaration
public void MoveTabBarPage(int tab, int destTab)
Parameters
Type Name Description
System.Int32 tab
System.Int32 destTab

OnActivePageChanged(ControlEventArgs)

Raises the ActivePageChanged event.

Declaration
protected virtual void OnActivePageChanged(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

Event data.

OnActivePageChanging(ControlEventArgs)

Raises the OnActivePageChanging(ControlEventArgs) event.

Declaration
protected virtual void OnActivePageChanging(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

Event data.

OnButtonLookChanged(EventArgs)

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

OnCancelMode(EventArgs)

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

OnControlRemoved(ControlEventArgs)

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e
Overrides

OnCreateTabBarPageCollection()

Creates the TabBarPageCollection.

Declaration
public virtual TabBarPageCollection OnCreateTabBarPageCollection()
Returns
Type Description
TabBarPageCollection

The new TabBarPageCollection.

OnFontChanged(EventArgs)

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

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyEventArgs e

OnLayout(LayoutEventArgs)

Declaration
protected override void OnLayout(LayoutEventArgs levent)
Parameters
Type Name Description
System.Windows.Forms.LayoutEventArgs levent
Overrides

OnPaint(PaintEventArgs)

Declaration
protected override void OnPaint(PaintEventArgs pe)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs pe
Overrides

OnShowToolTipsChanged(EventArgs)

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

OnSizeChanged(EventArgs)

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

OnStyleChanged()

Declaration
protected virtual void OnStyleChanged()

OnTabBarVisibleChanged(TabBarVisibleChangedEventArgs)

Declaration
public virtual void OnTabBarVisibleChanged(TabBarVisibleChangedEventArgs arg)
Parameters
Type Name Description
TabBarVisibleChangedEventArgs arg

OnValidatingLostFocus()

Declaration
protected override void OnValidatingLostFocus()
Overrides

OnVisibleChanged(EventArgs)

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

ProcessDialogKey(Keys)

Declaration
protected override bool ProcessDialogKey(Keys key)
Parameters
Type Name Description
System.Windows.Forms.Keys key
Returns
Type Description
System.Boolean
Overrides

ProcessKeyEventArgs(ref Message)

Declaration
protected override bool ProcessKeyEventArgs(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m
Returns
Type Description
System.Boolean

ProcessKeyMessage(ref Message)

Declaration
protected override bool ProcessKeyMessage(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m
Returns
Type Description
System.Boolean

ProcessKeyPreview(ref Message)

Declaration
protected override bool ProcessKeyPreview(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m
Returns
Type Description
System.Boolean

Refresh()

Overridden method of refresh.

Declaration
public override void Refresh()
Overrides

ResetAddButtonHoverColor()

Resets the AddButtonHoverColor

Declaration
public void ResetAddButtonHoverColor()

ResetAddNewButtonImage()

Declaration
public void ResetAddNewButtonImage()

ResetDisabledColor()

Resets DisabledColor to default.

Declaration
public void ResetDisabledColor()

ResetEditOnTab()

To reset EditOnTab

Declaration
public void ResetEditOnTab()

ResetEnabledColor()

Resets EnabledColor to default.

Declaration
public void ResetEnabledColor()

ResetLabelEdit()

To reset LabelEdit

Declaration
public void ResetLabelEdit()

ResetShowAddNewTabBarPageOption()

Declaration
public void ResetShowAddNewTabBarPageOption()

ResetSizeFactor()

Declaration
public void ResetSizeFactor()

ShouldSerializeEditOnTab()

To Specify EditOnTab to be serialized or not

Declaration
public bool ShouldSerializeEditOnTab()
Returns
Type Description
System.Boolean

ShouldSerializeLabelEdit()

To Specify LabelEdit to be serialized or not

Declaration
public bool ShouldSerializeLabelEdit()
Returns
Type Description
System.Boolean

ShowPage(TabBarPage)

Declaration
public void ShowPage(TabBarPage page)
Parameters
Type Name Description
TabBarPage page

TabsMoved(Object, TabMovedEventArgs)

Called when the user finishes dragging a tab.

Declaration
protected virtual void TabsMoved(object sender, TabMovedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
TabMovedEventArgs e

Event data.

TabsMoving(Object, TabMovedEventArgs)

Called when the user is dragging a tab.

Declaration
protected virtual void TabsMoving(object sender, TabMovedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
TabMovedEventArgs e

Event data.

ToString()

Overridden method of Tostring()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m
Overrides

Events

ActivePageChanged

Occurs after the active page has changed.

Declaration
public event ControlEventHandler ActivePageChanged
Event Type
Type Description
System.Windows.Forms.ControlEventHandler

ActivePageChanging

Occurs before the active page is changed.

Declaration
public event ControlEventHandler ActivePageChanging
Event Type
Type Description
System.Windows.Forms.ControlEventHandler

LabelEditBegin

Occurs before edting the TabBarPage.

Declaration
public event LabelEditBeginEventHandler LabelEditBegin
Event Type
Type Description
LabelEditBeginEventHandler

LabelEditEnd

Occurs after edting the TabBarPage.

Declaration
public event LabelEditEventHandler LabelEditEnd
Event Type
Type Description
LabelEditEventHandler

TabBarMouseDown

Triggers mouse down occurs on TabBar

Declaration
public event TabBarSelectionHandler TabBarMouseDown
Event Type
Type Description
TabBarSelectionHandler

TabBarPageAdding

Occurs when Mouse pointer leave TabBarPage bounds

Declaration
public event TabBarPageAddingHandler TabBarPageAdding
Event Type
Type Description
TabBarPageAddingHandler

TabBarPageMouseEnter

Occurs when Mouse pointer rest on TabBarPage bounds

Declaration
public event TabPageSelectedEventHandler TabBarPageMouseEnter
Event Type
Type Description
TabPageSelectedEventHandler

TabBarPageMouseLeave

Occurs when Mouse pointer leave TabBarPage bounds

Declaration
public event TabPageSelectedEventHandler TabBarPageMouseLeave
Event Type
Type Description
TabPageSelectedEventHandler

TabBarVisibleChanged

Occurs when the TabBarPage is show or Hide or Add or Remove.

Declaration
public event TabBarVisibleChangedEventHandler TabBarVisibleChanged
Event Type
Type Description
TabBarVisibleChangedEventHandler

Explicit Interface Implementations

INonClientPaintingSupport.NonClientPaint(PaintEventArgs, Rectangle, Rectangle)

Declaration
IntPtr INonClientPaintingSupport.NonClientPaint(PaintEventArgs e, Rectangle displayRect, Rectangle windowRectInScreen)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e
System.Drawing.Rectangle displayRect
System.Drawing.Rectangle windowRectInScreen
Returns
Type Description
System.IntPtr

IVisualStyle.VisualTheme

Declaration
string IVisualStyle.VisualTheme { get; set; }
Returns
Type Description
System.String

Implements

System.Windows.Forms.IContainerControl