MaxLength Property (RichTextCellType)

Gets or sets the maximum number of characters allowed in the rich text cell.

Syntax

Visual Basic
C#

'Declaration
 
Public Property MaxLength As Integer

'Usage
 
Dim instance As RichTextCellType
Dim value As Integer
 
instance.MaxLength = value
 
value = instance.MaxLength

public int MaxLength {get; set;}

Property Value

Integer number of characters

Remarks

This property sets the number of characters that can be typed, not the number that can be displayed. If you enter text by setting the Text property for a cell, this property does not limit those characters, only what can be typed by a user when in edit mode.

When this property is set to 0, the maximum length of the text is not zero but is instead set to allow the maximum that can be entered in the control which is 64 KB of characters. For more information, refer to the RichTextBox.MaxLength property in the Microsoft .NET documentation.

Example

This example limits the number of characters the user can enter when in edit mode.

FarPoint.Win.Spread.CellType.RichTextCellType rtb;

private void Form1Load(object sender, System.EventArgs e)
{
      rtb = new FarPoint.Win.Spread.CellType.RichTextCellType();
      rtb.MaxLength = 10;
}

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.MaxLength = 10
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