IUITextInput IUITextInput Interface


IUITextInput works with the inputting of text and allows the manipulaton of features including autocorrection and many other text input features related to document presentation.

[Foundation.Protocol(Name="UITextInput", WrapperType=typeof(UIKit.UITextInputWrapper))]
public interface IUITextInput : IDisposable, UIKit.IUIKeyInput
type IUITextInput = interface
    interface INativeObject
    interface IDisposable
    interface IUIKeyInput
    interface IUITextInputTraits


AutocapitalizationType AutocapitalizationType

The UITextAutocapitalizationType used by the IUITextInput.

(Inherited from IUITextInputTraits)
AutocorrectionType AutocorrectionType

The UITextAutocorrectionType used by the IUITextInput.

(Inherited from IUITextInputTraits)
BeginningOfDocument BeginningOfDocument

The position of text indicating the beginning of a document.

EnablesReturnKeyAutomatically EnablesReturnKeyAutomatically

Whether the return key is automatically enabled.

(Inherited from IUITextInputTraits)
EndOfDocument EndOfDocument

The position of text indicating the beginning of a document.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from INativeObject)
HasText HasText

Gets a value that tells whether the key input has text in it.

(Inherited from IUIKeyInput)
KeyboardAppearance KeyboardAppearance

The UIKeyboardAppearance used by the IUITextInput

(Inherited from IUITextInputTraits)
KeyboardType KeyboardType

The UIKeyboardType used by the IUITextInput.

(Inherited from IUITextInputTraits)
MarkedTextRange MarkedTextRange

The currently marked range of text in a given document.

MarkedTextStyle MarkedTextStyle

Attribute dictionary describing how text should be drawn.

ReturnKeyType ReturnKeyType

The form of the return key for the IUITextInput.

(Inherited from IUITextInputTraits)
SecureTextEntry SecureTextEntry

Whether the entered text should be hidden.

(Inherited from IUITextInputTraits)
SelectedTextRange SelectedTextRange

The range of a document's selected text.

SpellCheckingType SpellCheckingType

Gets or sets a value that tells whether spell-checking is on, off, or if spell-checking will be enabled only when auto-complete is enabled (default).

(Inherited from IUITextInputTraits)
WeakInputDelegate WeakInputDelegate

Indicates a weak input delegate.

WeakTokenizer WeakTokenizer

Indicates a weak tokenizer.


ComparePosition(UITextPosition, UITextPosition) ComparePosition(UITextPosition, UITextPosition)

Gets a comparison of one position to another.

DeleteBackward() DeleteBackward() Inherited from IUIKeyInput
GetBaseWritingDirection(UITextPosition, UITextStorageDirection) GetBaseWritingDirection(UITextPosition, UITextStorageDirection)

Gets the base writing direction for a text position.

GetCaretRectForPosition(UITextPosition) GetCaretRectForPosition(UITextPosition)

A rectangle used for drawing a caret at a given insertion point.

GetCharacterRange(UITextPosition, UITextLayoutDirection) GetCharacterRange(UITextPosition, UITextLayoutDirection)

Gets a character range within the limits of a defined direction.

GetCharacterRangeAtPoint(CGPoint) GetCharacterRangeAtPoint(CGPoint)

Gets the character or a range of characters in a document that exists at a given point.

GetClosestPositionToPoint(CGPoint) GetClosestPositionToPoint(CGPoint)

Gets the closest position in a document that exists to a given point.

GetClosestPositionToPoint(CGPoint, UITextRange) GetClosestPositionToPoint(CGPoint, UITextRange)
GetFirstRectForRange(UITextRange) GetFirstRectForRange(UITextRange)

Gets the first rectangle enclosing a specified range of document text.

GetOffsetFromPosition(UITextPosition, UITextPosition) GetOffsetFromPosition(UITextPosition, UITextPosition)

Gets the number of visible characters between two defined text positions.

GetPosition(UITextPosition, nint) GetPosition(UITextPosition, nint)

Gets the character offset from the initial position.

GetPosition(UITextPosition, UITextLayoutDirection, nint) GetPosition(UITextPosition, UITextLayoutDirection, nint)

Gets the character offset from an initial position.

GetPositionWithinRange(UITextRange, UITextLayoutDirection) GetPositionWithinRange(UITextRange, UITextLayoutDirection)

Gets a position within a specified range.

GetSelectionRects(UITextRange) GetSelectionRects(UITextRange)

Gets an array of selection rects that corresponds to a text range.

GetTextRange(UITextPosition, UITextPosition) GetTextRange(UITextPosition, UITextPosition)

Gets a specified text range.

InsertText(String) InsertText(String)

Inserts text at the cursor.

(Inherited from IUIKeyInput)
ReplaceText(UITextRange, String) ReplaceText(UITextRange, String)

Replaces document text within a specified range.

SetBaseWritingDirectionforRange(UITextWritingDirection, UITextRange) SetBaseWritingDirectionforRange(UITextWritingDirection, UITextRange)

