Xceed Grid for WinForms v4.3 Documentation
Xceed.Editors.v2.6 Assembly / Xceed.Editors Namespace / ISupportIntegralResizing Interface / GetPreferredHeight Method
The total available height.


In This Topic
    GetPreferredHeight Method (ISupportIntegralResizing)
    In This Topic
    Returns the height required to fit the maximum number of items within the specified height.
    Syntax
    'Declaration
     
    <DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility.Hidden)>
    <BrowsableAttribute(False)>
    <DefaultValueAttribute(False)>
    Function GetPreferredHeight( _
       ByVal height As Integer _
    ) As Integer
    'Usage
     
    Dim instance As ISupportIntegralResizing
    Dim height As Integer
    Dim value As Integer
     
    value = instance.GetPreferredHeight(height)
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
    [Browsable(false)]
    [DefaultValue(false)]
    int GetPreferredHeight( 
       int height
    )

    Parameters

    height
    The total available height.

    Return Value

    A value representing the height required to fit the maximum number of items.
    Remarks

    If the specified height can fit 2 items and there is not enough space to fit a 3rd one, then GetPreferredHeight will return the height necessary to fit 2 items.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also