TextBox.DesiredCandidateWindowAlignment Property


Gets or sets a value that indicates the preferred alignment of the Input Method Editor (IME).

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.TextBox.DesiredCandidateWindowAlignment.

 property CandidateWindowAlignment DesiredCandidateWindowAlignment { CandidateWindowAlignment get(); void set(CandidateWindowAlignment value); };
CandidateWindowAlignment DesiredCandidateWindowAlignment();

void DesiredCandidateWindowAlignment(CandidateWindowAlignment value);
public CandidateWindowAlignment DesiredCandidateWindowAlignment { get; set; }
var candidateWindowAlignment = textBox.desiredCandidateWindowAlignment;
textBox.desiredCandidateWindowAlignment = candidateWindowAlignment;
Public Property DesiredCandidateWindowAlignment As CandidateWindowAlignment
<TextBox DesiredCandidateWindowAlignment="candidateWindowAlignmentMemberName"/>

Property Value


A value of the enumeration that indicates the preferred alignment of the Input Method Editor (IME). The default is Default.


Users sometimes enter text through an Input Method Editor (IME) that shows in a window just below a text input box (typically for East Asian languages). The Input Method Editor (IME) window can cover important parts of your app UI that the user might need to see while entering text. Use the DesiredCandidateWindowAlignment property to specify a preferred placement of the Input Method Editor (IME) window in relation to the text input box.

By default, when the hardware keyboard is used, the Input Method Editor (IME) follows the cursor. You can set DesiredCandidateWindowAlignment to BottomEdge to align the Input Method Editor (IME) to the bottom edge and left side of the text edit control.

When the Soft Input Panel (SIP) is used, DesiredCandidateWindowAlignment doesn't have any effect. The Input Method Editor (IME) remains docked to the Soft Input Panel (SIP) whenever the Soft Input Panel (SIP) is used.

You can also handle the CandidateWindowBoundsChanged event to adapt your UI to the placement of the Input Method Editor (IME).

Applies to

See also