TextEditBase.AcceptsReturn Property

Gets or sets whether an end-user can insert return characters into a text. This is a dependency property.

Namespace: DevExpress.Xpf.Editors

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

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

Declaration

C#

public bool AcceptsReturn { get; set; }

VB.NET

Public Property AcceptsReturn As Boolean

Property Value

Type	Description
Boolean	true to allow return characters to be accepted and processed by the editor; otherwise, false.

Remarks

If the AcceptsReturn property is set to true, the ENTER key is processed by the editor, and results in a new text line. Otherwise, if the AcceptsReturn property is set to false, return characters are ignored. Return characters, however, can be inserted in code by adding appropriate characters (for instance, “\r\n” for C#) to the TextEditBase.Text property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AcceptsReturn 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.

XAML

dxscheduler-for-wpf-complete-implementation-of-a-custom-edit-appointment-form-e3374/CS/CustomAppointmentForm.xaml#L256

<dxe:TextEdit Grid.Row="8" Grid.Column="1" VerticalAlignment="Stretch" MinHeight="50"
              Text="{Binding Controller.Description}" AcceptsReturn="True" TextWrapping="Wrap"
              VerticalScrollBarVisibility="Visible"

how-to-invoke-the-default-appointment-recurrence-dialog-from-a-custom-edit-appointment-form-e3796/CS/WpfApplication1/CustomAppointmentForm.xaml#L122

Grid.Row="6" Grid.Column="1" Grid.ColumnSpan="2"
TextWrapping="Wrap" AcceptsReturn="True"
Text="{Binding Controller.Contact}"/>

how-to-create-a-custom-edit-appointment-form-using-the-mvvm-pattern-t103885/CS/MVVMSchedulerApplication/HospitalAppointmentForm.xaml#L98

<TextBlock Grid.Row="7" Grid.Column="0" Text="Notes:" Margin="0,0,4,8"/>
<dxe:TextEdit Grid.Row="7" Grid.Column="1" MinHeight="50" Margin="0,0,0,8" EditValue ="{Binding CustomFields[Notes], Mode=TwoWay}" AcceptsReturn="True" TextWrapping="Wrap"
              VerticalScrollBarVisibility="Visible" HorizontalContentAlignment="Left" VerticalContentAlignment="Top"/>

dxspellcheker-how-to-load-dictionaries-t471320/CS/SpellingDictionaryExample/MainWindow.xaml#L29

Grid.Row="0"
AcceptsReturn="True"
TextWrapping="Wrap"

wpf-docklayoutmanager-serialize-docklayoutmanager-when-tabbeddocumentuiservice-is-used/CS/Document.xaml#L16

<dxe:TextEdit VerticalContentAlignment="Top"
              AcceptsReturn="True"
              EditValue="{Binding Text, UpdateSourceTrigger=PropertyChanged}"