Share via


CandidateWindowAlignment Enum

Definition

Defines constants that specify how the Input Method Editor (IME) window for text predictions is aligned with a text edit control.

public enum class CandidateWindowAlignment
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class CandidateWindowAlignment
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum CandidateWindowAlignment
Public Enum CandidateWindowAlignment
<object property="enumMemberName"/>
Inheritance
CandidateWindowAlignment
Attributes

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
Default 0

When the hardware keyboard is used, the Input Method Editor (IME) follows the cursor. When the Soft Input Panel (SIP) is used, the Input Method Editor (IME) is docked to the Soft Input Panel (SIP).

BottomEdge 1

When the hardware keyboard is used, the Input Method Editor (IME) aligns to the bottom edge and left side of the text edit control. When the Soft Input Panel (SIP) is used, the Input Method Editor (IME) is docked to the Soft Input Panel (SIP).

Remarks

This enumeration is used by the TextBox.DesiredCandidateWindowAlignment and RichEditBox.DesiredCandidateWindowAlignment properties.

Applies to