FlexLayoutPanel

Wisej.Web.FlexLayoutPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

• Control

  • ScrollableControl

    • Panel

      • FlexLayoutPanel

Represents a panel that dynamically arranges its child controls.

C#

public class FlexLayoutPanel : Panel, IExtenderProvider

VB.NET

Public Class FlexLayoutPanel
    Inherits Panel
    Implements IExtenderProvider

The FlexLayoutPanel can arrange its child controls using the layout engine specified in LayoutStyle. When the value is set to Default, the child controls are arranged using the default layout engine, using their location, dock style and anchor properties. When the value of LayoutStyle is set to Horizontal, child controls are arranged horizontally in a single row. When the value of LayoutStyle is set to Vertical, child controls are arranged vertically in a single column. Uses the following properties of the child controls:

• Margin Increases the space around the control.

• AlignY Aligns the control vertically within its parent using one of the VerticalAlignment values. It's used only when LayoutStyle is set to Horizontal.

• AlignX Aligns the control horizontally within its parent using one of the HorizontalAlign values. It's used only when LayoutStyle is set to Vertical.

• FillWeight Stretches the control's width or height to use the remaining space in the parent FlexLayoutPanel proportionally, according to the fill weights of all the children.

• MinimumSize Enforces the minimum size of controls stretched using the FillWeight value.

• MaximumSize Enforces the maximum size of controls stretched using the FillWeight value.

Uses the following properties of the parent FlexLayoutPanel control:

• HorizontalAlign Aligns all the child controls horizontally using one of the HorizontalAlignment values. If any of the child control indicates a FillWeight value greater than 0, the remaining space is used to stretch the control and no alignment can take place since there is no remaining space. When LayoutStyle is set to Vertical, the value of HorizontalAlign is the default for the AlignX property of child controls.

• VerticalAlign Aligns all the child controls vertically using one of the VerticalAlignment values. If any of the child control indicates a FillWeight value greater than 0, the remaining space is used to stretch the control and no alignment can take place since there is no remaining space. When LayoutStyle is set to Horizontal, the value of VerticalAlign is the default for the AlignY property of child controls.

• Spacing Increases the horizontal or vertical space between the child controls. The value in pixels of Spacing is added to the control's Margin.

• Padding Increases the distance between the child controls and the borders of the parent panel.

Constructors

FlexLayoutPanel()

Initializes a new instance of the FlexLayoutPanel class.

FlexLayoutPanel(controls, layout)

Initializes a new instance of the FlexLayoutPanel class with the specified settings.

Name	Type	Description
controls	Control[]	An array of Control objects to be added to the panel.
layout	FlexLayoutStyle	Initial LayoutStyle.

FlexLayoutPanel(location, size, controls, layout)

Initializes a new instance of the FlexLayoutPanel class with the specified settings.

Name	Type	Description
location	Point	The location of the panel on its parent control.
size	Size	The size of the panel.
controls	Control[]	An array of Control objects to be added to the panel.
layout	FlexLayoutStyle	Initial LayoutStyle.

Properties

HorizontalAlign

HorizontalAlignment: Determines the horizontal alignment of the child controls when LayoutStyle is set to Vertical. (Default: Left)

LayoutEngine

LayoutEngine: Returns the control's layout engine.

LayoutStyle

FlexLayoutStyle: Determines the layout engine to use to arrange the panel's child controls. (Default: Default)

• Default Controls are arranged using the default layout engine and according to their location, dock style, and anchoring.

• Horizontal Controls are arranged horizontally in a single row according to their width, alignment, fill weight, and margin. The control's location, dock style, and anchoring are ignored.

• Vertical Controls are arranged vertically in a single column according to their height, alignment, fill weight, and margin. The control's location, dock style, and anchoring are ignored.

Spacing

Int32: Returns or sets the additional space, in pixels, between child controls when LayoutStyle is set to Horizontal or Vertical. The default value is 10. (Default: 10)

VerticalAlign

VerticalAlignment: Determines the vertical alignment of the child controls when LayoutStyle is set to Horizontal. (Default: Top)

Methods

GetAlignX(control)

Determines the horizontal alignment of the child control within the panel when LayoutStyle is set to Vertical.

Parameter	Type	Description
control	Control

Returns: HorizontalAlignment.

GetAlignY(control)

Determines the vertical alignment of the child control within the panel when LayoutStyle is set to Horizontal.

Parameter	Type	Description
control	Control

Returns: VerticalAlignment.

GetFillWeight(control)

Determines whether to proportionally stretch the child within the panel to use the remaining space.

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 or height of a control managed by the Panel. The default value is 0 and the maximum value is 100.

SetAlignX(control, value)

Determines the horizontal alignment of the child control within the panel when LayoutStyle is set to Vertical.

Parameter	Type	Description
control	Control
value	HorizontalAlignment

SetAlignY(control, value)

Determines the vertical alignment of the child control within the panel when LayoutStyle is set to Horizontal.

Parameter	Type	Description
control	Control
value	VerticalAlignment

SetFillWeight(control, value)

Determines whether to proportionally stretch the child within the panel to use the remaining space.

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

The FillWeight property defines the relative width or height of a control managed by the Panel. The default value is 0 and the maximum value is 100. Throws:

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

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.