WinForms

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

    Show / Hide Table of Contents

    Class SplitterControl

    A splitter control provides support for dynamic splitting of the viewable area.

    Inheritance
    System.Object
    SplitterControl
    RecordNavigationControl
    TabBarSplitterControl
    Implements
    IControlToolTipProvider
    IScrollBarFrame
    IDynamicSplitterFrame
    IThemedControl
    System.Windows.Forms.IContainerControl
    IThemeProvider
    IVisualStyle
    Namespace: Syncfusion.Windows.Forms
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class SplitterControl : ContainerControl, IControlToolTipProvider, IInternalSplitterParent, IScrollBarFrame, IDynamicSplitterFrame, IThemedControl, IContainerControl, IThemeProvider, IVisualStyle
    Remarks

    The controls shown inside the splitter control must implement the ISplitterPaneSupport interface. Additionally, these controls need to have built-in logic that allows displaying one set of data in different views.

    The IScrollBarWrapperContainer interface should be implemented if scrollbars of the child pane should be shared with the parent splitter frame.

    The controls in the pane should also implement ICreateNewWindow. This allows the control to create new panes and initialize them when an additional row or column is opened in the splitter control. If a control does not implement ICreateNewWindow, the splitter control will call the CreateNewControl(Int32, Int32, Control, Control) of the SplitterPaneFactory.

    Essential Grid's GridControlBase is a control that provides all of this logic and can be dropped into a splitter control and be dynamically split by an end user.

    ScrollControl also provides part of the logic to be used inside a splitter frame, but you still need to implement the logic for displaying one set of data in different views in your derived controls.

    See the SplitterControlDemo and TabBarSplitterControlDemo samples for examples on how to use SplitterControl in a form.

    Constructors

    SplitterControl()

    Initializes a new splitter control.

    Declaration
    public SplitterControl()

    Properties

    ActiveControl

    Gets or sets the Active control.

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

    ActivePane

    Gets or sets the active pane in the splitter control.

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

    BeforeTouchSize

    Gets/Sets Control size before touch enabled

    Declaration
    public Size BeforeTouchSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    BorderStyle

    Gets or sets the border style of the Splitter Control.

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

    ButtonLook

    Gets or sets the button look for the arrow buttons.

    Declaration
    public virtual ButtonLook ButtonLook { get; set; }
    Property Value
    Type Description
    ButtonLook

    CanApplyTheme

    Gets or sets a value indicating whether a SkinManager theme settings can be applied to the control.

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

    The default value is true.

    Remarks

    This property must be initialized before applying the VisualTheme />

    CanOverrideStyle

    Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

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

    Default value is false.

    Remarks

    By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

    ColumnCount

    Returns the number of visible column panes.

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

    CreateParams

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

    CurrentLayout

    SplitterLayout holds information about the current vertical and horizontal split positions.

    Declaration
    public SplitterLayout CurrentLayout { get; }
    Property Value
    Type Description
    SplitterLayout

    DefaultSize

    Returns the default size of the control.

    Declaration
    protected override Size DefaultSize { get; }
    Property Value
    Type Description
    System.Drawing.Size

    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

    GridOfficeScrollBars

    Gets or sets the Office like scrollbars.

    Declaration
    public virtual OfficeScrollBars GridOfficeScrollBars { get; set; }
    Property Value
    Type Description
    OfficeScrollBars

    HasControlFocus

    Indicates whether OnControlGotFocus() has been called. OnControlLostFocus() resets this flag.

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

    HSplitPos

    Gets or sets the horizontal splitter position in percentages of the splitter control's width.

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

    IsActiveControl

    Indicates whether OnEnter(EventArgs) has been called. OnLeave(EventArgs) resets this flag.

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

    IsDeactivated

    Indicates whether OnDeactivated(EventArgs) has been called. OnEnter(EventArgs) resets this flag.

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

    IsValidated

    Indicates whether the OnValidated(EventArgs) method has been called. OnLeave(EventArgs) and OnEnter(EventArgs) resets this flag.

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

    IsValidating

    Indicates whether the OnValidating(CancelEventArgs) method has been called. OnLeave(EventArgs) and OnEnter(EventArgs) resets this flag.

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

    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.

    Office2007ScrollBars

    Toggles between standard and Office2007 scrollbars.

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

    Office2007ScrollBarsColorScheme

    Gets or sets the style of Office2007 scroll bars

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

    Office2010ScrollBarsColorScheme

    Gets or sets the style of Office2010 scroll bars.

    Declaration
    public virtual Office2010ColorScheme Office2010ScrollBarsColorScheme { get; set; }
    Property Value
    Type Description
    Office2010ColorScheme

    Office2016ScrollBarsColorScheme

    Gets or sets the style of Office2016 scroll bars.

    Declaration
    public virtual ScrollBarOffice2016ColorScheme Office2016ScrollBarsColorScheme { get; set; }
    Property Value
    Type Description
    ScrollBarOffice2016ColorScheme

    RowCount

    Returns the number of visible row panes.

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

    ScrollBarAppearance

    Gets or sets the style of flat scrollbars.

    Declaration
    [Obsolete("Use Office2007ScrollBarsColorScheme instead.")]
    public FlatScrollBarStyle ScrollBarAppearance { get; set; }
    Property Value
    Type Description
    FlatScrollBarStyle

    ScrollBarColor

    Gets or sets the Backcolor for flat scrollbars.

    Declaration
    [Obsolete("Use Office2007ScrollBarsColorScheme instead.")]
    public Color ScrollBarColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ShowHorizontalScrollBar

    Toggles visibility of the Horizontal scrollbar.

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

    ShowSizeGrip

    Gets or sets the border style of the RecordNavigationControl.

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

    ShowToolTips

    Indicates whether ToolTips are being shown for tabs that have ToolTips set on them.

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

    ShowVerticalScrollBar

    Toggles visibility of the vertical scrollbar.

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

    SizeFactor

    Gets or sets the size factor of this tab bar

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

    SplitBars

    Gets or sets a value indicating what split behavior is supported. Rows, Columns or Both.

    Declaration
    public virtual DynamicSplitBars SplitBars { get; set; }
    Property Value
    Type Description
    DynamicSplitBars

    SplitterLayout

    Gets or sets the SplitterLayout that holds information about current vertical and horizontal split positions.

    Declaration
    public virtual SplitterLayout SplitterLayout { get; set; }
    Property Value
    Type Description
    SplitterLayout

    SplitterPaneFactory

    Toggles support for using the control inside a dynamic splitter window and sharing scrollbars with the parent window.

    Declaration
    public ISplitterPaneFactory SplitterPaneFactory { get; set; }
    Property Value
    Type Description
    ISplitterPaneFactory

    Style

    Gets/Sets the Style of the Splitter control

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

    SupportsFlatScrollBars

    Toggles between standard and flat scrollbars.

    Declaration
    [Obsolete("Use Office2007ScrollBars instead.")]
    public bool SupportsFlatScrollBars { get; set; }
    Property Value
    Type Description
    System.Boolean

    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.

    ThemesEnabled

    Indicates whether themes are enabled for this control.

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

    ThemeStyle

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

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

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

    VSplitPos

    Gets or sets the vertical splitter position in percentages of the splitter control's height.

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

    Methods

    ActivateControl(Control)

    Indicates whether the specified control is activated .

    Declaration
    public bool ActivateControl(Control c)
    Parameters
    Type Name Description
    System.Windows.Forms.Control c

    The System.Windows.Forms.Control to be activated.

    Returns
    Type Description
    System.Boolean

    True if the control is successfully activated; false otherwise.

    Remarks

    The control must be a child of the container control.

    ActivateNext(Boolean)

    Activates the next or previous pane.

    Declaration
    public void ActivateNext(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.

    CanActivateNext(Boolean)

    Indicates whether there is a next or previous pane that can be activated.

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

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

    Returns
    Type Description
    System.Boolean

    True if activating next or previous pane is good; False if already at last or first pane.

    CancelUpdate()

    Cancels any prior BeginUpdate() calls for child controls that implement ISupportUpdating.

    Declaration
    public void CancelUpdate()

    CreateScrollBar(ScrollBars, Int32)

    Creates a scrollbar for the specified row or column index.

    Declaration
    protected virtual Control CreateScrollBar(ScrollBars sbType, int index)
    Parameters
    Type Name Description
    System.Windows.Forms.ScrollBars sbType

    Indicates horizontal or vertical scrollbar.

    System.Int32 index

    The zero-based row or column index of the scrollbar.

    Returns
    Type Description
    System.Windows.Forms.Control

    A System.Windows.Forms.ScrollBar.

    CreateScrollBarContainer(ScrollBars, Int32)

    Returns either an IScrollBarContainer that has a reference to a scrollbar or creates a scrollbar.

    Declaration
    protected virtual Control CreateScrollBarContainer(ScrollBars sbType, int index)
    Parameters
    Type Name Description
    System.Windows.Forms.ScrollBars sbType

    Indicates horizontal or vertical scrollbar.

    System.Int32 index

    The zero-based row or column index of the scrollbar.

    Returns
    Type Description
    System.Windows.Forms.Control

    A control that is derived from System.Windows.Forms.ScrollBar or implements IScrollBarContainer.

    DeleteColumn(Int32)

    Deletes the splitter panes at the specified column.

    Declaration
    public void DeleteColumn(int column)
    Parameters
    Type Name Description
    System.Int32 column

    The zero-based index for the splitter pane column.

    DeleteRow(Int32)

    Deletes the splitter panes at the specified row.

    Declaration
    public void DeleteRow(int row)
    Parameters
    Type Name Description
    System.Int32 row

    The zero-based index for the splitter pane row.

    Dispose(Boolean)

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

    DisposePane(Int32, Int32)

    Disposes the specified pane.

    Declaration
    public virtual void DisposePane(int row, int column)
    Parameters
    Type Name Description
    System.Int32 row

    The zero-based index for the splitter pane row.

    System.Int32 column

    The zero-based index for the splitter pane column.

    FindPane(Control, out Int32, out Int32)

    Returns the row and column indices for a child pane.

    Declaration
    public bool FindPane(Control control, out int row, out int column)
    Parameters
    Type Name Description
    System.Windows.Forms.Control control

    The control to search for.

    System.Int32 row

    A placeholder where the row is returned.

    System.Int32 column

    A placeholder where the column is returned.

    Returns
    Type Description
    System.Boolean

    True if the control is a pane; False if the control was not a child pane.

    GetActiveThemeName()

    Gets the active theme of control.

    Declaration
    public string GetActiveThemeName()
    Returns
    Type Description
    System.String

    GetHScrollBar(Control)

    Returns the horizontal scrollbar associated with the control.

    Declaration
    public virtual Control GetHScrollBar(Control control)
    Parameters
    Type Name Description
    System.Windows.Forms.Control control

    A child pane.

    Returns
    Type Description
    System.Windows.Forms.Control

    The scrollbar for the pane.

    GetPane(Int32, Int32)

    Returns the splitter pane at the specified row and column. If there is no pane found at the specified row and column a pane will be created on demand with a call to OnCreateNewControl(Int32, Int32, Control).

    Declaration
    public virtual Control GetPane(int row, int column)
    Parameters
    Type Name Description
    System.Int32 row

    The zero-based index for the splitter pane row.

    System.Int32 column

    The zero-based index for the splitter pane column.

    Returns
    Type Description
    System.Windows.Forms.Control

    The control at the pane.

    GetVScrollBar(Control)

    Returns the vertical scrollbar associated with the control.

    Declaration
    public virtual Control GetVScrollBar(Control control)
    Parameters
    Type Name Description
    System.Windows.Forms.Control control

    A child pane.

    Returns
    Type Description
    System.Windows.Forms.Control

    The scrollbar for the pane.

    IsActive(Control, ScrollBars)

    Indicates whether the scrollbar belongs to the active pane.

    Declaration
    public bool IsActive(Control control, ScrollBars sbType)
    Parameters
    Type Name Description
    System.Windows.Forms.Control control

    The control associated with the scrollbar.

    System.Windows.Forms.ScrollBars sbType

    Specifies the vertical or horizontal scrollbar.

    Returns
    Type Description
    System.Boolean

    True if active; False otherwise.

    Examples

    ScrollControl checks IsActive to find out if it is the target of a HScroll event.

    		protected virtual void OnHScroll(object sender, ScrollEventArgs se)
    		{
    			try
    			{
    				IScrollBarFrame sbf = GetScrollBarFrameOfComponent(this);
    				if (sbf != null && !sbf.IsActive(this, ScrollBars.Horizontal))
    					return;
    }}

    OnButtonLookChanged(EventArgs)

    Raises the ButtonLookChanged event.

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

    Event data.

    OnCancelMode(EventArgs)

    Raises the CancelMode event.

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

    A System.EventArgs that contains the event data.

    OnControlAdded(ControlEventArgs)

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

    OnControlGotFocus()

    Raises the System.Windows.Forms.Control.GotFocus event. This method is called when the control or any child control gets focus and this control did not have focus before.

    Declaration
    protected virtual void OnControlGotFocus()
    Remarks

    Inheriting classes should override this method instead of overriding System.Windows.Forms.Control.OnGotFocus(System.EventArgs) because OnControlGotFocus() is also called when child controls gets focus and it is not called when focus is moved within child controls of this control.

    OnControlLostFocus()

    Raises the System.Windows.Forms.Control.LostFocus event. This method is called when the control or any child control loses focus and the new focused control is not a child of this control.

    Declaration
    protected virtual void OnControlLostFocus()
    Remarks

    Inheriting classes should override this method instead of overriding System.Windows.Forms.Control.OnLostFocus(System.EventArgs) because OnControlLostFocus() is also called when child controls lose focus and it is not called when focus is moved within child controls of this control.

    OnControlRemoved(ControlEventArgs)

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

    OnCreateNewControl(Int32, Int32, Control)

    Creates a new control for the specified splitter pane.

    Declaration
    protected virtual Control OnCreateNewControl(int row, int column, Control mainControl)
    Parameters
    Type Name Description
    System.Int32 row

    The zero-based index for the splitter pane row.

    System.Int32 column

    The zero-based index for the splitter pane column.

    System.Windows.Forms.Control mainControl

    The control in the first splitter pane.

    Returns
    Type Description
    System.Windows.Forms.Control

    A new instance of the control.

    OnDeactivated(EventArgs)

    Raises the Deactivated event.

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

    An System.EventArgs that contains the event data.

    OnEnter(EventArgs)

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

    OnFontChanged(EventArgs)

    Font changed

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

    OnGotFocus(EventArgs)

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

    OnHandleCreated(EventArgs)

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

    OnHandleDestroyed(EventArgs)

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

    OnHSplitPosChanged(EventArgs)

    Raises the HSplitPosChanged event.

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

    Event data.

    OnLayout(LayoutEventArgs)

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

    OnLeave(EventArgs)

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

    OnLostFocus(EventArgs)

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

    OnMouseDown(MouseEventArgs)

    Declaration
    protected override void OnMouseDown(MouseEventArgs mevent)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs mevent

    OnMouseUp(MouseEventArgs)

    Declaration
    protected override void OnMouseUp(MouseEventArgs mevent)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs mevent

    OnMovedSplitter(Object)

    Occurs after the user moves the splitter bar.

    Declaration
    public virtual void OnMovedSplitter(object sender)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    OnMoveSplitter(Object, Int32, Int32)

    Occurs when the user drags the splitter bar.

    Declaration
    public virtual void OnMoveSplitter(object sender, int x, int y)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.Int32 x

    The current horizontal position in pixels.

    System.Int32 y

    The current vertical position in pixels.

    OnOffice2007ScrollBarsChanged(EventArgs)

    Raises the Office2007ScrollBarsChanged event.

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

    A System.EventArgs that contains the event data.

    OnOffice2007ScrollBarsColorSchemeChanged(EventArgs)

    Raises the OnOffice2007ScrollBarsColorSchemeChanged(EventArgs) event.

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

    Event data.

    OnOffice2010ScrollBarsColorSchemeChanged(EventArgs)

    Raises the OnOffice2010ScrollBarsColorSchemeChanged(EventArgs) event.

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

    Event data.

    OnOffice2016ScrollBarsColorSchemeChanged(EventArgs)

    Raises the OnOffice2016ScrollBarsColorSchemeChanged(EventArgs) event.

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

    Event data.

    OnOfficeScrollBarsChanged(SplitterControl.OfficeScrollBarsEventArgs)

    Raises the OfficeScrollBarsChanged event

    Declaration
    protected virtual void OnOfficeScrollBarsChanged(SplitterControl.OfficeScrollBarsEventArgs e)
    Parameters
    Type Name Description
    SplitterControl.OfficeScrollBarsEventArgs e

    Office scrollbar type

    OnPaint(PaintEventArgs)

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

    OnPaneClosing(SplitterPaneEventArgs)

    Raises the PaneClosing event.

    Declaration
    protected virtual void OnPaneClosing(SplitterPaneEventArgs e)
    Parameters
    Type Name Description
    SplitterPaneEventArgs e

    A SplitterPaneEventArgs that contains the event data.

    OnPaneCreated(SplitterPaneEventArgs)

    Raises the PaneCreated event.

    Declaration
    protected virtual void OnPaneCreated(SplitterPaneEventArgs e)
    Parameters
    Type Name Description
    SplitterPaneEventArgs e

    A SplitterPaneEventArgs that contains the event data.

    OnParentChanged(EventArgs)

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

    OnScrollBarAppearanceChanged(EventArgs)

    Raises the ScrollBarAppearanceChanged event.

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

    Event data.

    OnScrollBarColorChanged(EventArgs)

    Raises the ScrollBarColorChanged event.

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

    OnSetCursor(ref Message)

    Declaration
    protected virtual void OnSetCursor(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m

    OnShowHorizontalScrollBarChanged(EventArgs)

    Raises the ShowHorizontalScrollBarChanged event.

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

    A System.EventArgs that contains the event data.

    OnShowSizeGripChanged(EventArgs)

    Raises the ShowSizeGripChanged event.

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

    A System.EventArgs that contains the event data.

    OnShowToolTipsChanged(EventArgs)

    Raises the ShowToolTipsChanged event.

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

    Event Data.

    OnShowVerticalScrollBarChanged(EventArgs)

    Raises the ShowVerticalScrollBarChanged event.

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

    A System.EventArgs that contains the event data.

    OnSizeChanged(EventArgs)

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

    OnSplitBarsChanged(EventArgs)

    Raises the SplitBarsChanged event.

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

    Event data.

    OnSplitterLayoutChanged(EventArgs)

    Raises the SplitterLayoutChanged event.

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

    Event data.

    OnSupportsFlatScrollBarsChanged(EventArgs)

    Raises the SupportsFlatScrollBarsChanged event.

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

    A System.EventArgs that contains the event data.

    OnThemeChanged(EventArgs)

    Raises the ThemeChanged event.

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

    An EventArgs that contains the event data.

    Remarks

    The OnThemeChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Note to Inheritors: When overriding OnThemeChanged in a derived class, be sure to call the base class's OnThemeChanged method so that registered delegates receive the event.

    OnValidated(EventArgs)

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

    OnValidating(CancelEventArgs)

    Declaration
    protected override void OnValidating(CancelEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs e

    OnValidatingLostFocus()

    This method is called if the control's OnControlLostFocus() notification occurs while handling a System.Windows.Forms.Control.Validating event. This typically occurs if a message box is displayed from a System.Windows.Forms.Control.Validating event handler.

    Declaration
    protected virtual void OnValidatingLostFocus()

    OnVisibleChanged(EventArgs)

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

    OnVSplitPosChanged(EventArgs)

    Raises the VSplitPosChanged event.

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

    ProcessDialogKey(Keys)

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

    QueryFocusInside()

    Indicates whether this control contains focus. If ActiveControl implements IQueryFocusInside, the QueryFocusInside() method is called on the ActiveControl.

    Declaration
    public virtual bool QueryFocusInside()
    Returns
    Type Description
    System.Boolean

    True if the control or any child control has focus; False otherwise.

    RaiseThemeChanged(Object, ThemeChangedEventArgs)

    Raises the ThemeNameChanged event when theme name changed.

    Declaration
    protected virtual void RaiseThemeChanged(object sender, ThemeChangedEventArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The sender value.

    ThemeChangedEventArgs args

    A ThemeChangedEventArgs contains the event data.

    Refresh()

    Forces the control to invalidate its client area and immediately redraw itself and any child controls.

    Declaration
    public override void Refresh()

    ResetScrollBarColor()

    Resets the ScrollBarColor to default.

    Declaration
    public void ResetScrollBarColor()

    ResetToolTips()

    Reinitializes and hides ToolTips.

    Declaration
    public virtual void ResetToolTips()

    SetActivePane(Int32, Int32)

    Sets the active pane in the splitter control specified by row and column.

    Declaration
    public void SetActivePane(int row, int column)
    Parameters
    Type Name Description
    System.Int32 row

    The zero-based index for the splitter pane row.

    System.Int32 column

    The zero-based index for the splitter pane column.

    SplitColumn(Int32)

    Indicates whether the columns were split horizontally at the specified x coordinate.

    Declaration
    public bool SplitColumn(int cx)
    Parameters
    Type Name Description
    System.Int32 cx

    The horizontal position in in percentages of the splitter control's width.

    Returns
    Type Description
    System.Boolean

    True if columns were split successfully; False if they were already split or the operation aborted.

    SplitRow(Int32)

    Indicates whether the rows were split at the given y coordinate.

    Declaration
    public bool SplitRow(int cy)
    Parameters
    Type Name Description
    System.Int32 cy

    The vertical position in percentages of the splitter control's height.

    Returns
    Type Description
    System.Boolean

    True if rows were split successfully; False if they were already split or the operation aborted.

    ToString()

    Overridden method.

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

    WndProc(ref Message)

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

    Events

    ButtonLookChanged

    Occurs when the ButtonLook property has changed.

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

    CancelMode

    Occurs when the window receives a WM_CANCELMODE message.

    Declaration
    public event EventHandler CancelMode
    Event Type
    Type Description
    System.EventHandler
    Remarks

    WM_CANCELMODE is sent to cancel certain modes, such as mouse capture. For example, the system sends this message to the active window when a dialog box or message box is displayed. Certain functions also send this message explicitly to the specified window regardless of whether it is the active window. For example, the EnableWindow function sends this message when disabling the specified window.

    Deactivated

    Occurs when both OnControlLostFocus() and OnLeave(EventArgs) occur.

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

    HSplitPosChanged

    Occurs when the horizontal splitter position has changed.

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

    Office2007ScrollBarsChanged

    Occurs when the Office2007ScrollBars property has changed.

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

    Office2007ScrollBarsColorSchemeChanged

    Occurs when the Office2007ColorScheme property has changed.

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

    Office2010ScrollBarsColorSchemeChanged

    Occurs when the Office2010ScrollBarsColorScheme property has changed.

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

    Office2016ScrollBarsColorSchemeChanged

    Occurs when the Office2016ScrollBarsColorScheme property has changed.

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

    OfficeScrollBarsChanged

    Occurs when the Office2007ScrollBars property has changed.

    Declaration
    public event SplitterControl.OfficeScrollBarsEventHandler OfficeScrollBarsChanged
    Event Type
    Type Description
    SplitterControl.OfficeScrollBarsEventHandler

    PaneClosing

    Occurs after a row or column is hidden and before the control that is displayed in the pane is disposed. Use this event to implement additional clean up for the control before DisposePane(Int32, Int32) is called.

    Declaration
    public event SplitterPaneEventHandler PaneClosing
    Event Type
    Type Description
    SplitterPaneEventHandler
    Remarks

    PaneClosing is an ideal hook to unwire event handlers from the control.

    PaneCreated

    Occurs after the control to be displayed in a new pane has been created. Use this event to implement additional initialization for the new control.

    Declaration
    public event SplitterPaneEventHandler PaneCreated
    Event Type
    Type Description
    SplitterPaneEventHandler
    Remarks

    PaneCreated is an ideal hook to add handler for events in the new control.

    ScrollBarAppearanceChanged

    Occurs when the ScrollBarAppearance property has changed.

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

    ScrollBarColorChanged

    Occurs when the ScrollBarColor property has changed.

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

    ShowHorizontalScrollBarChanged

    Occurs when the ShowHorizontalScrollBar property has changed.

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

    ShowSizeGripChanged

    Occurs when ShowSizeGrip property has changed.

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

    ShowToolTipsChanged

    Occurs when the ShowToolTips property has changed.

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

    ShowVerticalScrollBarChanged

    Occurs when the ShowVerticalScrollBar property has changed.

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

    SplitBarsChanged

    Occurs when the SplitBars property has changed.

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

    SplitterLayoutChanged

    Occurs when the splitter layout has changed.

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

    SupportsFlatScrollBarsChanged

    Occurs when the SupportsFlatScrollBars property has changed.

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

    ThemeChanged

    Occurs when the ThemesEnabled property changes.

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

    ThemeNameChanged

    Occurs when theme name of the control has changed.

    Declaration
    public event ThemeChangedEventHandler ThemeNameChanged
    Event Type
    Type Description
    ThemeChangedEventHandler

    VSplitPosChanged

    Occurs when the vertical splitter position has changed.

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

    Explicit Interface Implementations

    IControlToolTipProvider.GetControlToolTip()

    Declaration
    ControlToolTip IControlToolTipProvider.GetControlToolTip()
    Returns
    Type Description
    ControlToolTip

    IDynamicSplitterFrame.ActivePane

    Declaration
    Control IDynamicSplitterFrame.ActivePane { get; set; }
    Returns
    Type Description
    System.Windows.Forms.Control

    IDynamicSplitterFrame.ColumnCount

    Declaration
    int IDynamicSplitterFrame.ColumnCount { get; }
    Returns
    Type Description
    System.Int32

    IDynamicSplitterFrame.RowCount

    Declaration
    int IDynamicSplitterFrame.RowCount { get; }
    Returns
    Type Description
    System.Int32

    IDynamicSplitterFrame.SplitBars

    Declaration
    DynamicSplitBars IDynamicSplitterFrame.SplitBars { get; }
    Returns
    Type Description
    DynamicSplitBars

    IVisualStyle.VisualTheme

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

    IThemeProvider.BaseThemeName

    Gets or sets the BaseTheme name of the theme

    Declaration
    string IThemeProvider.BaseThemeName { get; set; }
    Returns
    Type Description
    System.String

    IThemeProvider.ControlName

    Gets the name of the control.

    Declaration
    string IThemeProvider.ControlName { get; }
    Returns
    Type Description
    System.String

    Implements

    IControlToolTipProvider
    IScrollBarFrame
    IDynamicSplitterFrame
    IThemedControl
    System.Windows.Forms.IContainerControl
    IThemeProvider
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved