WinForms

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

    Show / Hide Table of Contents

    Class TabSplitterContainer

    VS2008-like tab splitter UI.

    Inheritance
    System.Object
    BaseControl
    TabSplitterContainer
    Implements
    IThemeProvider
    IVisualStyle
    System.IDisposable
    Inherited Members
    BaseControl.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    BaseControl.GetActiveThemeName()
    BaseControl.ThemeName
    BaseControl.CanOverrideStyle
    BaseControl.IThemeProvider.BaseThemeName
    BaseControl.CanApplyTheme
    BaseControl.ControlName
    BaseControl.IVisualStyle.VisualTheme
    BaseControl.IsVisualStyleEnabled
    BaseControl.ThemeNameChanged
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class TabSplitterContainer : BaseControl, IThemeProvider, IVisualStyle, IDisposable

    Constructors

    TabSplitterContainer()

    Declaration
    public TabSplitterContainer()

    Properties

    Collapsed

    Indicates, whether panels are in collapsed state.

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

    Value is false, if control is in expanded state.

    Controls

    Gets the collection of controls contained within the control.

    Declaration
    public Control.ControlCollection Controls { get; }
    Property Value
    Type Description
    System.Windows.Forms.Control.ControlCollection

    Orientation

    Gets or sets the splitter orientation.

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

    PrimaryPages

    Returns collection of primary nested items.

    Declaration
    public TabSplitterPagesCollection PrimaryPages { get; }
    Property Value
    Type Description
    TabSplitterPagesCollection

    SecondaryPages

    Returns collection of secondary items.

    Declaration
    public TabSplitterPagesCollection SecondaryPages { get; }
    Property Value
    Type Description
    TabSplitterPagesCollection

    SplitterBackColor

    Gets or Sets the backcolor for TabSplitter.

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

    SplitterPosition

    Gets or sets the location of the splitter, in pixels, from the left or top edge of the TabSplitContainer.

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

    Style

    Gets or sets the TabSplitterContainer Style

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

    Swapped

    Indicates, whether control's panels are swapped.

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

    If value is true, primary items are layouted as secondary and vice versa. Layout of tabs in splitter is also swapped.

    ThemeStyle

    Gets or sets the TabSplitterContainerVisualStyle value used to customize the appearance of the TabSplitterContainer.

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

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

    Methods

    CreateAccessibilityInstance()

    Creates a new accessibility object for TabSplitterContainer.

    Declaration
    protected override AccessibleObject CreateAccessibilityInstance()
    Returns
    Type Description
    System.Windows.Forms.AccessibleObject

    Returns a new System.Windows.Forms.AccessibleObject of the TabSplitterContainer

    Dispose(Boolean)

    Clean up any resources being used.

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

    true if managed resources should be disposed; otherwise, false.

    Finalize()

    Declaration
    protected override void Finalize()

    GetControlName(String)

    Helps to apply the ControlName settings in control

    Declaration
    public override string GetControlName(string controlName)
    Parameters
    Type Name Description
    System.String controlName
    Returns
    Type Description
    System.String
    Overrides
    BaseControl.GetControlName(String)

    OnCanApplyThemeChanged(Boolean)

    Helps to apply the CanApplyTheme settings in control

    Declaration
    public override void OnCanApplyThemeChanged(bool canApplyTheme)
    Parameters
    Type Name Description
    System.Boolean canApplyTheme
    Overrides
    BaseControl.OnCanApplyThemeChanged(Boolean)

    OnCanOverrideStyleChanged(Boolean)

    Helps to apply the CanOverriderStyle settings in control

    Declaration
    public override void OnCanOverrideStyleChanged(bool canOverriderStyle)
    Parameters
    Type Name Description
    System.Boolean canOverriderStyle
    Overrides
    BaseControl.OnCanOverrideStyleChanged(Boolean)

    OnCollapsedChanged()

    Declaration
    protected virtual void OnCollapsedChanged()

    OnControlAdded(ControlEventArgs)

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

    OnControlRemoved(ControlEventArgs)

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

    OnLayout(LayoutEventArgs)

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

    OnResize(EventArgs)

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

    OnRightToLeftChanged(EventArgs)

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

    OnSplitterPositionChanged(EventArgs)

    Declaration
    protected virtual void OnSplitterPositionChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnSwappedChanged()

    Declaration
    protected virtual void OnSwappedChanged()

    OnThemeNameChanged(String)

    Helps to apply the ThemeName settings in control

    Declaration
    public override void OnThemeNameChanged(string themeName)
    Parameters
    Type Name Description
    System.String themeName

    ThemeName

    Overrides
    BaseControl.OnThemeNameChanged(String)

    Events

    CollapsedChanged

    Occurs when Collapsed property is changed.

    Declaration
    public event EventHandler CollapsedChanged
    Event Type
    Type Description
    System.EventHandler

    OrientationChanged

    Occurs when Orientation property is changed.

    Declaration
    public event EventHandler OrientationChanged
    Event Type
    Type Description
    System.EventHandler

    SplitterPositionChanged

    Occurs when the Splitter's position has been changed.

    Declaration
    public event EventHandler SplitterPositionChanged
    Event Type
    Type Description
    System.EventHandler

    SwappedChanged

    Occurs when Swapped property is changed.

    Declaration
    public event EventHandler SwappedChanged
    Event Type
    Type Description
    System.EventHandler

    Implements

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