Back to Devexpress

TextBox.HeightRule Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-textbox-bb747054.md

latest5.5 KB
Original Source

TextBox.HeightRule Property

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

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
TextBoxSizeRule HeightRule { get; set; }
vb
Property HeightRule As TextBoxSizeRule

Property Value

TypeDescription
TextBoxSizeRule

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

|

Available values:

NameDescription
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.

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.

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

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

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

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

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

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

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

vb
' 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

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

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

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

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

See Also

Size

Document

AppendText(String)

TextBox Interface

TextBox Members

DevExpress.XtraRichEdit.API.Native Namespace