TextGetOptions enumeration

Applies to Windows and Windows Phone

Specifies options for retrieving the text in a document or text range.

Syntax


var value = Windows.UI.Text.TextGetOptions.none;

Attributes

[Flags()]
[Version(0x06020000)]

Members

The TextGetOptions enumeration has these members.

MemberValueDescription
None | none0

None of the following options is used.

AdjustCrlf | adjustCrlf1

If the starting character position is in the middle of a construct such as a CRLF (U+000D U+000A), surrogate pair, variation-selector sequence, or table-row delimiter, move to the beginning of the construct.

UseCrlf | useCrlf2

Use CR/LF in place of a carriage return.

UseObjectText | useObjectText4

Retrieve text including the alternate text for the images in the range.

AllowFinalEop | allowFinalEop8

Allow retrieving the final end-of-paragraph (EOP) if it’s included in the range. This EOP exists in all rich-text controls and cannot be deleted. It does not exist in plain-text controls.

NoHidden | noHidden32

Don't include hidden text.

IncludeNumbering | includeNumbering64

Include list numbers.

FormatRtf | formatRtf8192

Retrieve Rich Text Format (RTF) instead of plain text. RTF is a BYTE (8-bit) format, but because ITextRange.GetText returns a string, the RTF is returned as WCHARs (16-bit or UTF-16), not bytes, when you call ITextRange.GetText with the FormatRtf value. When you call ITextRange.SetText with FormatRtf, the method accepts an string containing either bytes or WCHARs, but other RTF readers only understand bytes.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Text
Windows::UI::Text [C++]

Metadata

Windows.winmd

See also

ITextDocument.GetText
ITextDocument.SaveToStream
ITextRange.GetTextViaStream
ITextRange.SetTextViaStream
ITextRange.GetText

 

 

Show:
© 2014 Microsoft