WordWrap Property (RichTextCellType)

Gets or sets whether text that is too long to fit in the cell wraps to additional lines.

Syntax

Visual Basic
C#

'Declaration
 
Public Property WordWrap As Boolean

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

public bool WordWrap {get; set;}

Property Value

Boolean: true to allow words to wrap to multiple lines; false otherwise

Remarks

When the font is italic, the size calculation may not be accurate (because of the underlying .NET framework). The line wrapping that occurs based on the WordWrap property setting and the adjusting that occurs when the user double-clicks the header edge may not adjust properly.

If the WordWrap property is set to true, the row height returned by the GetPreferredRowHeight might be larger than what is necessary to display the entire cell if the last character on a wrapped line is on the border.

Example

This example causes a hard return in the cell when the width is adjusted.

FarPoint.Win.Spread.CellType.RichTextCellType rtb;

private void Form1Load(object sender, System.EventArgs e)
{
      rtb = new FarPoint.Win.Spread.CellType.RichTextCellType();
      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;
      rtb.Multiline = true;
      rtb.WordWrap = true;
}

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
      Dim file As New System.IO.StreamReader(Application.StartupPath & "\test1.rtf")
      Dim words As String = file.ReadToEnd()
      rtb.ScrollBars = RichTextBoxScrollBars.ForcedVertical
      FpSpread1.ActiveSheet.Cells(0, 0).Value = words
      rtb.Multiline = True
      rtb.WordWrap = True
End Sub

Requirements

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