GetPreferredRowHeight(Int32,PreferredSizeRowOptions) Method

Gets the height in pixels of the tallest cell (based on text content) in the specified row on this sheet.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function GetPreferredRowHeight( _
   ByVal row As Integer, _
   ByVal flags As PreferredSizeRowOptions _
) As Single

'Usage
 
Dim instance As SheetView
Dim row As Integer
Dim flags As PreferredSizeRowOptions
Dim value As Single
 
value = instance.GetPreferredRowHeight(row, flags)

public float GetPreferredRowHeight( 
   int row,
   PreferredSizeRowOptions flags
)

Parameters

row: Row index
flags: Options when getting the preferred height

Example

This example uses the GetPreferredRowHeight method.

fpSpread1.ActiveSheet.ColumnHeader.Cells[0,2].Text = "Column Header Text";
fpSpread1.ActiveSheet.Cells[1, 1].Text = "Text in cell (1, 1)";
FarPoint.Win.Spread.CellType.TextCellType textcell = new FarPoint.Win.Spread.CellType.TextCellType();
textcell.WordWrap = true;
fpSpread1.ActiveSheet.Cells[2, 2].CellType = textcell;
fpSpread1.ActiveSheet.Cells[2, 2].Text = "Spread Windows Forms and the Funnel Chart";
fpSpread1.AutoFitColumnOptions = FarPoint.Win.Spread.PreferredSizeColumnOptions.ExcludeHeaders | FarPoint.Win.Spread.PreferredSizeColumnOptions.ExcludeSpans;
fpSpread1.AutoFitRowOptions = FarPoint.Win.Spread.PreferredSizeRowOptions.ExcludeHeaders;

private void button1_Click(object sender, EventArgs e)
        {
            float size;
            size = fpSpread1.ActiveSheet.GetPreferredRowHeight(2, FarPoint.Win.Spread.PreferredSizeRowOptions.ExcludeHeaders);
            textBox1.Text = size.ToString();
        }

Visual Basic

FpSpread1.ActiveSheet.ColumnHeader.Cells(0, 2).Text = "Column Header Text"
FpSpread1.ActiveSheet.Cells(1, 1).Text = "Text in cell (1, 1)"
Dim textcell As New FarPoint.Win.Spread.CellType.TextCellType()
textcell.WordWrap = True
FpSpread1.ActiveSheet.Cells(2, 2).CellType = textcell
FpSpread1.ActiveSheet.Cells(2, 2).Text = "Spread Windows Forms and the Funnel Chart"
FpSpread1.AutoFitColumnOptions = FarPoint.Win.Spread.PreferredSizeColumnOptions.ExcludeHeaders Or FarPoint.Win.Spread.PreferredSizeColumnOptions.ExcludeSpans
FpSpread1.AutoFitRowOptions = FarPoint.Win.Spread.PreferredSizeRowOptions.ExcludeHeaders

Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
Dim size As Integer
size = FpSpread1.ActiveSheet.GetPreferredRowHeight(2, FarPoint.Win.Spread.PreferredSizeRowOptions.ExcludeHeaders)
TextBox1.Text = size
End Sub

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

SheetView Class
SheetView Members
Overload List