Class

UILexicon

A read-only array of term pairs, each in a lexicon entry object, for use by a custom keyboard.

Declaration

@interface UILexicon : NSObject

Overview

To obtain the lexicon, call the requestSupplementaryLexiconWithCompletion: method of the UIInputViewController class. This method can be called only from a custom keyboard app extension. A lexicon contains words from various sources, including:

  • Unpaired first names and last names from the user’s Address Book database

  • Text shortcuts defined in the Settings > General > Keyboard > Shortcuts list

  • A common words dictionary

Apple intends for you to consider the words in a lexicon object as supplementary to an autocorrection/suggestion lexicon of your own design. For information on custom keyboards, see Custom Keyboard in App Extension Programming Guide.

Topics

Accessing the Lexicon

entries

A read-only array of term pairs for use by a custom keyboard.

Relationships

Inherits From

Conforms To

See Also

Custom Keyboard

UITextDocumentProxy

An object that provides textual context to a custom keyboard.

UIInputViewAudioFeedback

A property that enables a custom input or keyboard accessory view to play standard keyboard input clicks.

UIInputViewController

The primary view controller for a custom keyboard app extension.

UILexiconEntry

A read-only term pair, available within a lexicon object, for use by a custom keyboard.