FlowLayoutPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ScrollableControl
    • Panel
      • FlowLayoutPanel

Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns.

C#

public class FlowLayoutPanel : Panel, IExtenderProvider

VB.NET

Public Class FlowLayoutPanel
    Inherits Panel
    Implements IExtenderProvider

Arranges child controls horizontally or vertically. Ignores the control location, dock style and anchoring.

Uses the following properties of the child controls:

• Margin Increases the space around the control.
• FillWeight Stretches the width of control proportionally, according to the fill weights of all the controls, to use the remaining space in the row.
• MinimumSize Enforces the minimum size of controls stretched using the FillWeight value.
• MaximumSize Enforces the maximum size of controls stretched using the FillWeight value.
• FlowBreak Determines whether to create a new row or a new column after the control.

Uses the following properties of the parent FlowLayoutPanel control:

• FlowDirection Wraps child controls to a new column (TopDown, or BottomUp) or to a new row (LeftToRight, RightToLeft).
• WrapContents When set to false, child controls do not wrap and are either clipped or scrolled.
• Padding Increases the distance between the child controls and the borders of the parent panel.

Constructors

FlowLayoutPanel()

Initializes a new instance of the FlowLayoutPanel class.

FlowLayoutPanel(controls, direction)

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

Name	Type	Description
controls	Control[]	The array of child controls to add to the panel.
direction	FlowDirection	The flow direction of the layout of the child controls.

FlowLayoutPanel(location, size, controls, direction)

Initializes a new instance of the FlowLayoutPanel 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.
direction	FlowDirection	The flow direction of the layout of the child controls.

Properties

FlowDirection

FlowDirection: Returns or sets a value indicating the flow direction of the FlowLayoutPanel control. (Default: LeftToRight)

LayoutEngine

LayoutEngine: Returns the control's layout engine.

WrapContents

Boolean: Returns or sets whether the FlowLayoutPanel control should wrap its contents or let the contents be clipped. (Default: True)

Methods

GetFillWeight(control)

Determines whether to proportionally stretch the width or the control to fill the remaining space it the containing row.

Parameter	Type	Description
control	Control	The child control.

Returns: Int32. The fill weight value associated with the control.

The FillWeight property defines the relative width of a control in a row managed by the FlowLayoutPanel. The default value is 0 and the maximum value is 100 (the control will fill all the remaining width of the row.)

GetFlowBreak(control)

Determines whether to create a new row or a new column, depending on the value of the FlowDirection property, after the control.

Parameter	Type	Description
control	Control	The child control.

Returns: Boolean. true if the flow break is set; otherwise, false.

SetFillWeight(control, value)

Determines whether to proportionally stretch the width or the control to fill the remaining space it the containing row.

Parameter	Type	Description
control	Control	The child control.
value	Int32	The fill weight value to set.

The FillWeight property defines the relative width of a control in a row managed by the FlowLayoutPanel. The default value is 0 and the maximum value is 100 (the control will fill all the remaining width of the row.) Throws:

• ArgumentOutOfRangeException The value is less than 0 or greater than 100.

SetFlowBreak(control, value)

Determines whether to create a new row or a new column, depending on the value of the FlowDirection property, after the control.

Parameter	Type	Description
control	Control	The child control.
value	Boolean	The flow-break value to set.

Inherited By

Name	Description
BindingNavigator	Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
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.