UITextDocumentProxy UITextDocumentProxy Class

Definition

Namespace:
UIKit UIKit
Assembly:
Xamarin.iOS.dll

Protocol that provides text context to a custom keyboard before and after the insertion point.

[Foundation.Protocol]
[Foundation.Register("UITextDocumentProxy", false)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
public abstract class UITextDocumentProxy : Foundation.NSObject, IDisposable, UIKit.IUITextDocumentProxy
type UITextDocumentProxy = class
    inherit NSObject
    interface IUITextDocumentProxy
    interface INativeObject
    interface IDisposable
    interface IUIKeyInput
    interface IUITextInputTraits
Inheritance
ObjectObject
NSObjectNSObject
UITextDocumentProxyUITextDocumentProxy
Attributes
ProtocolAttribute RegisterAttribute IntroducedAttribute UnavailableAttribute
Implements
INativeObjectINativeObject IDisposableIDisposable IUIKeyInputIUIKeyInput IUITextDocumentProxyIUITextDocumentProxy IUITextInputTraitsIUITextInputTraits

Constructors

UITextDocumentProxy() UITextDocumentProxy()

Default constructor, initializes a new instance of this class.
UITextDocumentProxy(IntPtr) UITextDocumentProxy(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
UITextDocumentProxy(NSObjectFlag) UITextDocumentProxy(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AutocapitalizationType AutocapitalizationType

Gets or sets automatic capitalization for this this UITextDocumentProxy object.
AutocorrectionType AutocorrectionType

Gets or sets the automatic correction for this UITextDocumentProxy object.
Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

(Inherited from NSObject)
DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
DocumentContextAfterInput DocumentContextAfterInput

Gets the textual context after the insertion point for this UITextDocumentProxy object.
DocumentContextBeforeInput DocumentContextBeforeInput

Gets the textual context before the insertion point for this UITextDocumentProxy object.
DocumentIdentifier DocumentIdentifier

Returns the unique ID for the document.
DocumentInputMode DocumentInputMode

Gets the UITextInputMode of the keyboard.
EnablesReturnKeyAutomatically EnablesReturnKeyAutomatically

Gets or sets whether to automatically enable the return key when the user enters text.
Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
HasText HasText

Gets whether this UITextDocumentProxy object has any text.
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
KeyboardAppearance KeyboardAppearance

Gets or sets the UIKeyboardAppearance for this UITextDocumentProxy object.
KeyboardType KeyboardType

Gets or sets the UIKeyboardType for this UITextDocumentProxy object.
PasswordRules PasswordRules

Gets or sets the password rules for entering passwords in the UITextView.
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
ReturnKeyType ReturnKeyType

Gets or sets the UIReturnKeyType for this UITextDocumentProxy object.
SecureTextEntry SecureTextEntry

Gets or sets whether this UITextDocumentProxy object hides entered text.
SelectedText SelectedText

Gets the selected text.
Self Self Inherited from NSObject
SmartDashesType SmartDashesType

Gets or sets a value that controls when conversion between hyphens, en dashes, and em dashes.
SmartInsertDeleteType SmartInsertDeleteType

Gets or sets a value that controls how leading and trailing spaces are treated during inserts and deletes.
SmartQuotesType SmartQuotesType

Gets or sets a value that controls smart quotes behavior.
SpellCheckingType SpellCheckingType

Gets or sets the UITextSpellCheckingType for this UITextDocumentProxy object.
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
TextContentType TextContentType

A hint of the type of data the field should contain (must be value from UITextContentType).
Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AdjustTextPositionByCharacterOffset(nint) AdjustTextPositionByCharacterOffset(nint)

Changes the text position by offset. Positive values are toward the end of the document; Negative values are toward the start.
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DeleteBackward() DeleteBackward()

Deletes the character before the insertion point.
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
InsertText(String) InsertText(String)

Inserts a character into the text of this UITextDocumentProxy object.
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.
GetDocumentIdentifier(IUITextDocumentProxy) GetDocumentIdentifier(IUITextDocumentProxy)

Returns the unique ID for the document.
GetDocumentInputMode(IUITextDocumentProxy) GetDocumentInputMode(IUITextDocumentProxy)

Returns the keyboard input mode.
GetSelectedText(IUITextDocumentProxy) GetSelectedText(IUITextDocumentProxy)

Returns the selected text.
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

See also