TextCompositionSegment Class

Definition

Namespace:

Windows.UI.Input.Preview.Text

Important

The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token.

Note

To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info.

The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.

public ref class TextCompositionSegment sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.UI.Input.Preview.Text.PreviewTextContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class TextCompositionSegment final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.UI.Input.Preview.Text.PreviewTextContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class TextCompositionSegment

Public NotInheritable Class TextCompositionSegment

Inheritance

Object Platform::Object IInspectable TextCompositionSegment

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Requirements	Description
Device family	Windows Desktop Extension SDK (introduced in 10.0.26100.0)
API contract	Windows.UI.Input.Preview.Text.PreviewTextContract (introduced in v1.0)

Properties

Name	Description
ConversionState	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.
ConvertedText	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.
Next	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.
Previous	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.
Range	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.
Text	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.
UnconvertedText	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.

Methods

Name	Description
GetTextStyle()	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.
SetTextStyle(TextStyle)	Important The Windows.UI.Input.Preview.Text APIs are part of a Limited Access Feature (see LimitedAccessFeatures class). Use the LAF Access Token Request Form to request an unlock token. Note To use this API in a Windows app being published to the Windows Store, you must declare the Text Input Method custom capability (Microsoft.appCategory.textInputMethod_8wekyb3d8bbwe) and request approval during the app submission process. See Custom capabilities for more info. The Text Input Method capability enables several advanced features related to text input, including events for input focus (determining when to enter and exit) and the ability to read and write text within the current input focus's edit control.