TextBox.HeightRule Property

Gets or sets the rule that determines the text box height.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

TextBoxSizeRule HeightRule { get; set; }

VB.NET

Property HeightRule As TextBoxSizeRule

Property Value

Type	Description
TextBoxSizeRule	An enumeration member that specifies how to determine the text box height.

Available values:

Name	Description
Auto	Sets the height to fit entire text.
Exact	Sets the height to an exact value specified by the Size property.

Remarks

The default value of the HeightRule property is TextBoxSizeRule.Auto and the text box is stretched horizontally to fit its content if necessary. If you set the HeightRule property to TextBoxSizeRule.Exact, the text box retains its size as specified by the Size property.

Note

When a text box is resized by an end user, the HeightRule property is set to TextBoxSizeRule.Exact.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the HeightRule property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/CS/Form1.cs#L42

shape.Size = new SizeF(Units.PixelsToDocumentsF(sizeInPixels.Width, richEditControl.DpiX), Units.PixelsToDocumentsF(sizeInPixels.Height, richEditControl.DpiY));
shape.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto;
shape.Offset = new PointF(section.Page.Width / 2 - shape.Size.Width / 2, section.Page.Height / 2 - shape.Size.Height / 2);

word-document-api-examples/CS/CodeExamples/ShapesActions.cs#L84

// Allow text box resize to fit contents.
myTextBox.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto;
SubDocument boxedDocument = myTextBox.TextBox.Document;

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/ShapesActions.cs#L88

// Allow text box resize to fit contents.
myTextBox.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto;
SubDocument boxedDocument = myTextBox.ShapeFormat.TextBox.Document;

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Shapes.cs#L77

// Allow text box resize to fit contents.
myTextBox.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto;
SubDocument boxedDocument = myTextBox.ShapeFormat.TextBox.Document;

VB.NET

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/VB/Form1.vb#L44

shape.Size = New SizeF(Units.PixelsToDocumentsF(sizeInPixels.Width, richEditControl.DpiX), Units.PixelsToDocumentsF(sizeInPixels.Height, richEditControl.DpiY))
shape.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto
shape.Offset = New PointF(CLng(section.Page.Width) \ 2 - CLng(shape.Size.Width) \ 2, CLng(section.Page.Height) \ 2 - CLng(shape.Size.Height) \ 2)

word-document-api-examples/VB/CodeExamples/ShapesActions.vb#L77

' Allow text box resize to fit contents.
myTextBox.ShapeFormat.TextBox.HeightRule = DevExpress.XtraRichEdit.API.Native.TextBoxSizeRule.Auto
Dim boxedDocument As DevExpress.XtraRichEdit.API.Native.SubDocument = myTextBox.TextBox.Document

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/ShapesActions.vb#L78

' Allow text box resize to fit contents.
myTextBox.ShapeFormat.TextBox.HeightRule = TextBoxSizeRule.Auto
Dim boxedDocument As SubDocument = myTextBox.ShapeFormat.TextBox.Document

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Shapes.vb#L71

' Allow text box resize to fit contents.
myTextBox.ShapeFormat.TextBox.HeightRule = DevExpress.XtraRichEdit.API.Native.TextBoxSizeRule.Auto
Dim boxedDocument As DevExpress.XtraRichEdit.API.Native.SubDocument = myTextBox.ShapeFormat.TextBox.Document