Class SplitContainerAdv

This control is container that consists of two panels, splitter between them and allows user simply put other controls on these panels and drag splitter vertically or horizontally to resize these panels.

Inheritance
System.Object
BaseControl
SplitContainerAdv
Implements
System.IDisposable
System.Windows.Forms.IMessageFilter
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class SplitContainerAdv : BaseControl, IThemeProvider, IDisposable, IMouseHookHLProcClient, IMessageFilter, IVisualStyle, IThemedControl, ISupportInitialize

Constructors

SplitContainerAdv()

Default constructor.

Declaration
public SplitContainerAdv()

Fields

m_splitterRect

Splitter rectangle, it is drawn in.

Declaration
public RectangleF m_splitterRect
Field Value
Type
System.Drawing.RectangleF

Properties

AutoScroll

Gets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries.

Declaration
[Obsolete("Don't use this property. Use instead SpitContainerAdv.Panel.AutoScroll property.")]
public bool AutoScroll { get; set; }
Property Value
Type
System.Boolean

AutoScrollMargin

Gets the size of the auto-scroll margin.

Declaration
[Obsolete("Don't use this property. Use instead SpitContainerAdv.Panel.AutoScrollMargin property.")]
public Size AutoScrollMargin { get; set; }
Property Value
Type
System.Drawing.Size

AutoScrollMinSize

Gets the minimum size of the auto-scroll.

Declaration
[Obsolete("Don't use this property. Use instead SpitContainerAdv.Panel.AutoScrollMinSize property.")]
public Size AutoScrollMinSize { get; set; }
Property Value
Type
System.Drawing.Size

AutoScrollOffset

Gets where this control is scrolled to in System.Windows.Forms.ScrollableControl.ScrollControlIntoView( System.Windows.Forms.Control ).

Declaration
[Obsolete("Don't use this property. Use instead SpitContainerAdv.Panel.AutoScrollOffset property.")]
public Point AutoScrollOffset { get; set; }
Property Value
Type
System.Drawing.Point

AutoScrollPosition

Gets the location of the auto-scroll position.

Declaration
[Obsolete("Don't use this property. Use instead SpitContainerAdv.Panel.AutoScrollPosition property.")]
public Point AutoScrollPosition { get; set; }
Property Value
Type
System.Drawing.Point

BackgroundColor

The background color, gradient and other styles can be set through this property.

Declaration
public BrushInfo BackgroundColor { get; set; }
Property Value
Type
BrushInfo
Remarks

The SplitContainerAdv control provides this property to enable specialized custom gradient backgrounds.

BeforeTouchSize

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

BorderStyle

Determines split panels border style.

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

CollapsedPanel

Gets or Sets currently collapsed panel.

Declaration
public CollapsedPanel CollapsedPanel { get; set; }
Property Value
Type
CollapsedPanel

Controls

Gets the collection of controls contained within this control.

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

DragState

Sets and gets current control movement state.

Declaration
protected DragState DragState { get; set; }
Property Value
Type
DragState

DrawState

Sets and gets current control state.

Declaration
protected DrawState DrawState { get; set; }
Property Value
Type
DrawState

EnableTouchMode

Gets or Sets the touchmode

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

ExpandFill

Gets or sets brush details for filling thumbnail arrows.

Declaration
public BrushInfo ExpandFill { get; set; }
Property Value
Type
BrushInfo

ExpandLine

Makes able to set pen color for drawing thumbnail arrows.

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

FixedPanel

Gets or Sets, which panel has fixed size during container resizing.

Declaration
public FixedPanel FixedPanel { get; set; }
Property Value
Type
FixedPanel

GripDark

Makes able to set brush for drawing a shadow around grip in thumbnail, if any.

Declaration
public BrushInfo GripDark { get; set; }
Property Value
Type
BrushInfo

GripLight

Makes able to set brush for drawing a grip in thumbnail, if any.

Declaration
public BrushInfo GripLight { get; set; }
Property Value
Type
BrushInfo

Host

Gets Hosted Form.

Declaration
protected Form Host { get; }
Property Value
Type
System.Windows.Forms.Form

HotBackgroundColor

The hot (under mouse cursor) background color, gradient and other styles can be set through this property.

Declaration
public BrushInfo HotBackgroundColor { get; set; }
Property Value
Type
BrushInfo
Remarks

The SplitContainerAdv control provides this property to enable specialized custom gradient backgrounds.

HotExpandFill

Makes able to set brush for filling thumbnail arrows, while under mouse cursor.

Declaration
public BrushInfo HotExpandFill { get; set; }
Property Value
Type
BrushInfo

HotExpandLine

Makes able to set pen color for drawing thumbnail arrows, while under mouse cursor.

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

HotGripDark

Makes able to set brush for drawing a shadow around grip in thumbnail, if any, while under mouse cursor.

Declaration
public BrushInfo HotGripDark { get; set; }
Property Value
Type
BrushInfo

HotGripLight

Makes able to set brush for drawing a grip in thumbnail, if any, while under mouse cursor.

Declaration
public BrushInfo HotGripLight { get; set; }
Property Value
Type
BrushInfo

