TextBox.AcceptsReturn Property
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Gets or sets the value that determines whether the text box allows and displays the newline or return characters.
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.
<TextBox AcceptsReturn="bool"/>
Property Value
Type: System.Booleantrue if the text box allows newline characters; otherwise, false. The default is false.
Dependency property identifier field: AcceptsReturnProperty.
If you change the AcceptsReturn property to true, text might be displayed differently due to text containing newline characters.
You can enable multi-line text in a TextBox control by using the AcceptsReturn property. Use the HorizontalScrollBarVisibility or VerticalScrollBarVisibility property to enable the horizontal scrollbars or the vertical scrollbars.
The following code snippet shows how you can use the AcceptsReturn property in XAML and code to create a multi-line text box control with scrollbars.
<StackPanel> <TextBox Margin="20,20,0,0" Text="A text box that demonstrates TextWrapping, TextAlignment, MaxLength, and AcceptsReturn" Width="300" Height="150" TextWrapping="Wrap" TextAlignment="Center" MaxLength="500" AcceptsReturn="True" /> <TextBox Margin="20,20,0,0" Text="A text box that demonstrates HorizontalScrollBarVisibility and VerticalScrollBarVisibility" Width="300" Height="150" AcceptsReturn="True" HorizontalScrollBarVisibility="Visible" VerticalScrollBarVisibility="Visible" /> </StackPanel>
public Page() { InitializeComponent(); CreateControls(); } private void CreateControls() { //Create stack panel StackPanel MyStackPanel = new StackPanel(); //Create the first text box TextBox MyTB1 = new TextBox(); MyTB1.Width = 300; MyTB1.Height = 150; MyTB1.Text = "A text box that demonstrates TextWrapping, TextAlignment, MaxLength and AcceptsReturn"; MyTB1.TextWrapping = TextWrapping.Wrap; MyTB1.TextAlignment = TextAlignment.Center; MyTB1.MaxLength = 500; MyTB1.AcceptsReturn = true; MyTB1.Margin = new Thickness(20, 20, 0, 0); //Create the second text box TextBox MyTB2 = new TextBox(); MyTB2.Margin = new Thickness(20, 20, 0, 0); MyTB2.Text = "A text box that demonstrates HorizontalScrollBarVisibility and VerticalScrollBarVisibility"; MyTB2.Width = 300; MyTB2.Height = 150; MyTB2.AcceptsReturn = true; MyTB2.HorizontalScrollBarVisibility = ScrollBarVisibility.Visible; MyTB2.VerticalScrollBarVisibility = ScrollBarVisibility.Visible; //Add the text boxes to the stack panel MyStackPanel.Children.Add(MyTB1); MyStackPanel.Children.Add(MyTB2); this.Content = MyStackPanel; }