TextConversionGenerator TextConversionGenerator TextConversionGenerator TextConversionGenerator Class

Definition

Converts input phonetic characters into a collection of corresponding ideographic characters (Chinese characters).

Input of Japanese and Chinese Pinyin is supported.

public : sealed class TextConversionGenerator : ITextConversionGeneratorpublic sealed class TextConversionGenerator : ITextConversionGeneratorPublic NotInheritable Class TextConversionGenerator Implements ITextConversionGenerator// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Constructors

TextConversionGenerator(String) TextConversionGenerator(String) TextConversionGenerator(String) TextConversionGenerator(String)

Constructs a TextConversionGenerator object based on a specific BCP-47 language tag.

public : TextConversionGenerator(PlatForm::String languageTag)public TextConversionGenerator(String languageTag)Public Sub New(languageTag As String)// You can use this method in JavaScript.
Parameters
languageTag
PlatForm::String String String String

The BCP-47 language tag of the language in which the words are to be projected. Japanese ("ja") and Simplified Chinese ("zh-Hans") are supported.

Properties

LanguageAvailableButNotInstalled LanguageAvailableButNotInstalled LanguageAvailableButNotInstalled LanguageAvailableButNotInstalled

Determines if the language tag specified is available for conversions, but is not installed on the user's device.

public : PlatForm::Boolean LanguageAvailableButNotInstalled { get; }public bool LanguageAvailableButNotInstalled { get; }Public ReadOnly Property LanguageAvailableButNotInstalled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if the language is available but not installed.

ResolvedLanguage ResolvedLanguage ResolvedLanguage ResolvedLanguage

Gets the language tag of the successfully created TextConversionGenerator object.

public : PlatForm::String ResolvedLanguage { get; }public string ResolvedLanguage { get; }Public ReadOnly Property ResolvedLanguage As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The BCP-47 language tag of the conversion generator.

Methods

GetCandidatesAsync(String) GetCandidatesAsync(String) GetCandidatesAsync(String) GetCandidatesAsync(String)

Asynchronously gets a list of candidate words based on the provided phonetic characters.

public : IAsyncOperation<IVectorView<PlatForm::String>> GetCandidatesAsync(PlatForm::String input)public IAsyncOperation<IReadOnlyList<string>> GetCandidatesAsync(String input)Public Function GetCandidatesAsync(input As String) As IAsyncOperation( Of IReadOnlyListstring )// You can use this method in JavaScript.
Parameters
input
PlatForm::String String String String

The phonetic characters of the words to be returned.

Returns
IAsyncOperation<IVectorView<PlatForm::String>> IAsyncOperation<IReadOnlyList<string>> IAsyncOperation<IReadOnlyList<string>> IAsyncOperation<IReadOnlyList<string>>

An asynchronous operation to return an IVectorView of the list of candidate words.

See Also

GetCandidatesAsync(String, UInt32) GetCandidatesAsync(String, UInt32) GetCandidatesAsync(String, UInt32) GetCandidatesAsync(String, UInt32)

Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters.

public : IAsyncOperation<IVectorView<PlatForm::String>> GetCandidatesAsync(PlatForm::String input, unsigned int maxCandidates)public IAsyncOperation<IReadOnlyList<string>> GetCandidatesAsync(String input, UInt32 maxCandidates)Public Function GetCandidatesAsync(input As String, maxCandidates As UInt32) As IAsyncOperation( Of IReadOnlyListstring )// You can use this method in JavaScript.
Parameters
input
PlatForm::String String String String

The phonetic characters of the words to be returned.

maxCandidates
unsigned int UInt32 UInt32 UInt32

The maximum number of candidate words to return.

Returns
IAsyncOperation<IVectorView<PlatForm::String>> IAsyncOperation<IReadOnlyList<string>> IAsyncOperation<IReadOnlyList<string>> IAsyncOperation<IReadOnlyList<string>>

An asynchronous operation to return an IVectorView of the list of candidate words.

See Also