IgnorePanelBackgroundColor

Gets or sets a value indicating whether to ignore the Style BackgroundColor and Panel.BackgroundColor will be used instead.

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

IgnoreThemeBackground

Indicates whether the control will ignore the theme's background color and draw the backcolor instead.

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

IsSplitterFixed

Gets or Sets, whether user is allowed to move splitter or not.

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

IsSplitterMoving

Indicates, is splitter moving operation is in progress or not. Readonly.

Declaration
protected bool IsSplitterMoving { get; }
Property Value
Type
System.Boolean

MinimumSize

Gets minimum container Width ( or Height, in Vertical Orientation case ) allowed.

Declaration
protected int MinimumSize { get; }
Property Value
Type
System.Int32

Orientation

Gets or sets a value indicating the horizontal or vertical orientation of the SplitContainerAdv panels.

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

Panel1

Gets left( top ) split panel.

Declaration
public SplitPanelAdv Panel1 { get; }
Property Value
Type
SplitPanelAdv

Panel1Collapsed

Gets or Sets, whether Panel1 is collapsed or not.

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

Panel1MinSize

Gets or Sets Panel1 minimum size.

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

Panel2

Gets right( bottom ) split panel.

Declaration
public SplitPanelAdv Panel2 { get; }
Property Value
Type
SplitPanelAdv

Panel2Collapsed

Gets or Sets, whether Panel2 is collapsed.

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

Panel2MinSize

Gets or Sets Panel2 minimum size.

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

PanelToBeCollapsed

Gets or Sets the panel to be collapsed when some predefined event occurs on it.

Declaration
public CollapsedPanel PanelToBeCollapsed { get; set; }
Property Value
Type
CollapsedPanel

RenderInfo

Gives readonly access to container's RenderInfo.

Declaration
public IRendererInfo RenderInfo { get; }
Property Value
Type
IRendererInfo

SelectedPanel

Gets or Sets split panel, drawn highlighted at design-time.

Declaration
protected SplitPanelAdv SelectedPanel { get; set; }
Property Value
Type
SplitPanelAdv

SplitterDistance

Gets or Sets splitter distance from left( top ) border.

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

SplitterIncrement

Determines the number of pixels the splitter moves in each increment.

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

SplitterWidth

Gets or Sets splitter width.

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

Style

Indicates the current style of the control.

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

ThemedControl

Gets the Themed control.

Declaration
public ThemedControlDrawing ThemedControl { get; }
Property Value
Type
ThemedControlDrawing

ThemesEnabled

Indicates whether the control is themed.

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

ThemeStyle

Gets or sets the SplitContainerAdvVisualStyle value used to customize the appearance of the SplitContainerAdv.

Declaration
public SplitContainerAdvVisualStyle ThemeStyle { get; set; }
Property Value
Type
SplitContainerAdvVisualStyle

TogglePanelOn

An event which leads to collapsing of previously specified panel.

Declaration
public TogglePanelOn TogglePanelOn { get; set; }
Property Value
Type
TogglePanelOn

Methods

ApplyScaleToControl(Single)

Applies scaling control

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

BeginInit()

Begins control initializing.

Declaration
public virtual void BeginInit()

CreateAccessibilityInstance()

New instance of the SplitContainerAdvAccessibility.

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

SplitContainerAdvAccessibility

Dispose(Boolean)

free child controls

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

EndInit()

Ends control initializing.

Declaration
public virtual void EndInit()

FinishSplitterMoving(Boolean)

Finish splitter moving operation.

Declaration
protected void FinishSplitterMoving(bool success)
Parameters
Type Name Description
System.Boolean success

If success is true, move splitter to new position, otherwise - restore previous.

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
System.String
Overrides

IncreaseBounds(ref Rectangle)

Increases bounds.

Declaration
protected void IncreaseBounds(ref Rectangle bounds)
Parameters
Type Name Description
System.Drawing.Rectangle bounds

MouseHookProc(Int32, Point, IntPtr, Int32, Int32)

For handling mouse messages in design mode.

Declaration
public bool MouseHookProc(int msg, Point point, IntPtr hwnd, int wHitTestCode, int dwExtraInfo)
Parameters
Type Name Description
System.Int32 msg
System.Drawing.Point point
System.IntPtr hwnd
System.Int32 wHitTestCode
System.Int32 dwExtraInfo
Returns
Type
System.Boolean
Remarks

In design mode, mouse messages can be handled only here.

MoveSplitterTo(Point)

Moves splitter to specified point.

Declaration
protected void MoveSplitterTo(Point mousePos)
Parameters
Type Name Description
System.Drawing.Point mousePos

OnBorderStyleChanged()

Invoked when splitter changed its border.

Declaration
protected virtual void OnBorderStyleChanged()

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

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

OnClick(EventArgs)

Invokes when mouse clicks the splitter

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

OnControlAdded(ControlEventArgs)

Invoked when a control is added to the splitter container.

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

OnControlRemoved(ControlEventArgs)

Invoked when a control is removed from the splitter container.

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

OnDoubleClick(EventArgs)

