Share via

TextPredictionGenerator Class

  • Reference

Definition

Namespace:
Windows.Data.Text
Edit

Predicts Japanese words based on a phonetic characters prefix.

public ref class TextPredictionGenerator sealed
/// [Windows.Foundation.Metadata.Activatable(Windows.Data.Text.ITextPredictionGeneratorFactory, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Experimental]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TextPredictionGenerator final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(Windows.Data.Text.ITextPredictionGeneratorFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class TextPredictionGenerator final
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Data.Text.ITextPredictionGeneratorFactory), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Experimental]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class TextPredictionGenerator
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Data.Text.ITextPredictionGeneratorFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class TextPredictionGenerator
function TextPredictionGenerator(languageTag)
Public NotInheritable Class TextPredictionGenerator
Inheritance
Object Platform::Object IInspectable TextPredictionGenerator
Attributes
ActivatableAttribute ContractVersionAttribute ExperimentalAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Version history

Windows version SDK version Value added
1809 17763 GetCandidatesAsync(String,UInt32,TextPredictionOptions,IEnumerable<String>)
1809 17763 GetNextWordCandidatesAsync
1809 17763 InputScope

Constructors

TextPredictionGenerator(String)

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

Properties

InputScope

Gets or sets the input scope for text prediction.
LanguageAvailableButNotInstalled

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

Gets the language tag of the successfully created TextPredictionGenerator object.

Methods

GetCandidatesAsync(String, UInt32, TextPredictionOptions, IIterable<String>)

Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix and options.
GetCandidatesAsync(String, UInt32)

Asynchronously retrieves a list of candidate words, up to a maximum count, based on the provided phonetic characters prefix.
GetCandidatesAsync(String)

Asynchronously retrieves a list of candidate words based on the provided phonetic characters prefix.
GetNextWordCandidatesAsync(UInt32, IIterable<String>)

Asynchronously retrieves a collection of strings containing next-word-prediction candidates.

Applies to

See also