Share via


HandwritingView.SelectCandidate(UInt32, UInt32) Method

Definition

Retrieves the auto-completion candidate selected by the user.

public:
 virtual void SelectCandidate(unsigned int candidatesSessionId, unsigned int selectedCandidateIndex) = SelectCandidate;
void SelectCandidate(uint32_t const& candidatesSessionId, uint32_t const& selectedCandidateIndex);
public void SelectCandidate(uint candidatesSessionId, uint selectedCandidateIndex);
function selectCandidate(candidatesSessionId, selectedCandidateIndex)
Public Sub SelectCandidate (candidatesSessionId As UInteger, selectedCandidateIndex As UInteger)

Parameters

candidatesSessionId
UInt32

unsigned int

uint32_t

The current auto-completion CandidatesSessionId.

selectedCandidateIndex
UInt32

unsigned int

uint32_t

The index of the auto-completion candidate selected by the user from the candidate collection.

Windows requirements

Device family
Windows 10, version 2104 (introduced in 10.0.20348.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v12.0)

Remarks

A candidate is selected only if the CandidatesSessionId is current.

Applies to