TextReverseConversionGenerator TextReverseConversionGenerator TextReverseConversionGenerator TextReverseConversionGenerator Class

Definition

Reverse-converts a Japanese string which is mix of phonetic and ideographic characters, to a string of phonetic characters.

public : sealed class TextReverseConversionGenerator : ITextReverseConversionGenerator, ITextReverseConversionGenerator2public sealed class TextReverseConversionGenerator : ITextReverseConversionGenerator, ITextReverseConversionGenerator2Public NotInheritable Class TextReverseConversionGenerator Implements ITextReverseConversionGenerator, ITextReverseConversionGenerator2// 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

TextReverseConversionGenerator(String) TextReverseConversionGenerator(String) TextReverseConversionGenerator(String) TextReverseConversionGenerator(String)

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

public : TextReverseConversionGenerator(PlatForm::String languageTag)public TextReverseConversionGenerator(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 reverse-converted. Only Japanese ("ja") is supported.

Properties

LanguageAvailableButNotInstalled LanguageAvailableButNotInstalled LanguageAvailableButNotInstalled LanguageAvailableButNotInstalled

Determines if the language tag specified is available for reverse 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 TextReverseConversionGenerator 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 reverse conversion generator.

Methods

ConvertBackAsync(String) ConvertBackAsync(String) ConvertBackAsync(String) ConvertBackAsync(String)

Asynchronously reverse-converts a string which contains ideographic characters to a phonetic expression.

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

The string containing ideographic characters to be reverse-converted.

Returns

An asynchronous operation to return the phonetic expression.

GetPhonemesAsync(String) GetPhonemesAsync(String) GetPhonemesAsync(String) GetPhonemesAsync(String)

Returns a set of phonemes representing the given input string. This method is primarily intended for use in sorting data in the Japanese language. Phonetic reading is important for Japanese data handling, especially to sort names in proper phonetic order rather than in character code point order.

Proper names in Japanese that sound the same when pronounced can be spelled in different ways in Kanji. The point of sorting by phonemes is to sort all of the different Kanji spellings of a given proper name to be next to each other in a sorted list, rather than sorting them by character code point and having the various spellings not sorting next to each other.

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

A string containing words in Japanese.

Returns
IAsyncOperation<IVectorView<TextPhoneme>> IAsyncOperation<IReadOnlyList<TextPhoneme>> IAsyncOperation<IReadOnlyList<TextPhoneme>> IAsyncOperation<IReadOnlyList<TextPhoneme>>

On successful completion of the async operation, a list of TextPhoneme objects representing the input string in phoneme form.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Each TextPhoneme in the result list has the following properties.

  • The DisplayText always matches a segment of the input string.
  • For Japanese input, the ReadingText is the Hiragana-based reading of the display text.
  • If the system cannot generate a reading, then it reports the ReadingText as being the same as the DisplayText.