Invoked when mouse double clicks the splitter

Declaration
protected override void OnDoubleClick(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

OnIsSplitterFixedChanged()

Invoked when splitter is changing its fixed state.

Declaration
protected virtual void OnIsSplitterFixedChanged()

OnMouseDown(MouseEventArgs)

Invoked when mouse grabs the splitter.

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

OnMouseEnter(EventArgs)

Invoked when mouse enters splitter region.

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

OnMouseLeave(EventArgs)

Invoked when mouse leaves the splitter.

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

OnMouseMove(MouseEventArgs)

Invoked when mouse is moving over splitter.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

OnMouseUp(MouseEventArgs)

Invoked when mouse releases splitter.

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

OnOrientationChanged()

Invoked when splitter changed its orientation.

Declaration
protected virtual void OnOrientationChanged()

OnPaint(PaintEventArgs)

A standard OnPaint message handler.

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

OnPanelClick(SplitPanelAdv)

If parameter panel equal Collapsed panel than collapses this panel

Declaration
protected virtual void OnPanelClick(SplitPanelAdv panel)
Parameters
Type Name Description
SplitPanelAdv panel

event sender

OnPanelDoubleClick(SplitPanelAdv)

If parameter panel equal Collapsed panel and mode is DoubleClickMode than collapses this panel

Declaration
protected virtual void OnPanelDoubleClick(SplitPanelAdv panel)
Parameters
Type Name Description
SplitPanelAdv panel

event sender

OnRightToLeftChanged(EventArgs)

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

OnSplitterDistanceChanged()

Invoked when splitter is changing its distance.

Declaration
protected virtual void OnSplitterDistanceChanged()

OnSplitterMoved(SplitterMoveEventArgs)

Invoked when splitter is moved.

Declaration
protected virtual void OnSplitterMoved(SplitterMoveEventArgs args)
Parameters
Type Name Description
SplitterMoveEventArgs args

Arguments related to this event.

OnSplitterMoving(SplitterMoveEventArgs)

Invoked when splitter is being moved.

Declaration
protected virtual void OnSplitterMoving(SplitterMoveEventArgs args)
Parameters
Type Name Description
SplitterMoveEventArgs args

Arguments related to this event.

OnSplitterWidthChanged()

Invoked when splitter changed its width.

Declaration
protected virtual void OnSplitterWidthChanged()

OnSystemColorsChanged(EventArgs)

Invalidate splitter when SystemColor changed.

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

OnThemeEnabledChanged(EventArgs)

Invoked when splitter theme is changed.

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

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

PreFilterMessage(ref Message)

This method is almost a stub, needed only for mouse hook subscribing.

Declaration
public bool PreFilterMessage(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m
Returns
Type
System.Boolean

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Int32 width
System.Int32 height
System.Windows.Forms.BoundsSpecified specified

ShouldSerializeBackgroundColor()

Should a control serialize its background color.

Declaration
protected bool ShouldSerializeBackgroundColor()
Returns
Type Description
System.Boolean

true, if yes.

ShouldSerializeExpandFill()

Declaration
protected bool ShouldSerializeExpandFill()
Returns
Type
System.Boolean

ShouldSerializeExpandLine()

Declaration
protected bool ShouldSerializeExpandLine()
Returns
Type
System.Boolean

ShouldSerializeGripDark()

Declaration
protected bool ShouldSerializeGripDark()
Returns
Type
System.Boolean

ShouldSerializeGripLight()

Declaration
protected bool ShouldSerializeGripLight()
Returns
Type
System.Boolean

ShouldSerializeHotBackgroundColor()

Should a control serialize its hot background color.

Declaration
protected bool ShouldSerializeHotBackgroundColor()
Returns
Type Description
System.Boolean

true, if yes.

ShouldSerializeHotExpandFill()

Declaration
protected bool ShouldSerializeHotExpandFill()
Returns
Type
System.Boolean

ShouldSerializeHotExpandLine()

Declaration
protected bool ShouldSerializeHotExpandLine()
Returns
Type
System.Boolean

ShouldSerializeHotGripDark()

Declaration
protected bool ShouldSerializeHotGripDark()
Returns
Type
System.Boolean

ShouldSerializeHotGripLight()

Declaration
protected bool ShouldSerializeHotGripLight()
Returns
Type
System.Boolean

Events

OrientationChanged

Occurs, when splitter orientation is changed.

Declaration
public event EventHandler OrientationChanged
Event Type
Type
System.EventHandler

SplitterMoved

Occurs, when splitter is moved to new position.

Declaration
public event SplitterMoveEventHandler SplitterMoved
Event Type
Type
SplitterMoveEventHandler

SplitterMoving

Occurs, while splitter is moving.

Declaration
public event SplitterMoveEventHandler SplitterMoving
Event Type
Type
SplitterMoveEventHandler

ThemeEnabledChanged

Occurs, when splitter theme is changed.

Declaration
public event EventHandler ThemeEnabledChanged
Event Type
Type
System.EventHandler

Implements

System.IDisposable
System.Windows.Forms.IMessageFilter
System.ComponentModel.ISupportInitialize