Interface IDynamicSplitterFrame

Defines an interface for a control that supports splitting the view into several row panes and column panes.

Namespace: Syncfusion.Windows.Forms

Assembly: Syncfusion.Shared.Base.dll

Syntax

public interface IDynamicSplitterFrame

Remarks

Both SplitterControl and TabBarPage implement this interface. This gives client controls a one stop interface to get all splitter functionality no matter if they are embedded inside a SplitterControl or TabBarPage inside a TabBarSplitterControl.

Properties

ActivePane

Gets / sets the active pane in the splitter control.

Declaration

Control ActivePane { get; set; }

Property Value

Type
System.Windows.Forms.Control

ColumnCount

Returns the number of visible column panes.

Declaration

int ColumnCount { get; }

Property Value

Type
System.Int32

RowCount

Returns the number of visible row panes.

Declaration

int RowCount { get; }

Property Value

Type
System.Int32

SplitBars

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

Declaration

DynamicSplitBars SplitBars { get; }

Property Value

Type
DynamicSplitBars

Methods

ActivateNext(Boolean)

Activates the next or previous pane.

Declaration

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.

CanActivateNext(Boolean)

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

Declaration

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.

DeleteColumn(Int32)

Deletes the splitter panes at the specified column.

Declaration

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

void DeleteRow(int row)

Parameters

Type	Name	Description
System.Int32	row	The zero-based index for the splitter pane row.

FindPane(Control, out Int32, out Int32)

Returns the row and column index for a child pane.

Declaration

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.

GetPane(Int32, Int32)

Returns the splitter pane at the specified row and column.

Declaration

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.

SetActivePane(Int32, Int32)

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

Declaration

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

bool SplitColumn(int cx)

Parameters

Type	Name	Description
System.Int32	cx	The horizontal position 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

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.

Events

HSplitPosChanged

Occurs when the horizontal splitter position has changed.

Declaration

event EventHandler HSplitPosChanged

Event Type

Type
System.EventHandler

SplitBarsChanged

Occurs when the SplitBars property has changed.

Declaration

event EventHandler SplitBarsChanged

Event Type

Type
System.EventHandler

SplitterLayoutChanged

Occurs when the splitter layout has changed.

Declaration

event EventHandler SplitterLayoutChanged

Event Type

Type
System.EventHandler

VSplitPosChanged

Occurs when the vertical splitter position has changed.

Declaration

event EventHandler VSplitPosChanged

Event Type

Type
System.EventHandler