WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class FlowLayoutConstraints

    Show / Hide Table of Contents

    Class FlowLayoutConstraints

    Specifies how child components will be positioned inside a container managed by the FlowLayout manager.

    Inheritance
    System.Object
    FlowLayoutConstraints
    Implements
    System.ICloneable
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class FlowLayoutConstraints : ICloneable
    Remarks

    FlowLayoutConstraints are a set of properties that determine how a child component will be horizontally and vertically aligned when laid out in rows or columns.

    Constructors

    FlowLayoutConstraints()

    Overloaded. Creates a new instance of the FlowLayoutConstraints class and sets its defaults.

    Declaration
    public FlowLayoutConstraints()

    FlowLayoutConstraints(Boolean, HorzFlowAlign, VertFlowAlign, Boolean, Boolean, Boolean)

    Creates a new instance of the FlowLayoutConstraints class with the specified values.

    Declaration
    public FlowLayoutConstraints(bool active, HorzFlowAlign halign, VertFlowAlign valign, bool newline, bool proportionalColWidth, bool proportionalRowHeight)
    Parameters
    Type Name Description
    System.Boolean active

    True indicates this child should participate in layout; False otherwise.

    HorzFlowAlign halign

    The HorzFlowAlign mode in which child should be laid out (when in horizontal flow mode).

    VertFlowAlign valign

    The VertFlowAlign mode in which child should be laid out (when in vertical flow mode).

    System.Boolean newline

    True indicates a line break when this child is encountered while laying out.

    System.Boolean proportionalColWidth

    True indicates that the width of the column the corresponding child control occupies should be proportional to the laid out column's preferred width (when laid out vertically).

    System.Boolean proportionalRowHeight

    True indicates that the height of the row the corresponding child control occupies should be proportional to the laid out row's preferred height (when laid out horizontally).

    Fields

    Empty

    Declaration
    public static readonly FlowLayoutConstraints Empty
    Field Value
    Type Description
    FlowLayoutConstraints

    Properties

    Active

    Indicates whether the child should participate in layout.

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

    True to indicate this child should participate in layout; False otherwise. Default is True.

    HAlign

    Specifies the mode in which the child should be laid out within a row.

    Declaration
    public HorzFlowAlign HAlign { get; set; }
    Property Value
    Type Description
    HorzFlowAlign

    A HorzFlowAlign value. Default is HorzFlowAlign.Justify.

    IsEmpty

    Gets or sets the FlowLayoutConstraints structure with its properties left uninitialized.

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

    NewLine

    Indicates whether this child should always be moved to the beginning of a new line when laid out.

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

    True to move to a new line; False otherwise. Default is False.

    ProportionalColWidth

    Indicates whether the effective width of the column the corresponding child control occupies should be proportional to the laid out columns' preferred widths, for vertical layout mode.

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

    True for proportional width; False otherwise. Default is False.

    Remarks

    This property is in effect only when the layout mode is vertical. When this property is on, the column this control occupies will be deemed to take proportional width. Then the remaining horizontal space available will be split proportionally between such columns wanting proportional-width based on their preferred width.

    ProportionalRowHeight

    Indicates whether the effective height of the row the corresponding child control occupies should be proportional to the laid out rows' preferred heights, for horizontal layout mode.

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

    True for proportional height; False otherwise. Default is False.

    Remarks

    This property is in effect only when the layout mode is horizontal. When this property is on, the row this control occupies will be deemed to take proportional height. Then the remaining vertical space available will be split proportionally between such rows wanting proportional-height based on their preferred height.

    VAlign

    Specifies the mode in which the child should be laid out within a column.

    Declaration
    public VertFlowAlign VAlign { get; set; }
    Property Value
    Type Description
    VertFlowAlign

    A VertFlowAlign value. Default is VertFlowAlign.Center.

    Methods

    Clone()

    Creates an exact copy of this FlowLayoutConstraints object.

    Declaration
    public object Clone()
    Returns
    Type Description
    System.Object

    The cloned object.

    Default()

    Returns a default FlowLayoutConstraints object (that is not empty).

    Declaration
    public static FlowLayoutConstraints Default()
    Returns
    Type Description
    FlowLayoutConstraints

    The default FlowLayoutConstraints object.

    Equals(Object)

    Check the FlowLayoutConstraints object equals with current object and FlowLayoutConstraints properties. True, If the object equals with FlowLayoutConstraints. Otherwise false. Default is false.

    Declaration
    public override bool Equals(object o)
    Parameters
    Type Name Description
    System.Object o

    The FlowLayoutConstraints object

    Returns
    Type Description
    System.Boolean

    bool

    Overrides
    System.Object.Equals(System.Object)

    GetHashCode()

    Overridden. See System.Object.GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.Object.GetHashCode()

    Operators

    Equality(FlowLayoutConstraints, FlowLayoutConstraints)

    The basic == operator.

    Declaration
    public static bool operator ==(FlowLayoutConstraints lhs, FlowLayoutConstraints rhs)
    Parameters
    Type Name Description
    FlowLayoutConstraints lhs

    The left-hand side of the operator.

    FlowLayoutConstraints rhs

    The right-hand side of the operator.

    Returns
    Type Description
    System.Boolean

    Boolean value.

    Inequality(FlowLayoutConstraints, FlowLayoutConstraints)

    The basic != operator.

    Declaration
    public static bool operator !=(FlowLayoutConstraints lhs, FlowLayoutConstraints rhs)
    Parameters
    Type Name Description
    FlowLayoutConstraints lhs

    The left-hand side of the operator.

    FlowLayoutConstraints rhs

    The right-hand side of the operator.

    Returns
    Type Description
    System.Boolean

    bool

    Implements

    System.ICloneable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved