Multiline Property (RichTextCellType)

Visual Basic
C#

'Declaration
 
Public Property Multiline As Boolean

'Usage
 
Dim instance As RichTextCellType
Dim value As Boolean
 
instance.Multiline = value
 
value = instance.Multiline

public bool Multiline {get; set;}

Property Value

Boolean: true if multiple lines of text are allowed; false otherwise

When set to true, multiple lines are allowed, but text is not automatically wrapped to new lines when the number of characters exceeds the width of the cell. To wrap lines of text automatically, set the WordWrap property. Otherwise, to wrap lines of text, be sure to type in carriage-return characters to force the text to the new lines.

If the Multiline property is set to true, the row height returned by the GetPreferredRowHeight might be smaller than what is necessary to display the entire cell if there are multiple font sizes and styles on each line.

To always display a scroll bar (ForcedBoth, ForcedHorizontal, or ForcedVertical enumeration settings) in a rich text cell, you must set the Multiline property to true. Refer to the ScrollBars property.

This example loads a rich-text-formatted file into the cell.

C#

FarPoint.Win.Spread.CellType.RichTextCellType rtb;

private void Form1Load(object sender, System.EventArgs e)
{
      rtb = new FarPoint.Win.Spread.CellType.RichTextCellType();
      rtb.Multiline = true;
      fpSpread1.ActiveSheet.Cells[0, 0].CellType = rtb;
      System.IO.StreamReader file = new System.IO.StreamReader(Application.StartupPath + "\\test.rtf");
      string words = file.ReadToEnd();
      fpSpread1.ActiveSheet.Cells[0, 0].Value = words;
}

Visual Basic

Dim rtb As New FarPoint.Win.Spread.CellType.RichTextCellType

Private Sub Form1Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
      rtb.Multiline = True
      FpSpread1.ActiveSheet.Cells(0, 0).CellType = rtb
      Dim file As New System.IO.StreamReader(Application.StartupPath & "\test.rtf")
      Dim words As String = file.ReadToEnd()
      FpSpread1.ActiveSheet.Cells(0, 0).Value = words
End Sub

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

Reference

RichTextCellType Class
RichTextCellType Members