WordWrap Property (CellStyle)

Gets or sets a value that indicates whether the text content wraps within multiline text.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<DefaultValueAttribute()>
<RefreshPropertiesAttribute(RefreshProperties.Repaint)>
<SRCategoryAttribute("TextAppearance")>
<SRDescriptionAttribute("Indicates whether lines are automatically word-wrapped for a multiline edit cell.")>
Public Property WordWrap As MultiRowTriState

Dim instance As CellStyle
Dim value As MultiRowTriState
 
instance.WordWrap = value
 
value = instance.WordWrap

[DefaultValue()]
[RefreshProperties(RefreshProperties.Repaint)]
[SRCategory("TextAppearance")]
[SRDescription("Indicates whether lines are automatically word-wrapped for a multiline edit cell.")]
public MultiRowTriState WordWrap {get; set;}

Property Value

A MultiRowTriState value. The default is MultiRowTriState.Inherit.

Exceptions

Exception	Description
System.ComponentModel.InvalidEnumArgumentException	The specified value is not a MultiRowTriState value.

Remarks

If the property value is MultiRowTriState.True, the text outside the content area dynamically renders to the next line. If the value is MultiRowTriState.False, the text outside the content area is clipped. If the value is MultiRowTriState.Inherit, the cell gets the property value from its parents when rendering the text.

Note:
This property is invalid when the Multiline property value is MultiRowTriState.False.

Example

This example sets the WordWrap property.

GrapeCity.Win.MultiRow.TextBoxCell text1 = new GrapeCity.Win.MultiRow.TextBoxCell();
GrapeCity.Win.MultiRow.TextBoxCell text2 = new GrapeCity.Win.MultiRow.TextBoxCell();
text1.Name = "text1";
text2.Name = "text2";
GrapeCity.Win.MultiRow.Template template1 = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(new GrapeCity.Win.MultiRow.Cell[] { text1, text2 }, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader | GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber);
template1.ColumnHeaders[0].Cells[0].Value = "Column1";
template1.ColumnHeaders[0].Cells[1].Value = "Column2";
gcMultiRow1.Template = template1;
gcMultiRow1.RowCount = 3;
gcMultiRow1[0, 0].Style.WordWrap = GrapeCity.Win.MultiRow.MultiRowTriState.True;

VB.NET

Dim text1 As New GrapeCity.Win.MultiRow.TextBoxCell()
Dim text2 As New GrapeCity.Win.MultiRow.TextBoxCell()
text1.Name = "text1"
text2.Name = "text2"
Dim template1 As GrapeCity.Win.MultiRow.Template = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(New GrapeCity.Win.MultiRow.Cell() {text1, text2}, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader Or GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber)
template1.ColumnHeaders(0).Cells(0).Value = "Column1"
template1.ColumnHeaders(0).Cells(1).Value = "Column2"
GcMultiRow1.Template = template1
GcMultiRow1.RowCount = 3
GcMultiRow1(0, 0).Style.WordWrap = GrapeCity.Win.MultiRow.MultiRowTriState.True

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

Reference

CellStyle Class
CellStyle Members