Sets a base directon for writing in the specified range of text.

SetMarkedText(String, NSRange) SetMarkedText(String, NSRange)

Sets the marked text and marks it as the current selection.

TextInRange(UITextRange) TextInRange(UITextRange)

Gets all the text that is specified within a certain range.

UnmarkText() UnmarkText()

Unmarks all currently marked text within a document

Extension Methods

BeginFloatingCursor(IUITextInput, CGPoint) BeginFloatingCursor(IUITextInput, CGPoint)

Begins displaying the floating cursor at the specified point.

DictationRecognitionFailed(IUITextInput) DictationRecognitionFailed(IUITextInput)

The recognition of dictation failed.

DictationRecordingDidEnd(IUITextInput) DictationRecordingDidEnd(IUITextInput)

The recording of dictation ended.

EndFloatingCursor(IUITextInput) EndFloatingCursor(IUITextInput)

Ends display of the floating cursor.

GetCharacterOffsetOfPosition(IUITextInput, UITextPosition, UITextRange) GetCharacterOffsetOfPosition(IUITextInput, UITextPosition, UITextRange)

Calculates and returns the offset into range of the character that is in position in the document.

GetFrameForDictationResultPlaceholder(IUITextInput, NSObject) GetFrameForDictationResultPlaceholder(IUITextInput, NSObject)

Returns the rectangle in which to display the animated dictation result placeholder.

GetPosition(IUITextInput, UITextRange, nint) GetPosition(IUITextInput, UITextRange, nint)

Calculates and returns the absolute position in the document that is atCharacterOffset characters into withinRange.

GetSelectionAffinity(IUITextInput) GetSelectionAffinity(IUITextInput)

Stops displaying the floating cursor.

GetTextInputView(IUITextInput) GetTextInputView(IUITextInput)

Returns the input view that provides the coordinate system for geometric operations within the text input.

GetTextStyling(IUITextInput, UITextPosition, UITextStorageDirection) GetTextStyling(IUITextInput, UITextPosition, UITextStorageDirection)

Returns a dictionary of style properties for text at the atPosition position.

InsertDictationResult(IUITextInput, NSArray) InsertDictationResult(IUITextInput, NSArray)

Inserts a dictation result at the current position.

InsertDictationResultPlaceholder(IUITextInput) InsertDictationResultPlaceholder(IUITextInput)

Returns the placeholder object to use before dictation results are finished being generated.

RemoveDictationResultPlaceholder(IUITextInput, NSObject, Boolean) RemoveDictationResultPlaceholder(IUITextInput, NSObject, Boolean)

The placeholder is no longer needed.

SetSelectionAffinity(IUITextInput, UITextStorageDirection) SetSelectionAffinity(IUITextInput, UITextStorageDirection)

Sets a value that controls whether the cursor is displayed at the start of the last line or end of the second-to-last line of a multiline selection.

ShouldChangeTextInRange(IUITextInput, UITextRange, String) ShouldChangeTextInRange(IUITextInput, UITextRange, String)

Asks whether the text in inRange should be replaced with replacementText.

UpdateFloatingCursor(IUITextInput, CGPoint) UpdateFloatingCursor(IUITextInput, CGPoint)

Moves the floating curor to the specified point.

GetPasswordRules(IUITextInputTraits) GetPasswordRules(IUITextInputTraits)

Returns the password entry rules.

GetSmartDashesType(IUITextInputTraits) GetSmartDashesType(IUITextInputTraits)

Gets the smart dashes style.

GetSmartInsertDeleteType(IUITextInputTraits) GetSmartInsertDeleteType(IUITextInputTraits)

Gets the smart insert style.

GetSmartQuotesType(IUITextInputTraits) GetSmartQuotesType(IUITextInputTraits)

Gets the smart quotes style.

GetTextContentType(IUITextInputTraits) GetTextContentType(IUITextInputTraits)

Gets the semantic of the expected input, which allows the system to, for example, provide custom keyboards.

SetPasswordRules(IUITextInputTraits, UITextInputPasswordRules) SetPasswordRules(IUITextInputTraits, UITextInputPasswordRules)

Sets the password entry rules.

SetSmartDashesType(IUITextInputTraits, UITextSmartDashesType) SetSmartDashesType(IUITextInputTraits, UITextSmartDashesType)

Sets the style for smart dashes.

SetSmartInsertDeleteType(IUITextInputTraits, UITextSmartInsertDeleteType) SetSmartInsertDeleteType(IUITextInputTraits, UITextSmartInsertDeleteType)

Sets the style for smart insertion.

SetSmartQuotesType(IUITextInputTraits, UITextSmartQuotesType) SetSmartQuotesType(IUITextInputTraits, UITextSmartQuotesType)

Sets the style for smart quotes.

SetTextContentType(IUITextInputTraits, NSString) SetTextContentType(IUITextInputTraits, NSString)

Sets the semantic of the expected input, which allows the system to, for example, provide custom keyboards.

Applies to