TableLayoutPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• Control
  • ScrollableControl
    • Panel
      • TableLayoutPanel

Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.

C#

public class TableLayoutPanel : Panel, IExtenderProvider

VB.NET

Public Class TableLayoutPanel
    Inherits Panel
    Implements IExtenderProvider

Constructors

TableLayoutPanel()

Initializes a new instance of the TableLayoutPanel class.

TableLayoutPanel(location, size, controls)

Initializes a new instance of the TableLayoutPanel class with the specified initial settings.

Name	Type	Description
location	Point	The location of the panel on its parent control.
size	Size	The size of the panel.
controls	Control[]	The array of child controls to add to the panel.

Properties

ColumnCount

Int32: Returns or sets the number of columns in the table. (Default: 0)

ColumnStyles

TableLayoutColumnStyleCollection: Returns a collection of column styles for the TableLayoutPanel.

Controls

TableLayoutControlCollection: Returns the collection of controls contained within the TableLayoutPanel.

GrowStyle

TableLayoutPanelGrowStyle: Returns or sets whether the TableLayoutPanel control should expand to accommodate new cells when all existing cells are occupied. (Default: AddRows)

LayoutEngine

LayoutEngine: Returns the control's layout engine.

RowCount

Int32: Returns or sets the number of rows in the table. (Default: 0)

RowStyles

TableLayoutRowStyleCollection: Returns a collection of row styles for the TableLayoutPanel.

Methods

GetCellPosition(control)

Returns the TableLayoutPanelCellPosition that represents the row and the column of the cell.

Parameter	Type	Description
control	Control	A control contained within a cell.

Returns: TableLayoutPanelCellPosition. A TableLayoutPanelCellPosition that represents the cell position.

GetColumn(control)

Returns the column position of the specified child control.

Parameter	Type	Description
control	Control	A child control of the TableLayoutPanel.

Returns: Int32. The column position of the specified child control, or -1 if the position of control is determined by LayoutEngine.

Throws:

• ArgumentNullException control is null.
• NotSupportedException control is not a type that can be arranged by this LayoutEngine.

GetColumnSpan(control)

Returns the number of columns spanned by the specified child control.

Parameter	Type	Description
control	Control	A child control of the TableLayoutPanel.

Returns: Int32. The number of columns spanned by the child control. The default is 1.

GetControlFromPosition(column, row)

Returns the child control occupying the specified position.

Parameter	Type	Description
column	Int32	The column position of the control to retrieve.
row	Int32	The row position of the control to retrieve.

Returns: Control. The child control occupying the specified cell; otherwise, null if no control exists at the specified column and row, or if the control has its Visible property set to false.

Throws:

• ArgumentException Either column or row (or both) is less than 0.

GetPositionFromControl(control)

Returns the TableLayoutPanelCellPosition that represents the row and the column of the cell that contains the control.

Parameter	Type	Description
control	Control	A control contained within a cell.

Returns: TableLayoutPanelCellPosition. A TableLayoutPanelCellPosition that represents the cell position.

GetRow(control)

Returns the row position of the specified child control.

Parameter	Type	Description
control	Control	A child control of the TableLayoutPanel.

Returns: Int32. The row position of control , or -1 if the position of control is determined by LayoutEngine.

Throws:

• ArgumentNullException control is null.
• NotSupportedException control is not a type that can be arranged by this LayoutEngine.

GetRowHeights()

Returns an array representing the heights, in pixels, of the rows in the TableLayoutPanel.

Returns: Int32[]. An array of type Int32 that contains the heights, in pixels, of the rows in the TableLayoutPanel.

GetRowSpan(control)

Returns the number of rows spanned by the specified child control.

Parameter	Type	Description
control	Control	A child control of the TableLayoutPanel.

Returns: Int32. The number of rows spanned by the child control. The default is 1.

SetCellPosition(control, position)

Sets the TableLayoutPanelCellPosition that represents the row and the column of the cell.

Parameter	Type	Description
control	Control	A control contained within a cell.
position	TableLayoutPanelCellPosition	A TableLayoutPanelCellPosition that represents the row and the column of the cell.

SetColumn(control, column)

Sets the column position of the specified child control.

Parameter	Type	Description
control	Control	The control to move to another column.
column	Int32	The column to which control will be moved.

SetColumnSpan(control, value)

Sets the number of columns spanned by the child control.

Parameter	Type	Description
control	Control	A child control of the TableLayoutPanel.
value	Int32	The number of columns to span.

Throws:

• ArgumentOutOfRangeException value is less than 1.

SetRow(control, row)

Sets the row position of the specified child control.

Parameter	Type	Description
control	Control	The control to move to another row.
row	Int32	The row to which control will be moved.

SetRowSpan(control, value)

Sets the number of rows spanned by the child control.

Parameter	Type	Description
control	Control	A child control of the TableLayoutPanel.
value	Int32	The number of rows to span.

Throws:

• ArgumentOutOfRangeException value is less than 1.

Implements

Name	Description
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IImage	Provides access to common image properties across the controls that implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.