Delen via

TextGetOptions Enum

  • Reference

Definition

Namespace:
Windows.UI.Text
Edit

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

This enumeration supports a bitwise combination of its member values.

public enum class TextGetOptions
/// [System.Flags]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class TextGetOptions
[System.Flags]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum TextGetOptions
var value = Windows.UI.Text.TextGetOptions.none
Public Enum TextGetOptions
Inheritance
Enum
TextGetOptions
Attributes
FlagsAttribute ContractVersionAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Fields

Name Value Description
None 0

None of the following options is used.
AdjustCrlf 1

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 2

Use carriage return/line feed (CR/LF) in place of a carriage return.
UseObjectText 4

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

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 32

Don't include hidden text.
IncludeNumbering 64

Include list numbers.
FormatRtf 8192

Retrieve Rich Text Format (RTF) instead of plain text. Rich Text Format (RTF) is a BYTE (8-bit) format, but because ITextRange.GetText returns a string, the Rich Text Format (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 Rich Text Format (RTF) readers only understand bytes.
UseLf 16777216

Use line feed (LF) in place of all carriage returns.

Remarks

If both UseLf and UseCrLf are used an invalid argument exception is thrown.

Version history

Windows version SDK version Value added
1703 15063 UseLf

Applies to

See also