IXRTextBox::GetAcceptsReturn (Compact 2013)

3/28/2014

This method retrieves a value that determines whether this text box allows for and displays the new-line character or return character. These characters are used to divide text into multiple lines.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetAcceptsReturn(
    bool *pAcceptsReturn
) = 0;

Parameters

• pAcceptsReturn
  [out] Pointer to a Boolean that determines whether this text box allows for and displays the new-line character or return character. This value is true if the text box allows for new-line characters; otherwise, it is false.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

If pAcceptsReturn is true, text might be displayed differently because of text that contains new-line characters.

You can enable multiline text in a text box control by calling IXRTextBox::SetAcceptsReturn.

.NET Framework Equivalent

System.Windows.Controls.TextBox.AcceptsReturn

Requirements

See Also

Reference

IXRTextBox
IXRTextBox::SetAcceptsReturn