UISearchBar Class

Definition

A UIView that displays a search bar.

[Foundation.Register("UISearchBar", true)]
public class UISearchBar : UIKit.UIView, IDisposable, UIKit.IUIBarPositioning, UIKit.IUITextInputTraits
type UISearchBar = class
    inherit UIView
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface IUIBarPositioning
    interface IUITextInputTraits
Inheritance
Attributes
Implements

Remarks

The Xamarin API supports two styles of event notification: the Objective-C style that uses a delegate class or the C# style using event notifications.

The C# style allows the user to add or remove event handlers at runtime by assigning to the events of properties of this class. Event handlers can be anyone of a method, an anonymous methods or a lambda expression. Using the C# style events or properties will override any manual settings to the Objective-C Delegate or WeakDelegate settings.

The Objective-C style requires the user to create a new class derived from UISearchBarDelegate class and assign it to the P:UIKit.Delegate property. Alternatively, for low-level control, by creating a class derived from NSObject which has every entry point properly decorated with an [Export] attribute. The instance of this object can then be assigned to the WeakDelegate property.

Constructors

UISearchBar()

Default constructor that initializes a new instance of this class with no parameters.

UISearchBar(CGRect)

Initializes the UISearchBar with the specified frame.

UISearchBar(IntPtr)

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

UISearchBar(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

UISearchBar(NSObjectFlag)

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

Properties

AccessibilityActivationPoint

The screen coordinates for the accessibility element.

(Inherited from UIView)
AccessibilityAssistiveTechnologyFocusedIdentifiers (Inherited from UIResponder)
AccessibilityAttributedHint

An attributed string providing a brief description of the behavior of the accessibility element.

(Inherited from UIView)
AccessibilityAttributedLabel

A brief attributed string describing the purpose of the UIView.

(Inherited from UIView)
AccessibilityAttributedValue

An attributed string holding the value of the UIView, when it is different than the AccessibilityAttributedLabel.

(Inherited from UIView)
AccessibilityCustomActions

Allows methods to be added to AccessibilityCustomActions as accessibility-supporting supplementary actions.

(Inherited from UIResponder)
AccessibilityDragSourceDescriptors (Inherited from UIResponder)
AccessibilityDropPointDescriptors (Inherited from UIResponder)
AccessibilityElementsHidden

Whether the view's accessibility elements are visible.

(Inherited from UIView)
AccessibilityFrame

The Frame of the accessibility element, in screen coordinates.

(Inherited from UIView)
AccessibilityHint

A brief description of the action performed by the accessibility element.

(Inherited from UIView)
AccessibilityIdentifier

Uniquely identifies this for the purposes of accessibility.

(Inherited from UIView)
AccessibilityIgnoresInvertColors

Gets or sets whether the UIView will invert its colors in response to such an accessibility request.

(Inherited from UIView)
AccessibilityLabel

A localized identifier for the accessibility element.

(Inherited from UIView)
AccessibilityLanguage

The BCP 47 language tag of the language used to speak the accessibility element's components.

(Inherited from UIView)
AccessibilityNavigationStyle

Gets or sets the navigation style.

(Inherited from UIView)
AccessibilityPath

Allows the accessibility element to be non-rectangular.

(Inherited from UIView)
AccessibilityTraits

A bitmask of the UIAccessibilityTraits of this.

(Inherited from UIView)
AccessibilityValue

The value of the accessibility element.

(Inherited from UIView)
AccessibilityViewIsModal

Whether Voice Over should ignore sibling elements.

(Inherited from UIView)
AlignmentRectInsets

Adjustments to the Frame for use with Auto Layout.

(Inherited from UIView)
Alpha

Controls the transparency (alpha) value for the view.

(Inherited from UIView)
Appearance

Strongly-typed property that returns the UIAppearance class for this class.

AutocapitalizationType

The autocapitalization style used on the text.

AutocorrectionType

The autocorrection style used on the text.

AutoresizingMask

A bitmask that specifies how the receiver should resize itself when its super-view's bounds change.

(Inherited from UIView)
AutosizesSubviews

Specifies whether the receiver should automatically resize its Subviews when the receiver's Bounds change.

(Inherited from UIView)
BackgroundColor

Sets the background color of the UIView.

(Inherited from UIView)
BackgroundImage

The UIImage shown in the background of the search bar.

BarPosition

Gets the UIBarPosition of this UISearchBar view.

BarStyle

The appearance of this UISearchBar.

BarTintColor

The tint applied to the background of this UISearchBar.

BottomAnchor

The NSLayoutYAxisAnchor that defines the bottom of this UIView.

(Inherited from UIView)
Bounds

The usable frame of the view, specified using the view's own coordinate system.

(Inherited from UIView)
CanBecomeFirstResponder

Determines whether this UIREsponder is willing to become the first responder.

(Inherited from UIResponder)
CanBecomeFocused

Whether this UIView can become the focused view.

(Inherited from UIView)
CanResignFirstResponder

Determines whether this UIResponder is willing to give up its first responder status.

(Inherited from UIResponder)
Center

The center of the view, in the container coordinate space.

(Inherited from UIView)
CenterXAnchor

The NSLayoutXAxisAnchor that defines the X-axis center of this UIView.

(Inherited from UIView)
CenterYAnchor

The NSLayoutYAxisAnchor that defines the Y-axis center of this UIView.

(Inherited from UIView)
Class (Inherited from NSObject)
ClassHandle

The handle for this class.

ClearsContextBeforeDrawing

Specifies that the drawing buffer be erased prior to calling DrawRect(CGRect, UIViewPrintFormatter)

(Inherited from UIView)
ClipsToBounds

Specifies whether the Subviews are confined to the Bounds of the receiver.

(Inherited from UIView)
CollisionBoundingPath

Gets the UIBezierPath to be used for collision detection.

(Inherited from UIView)
CollisionBoundsType

Gets the UIDynamicItemCollisionBoundsType describing the type of bounds used for collision detected.

(Inherited from UIView)
Constraints

The constraints used by Auto Layout on this UIView.

(Inherited from UIView)
ContentMode

Controls how the cached bitmap of a view must be rendered when the view's bounds change.

(Inherited from UIView)
ContentScaleFactor

The number of device pixels per logical coordinate point.

(Inherited from UIView)
ContentStretch

Developers should not use this deprecated property. Developers should use 'CreateResizableImage' instead.

(Inherited from UIView)
CoordinateSpace

Returns the coordinate space implemenation for the UIView.

(Inherited from UIView)
DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Delegate

An instance of the UIKit.IUISearchBarDelegate model class which acts as the class delegate.

Description

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

(Inherited from NSObject)
DirectionalLayoutMargins

Gets or sets the layout margins for laying out content that respects the current language direction.

(Inherited from UIView)
EffectiveUserInterfaceLayoutDirection

Gets the layout direction for arranging the view's contents.

(Inherited from UIView)
EnablesReturnKeyAutomatically

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

ExclusiveTouch

Restricts the event delivery to this view.

(Inherited from UIView)
FirstBaselineAnchor

A NSLayoutYAxisAnchor that defines a constraint based on the baseline of the first line of text in this UIView.

(Inherited from UIView)
Focused

Whether the UIView is the focused view.

(Inherited from UIView)
FocusItemContainer

Gets the focus container that provides spatial information to child focus items.

(Inherited from UIView)
Frame

Coordinates of the view relative to its container.

(Inherited from UIView)
GestureRecognizers

The array of UIGestureRecognizers for this UIView.

(Inherited from UIView)
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
HasAmbiguousLayout

Returns true if the Auto Layout for this UIView is ambiguous.

(Inherited from UIView)
HeightAnchor

The NSLayoutDimension that defines the height of this UIView.

(Inherited from UIView)
Hidden

Specifies whether the UIView displays or not.

(Inherited from UIView)
InputAccessoryView

The custom input accessory for the keyboard of this UISearchBar.

InputAccessoryViewController

Gets the custom accessory UIInputViewController to display when this UIResponder becomes the first responder.

(Inherited from UIResponder)
InputAssistantItem

Gets the assistant that will be used to configure the shortcut bar.

InputView

Custom view to display when the object becomes the first responder. Read-only.

(Inherited from UIResponder)
InputViewController

Gets the custom UIInputViewController to display when this UIResponder becomes the first responder.

(Inherited from UIResponder)
InsetsLayoutMarginsFromSafeArea

Gets or sets a Boolean value that controls whether margins are adjusted to always fall within the safe area. Default is true.

(Inherited from UIView)
Interactions

Gets or sets the current set of interactions.

(Inherited from UIView)
IntrinsicContentSize

The size of the intrinsic content of the UIView.

(Inherited from UIView)
IsAccessibilityElement

Whether this is an accessibility element.

(Inherited from UIView)
IsDirectBinding (Inherited from NSObject)
IsFirstResponder

Returns whether this UIResponder is the First Responder.

(Inherited from UIResponder)
IsProxy (Inherited from NSObject)
KeyboardAppearance

Gets or sets the appearance of the keyboard that is associated with this UISearchBar bar, as a UIKeyboardAppearance object.

KeyboardType

The keyboard style used for the text.

KeyCommands

The key commands that should trigger action on this UIResponder. Read-only.

(Inherited from UIResponder)
LastBaselineAnchor

A NSLayoutYAxisAnchor that defines a constraint based on the baseline of the first line of text in this UIView.

(Inherited from UIView)
Layer

The Core Animation layer used for rendering.

(Inherited from UIView)
LayoutGuides

The UILayoutGuide objects defined for this UIView.

(Inherited from UIView)
LayoutMargins

Lays out margins.

(Inherited from UIView)
LayoutMarginsGuide

Defines the margin attributes.

(Inherited from UIView)
LeadingAnchor

The NSLayoutXAxisAnchor that defines the leading edge of this UIView.

(Inherited from UIView)
LeftAnchor

The NSLayoutXAxisAnchor that defines the left edge of this UIView.

(Inherited from UIView)
MaskView

Returns mask view.

(Inherited from UIView)
MotionEffects

Current set of motion effects on this view.

(Inherited from UIView)
MultipleTouchEnabled

Controls whether the UIView can handle multitouch events.

(Inherited from UIView)
NextResponder

The next responder on the response chain

(Inherited from UIResponder)
Opaque

Determines whether the view is opaque or not.

(Inherited from UIView)
ParentFocusEnvironment

Gets the parent focus environment.

(Inherited from UIView)
PasswordRules

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

PasteConfiguration

The UIPasteConfiguration supported by this object.

(Inherited from UIResponder)
Placeholder

A string that is displayed when there is no other text in the text field.

PreferredFocusedView

Returns the UIView that should actually be focused.

(Inherited from UIView)
PreferredFocusEnvironments

An array of IUIFocusEnvironments that are recursively searched by the system to find the default focused view.

(Inherited from UIView)
PreservesSuperviewLayoutMargins

Preserves layout margins for superview.

(Inherited from UIView)
Prompt

A line of text displayed at the top of this UISearchBar.

ReadableContentGuide

An area that can be read by the user with minimal head moving.

(Inherited from UIView)
RestorationIdentifier

If not null, indicates that the UIView supports state preservation and restoration.

(Inherited from UIView)
RetainCount

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

(Inherited from NSObject)
ReturnKeyType

Gets or sets the UIReturnKeyType value for the return key that is associated with this UISearchBar bar.

RightAnchor

The NSLayoutXAxisAnchor that defines the right edge of this UIView.

(Inherited from UIView)
SafeAreaInsets

Gets the insets that place the content so that navigation and tab bars, toolbars, and other content does not obscure the view of the content.

(Inherited from UIView)
SafeAreaLayoutGuide

Gets the layout guide for placing the content so that navigation and tab bars, toolbars, and other content does not obscure the view of the content.

(Inherited from UIView)
ScopeBarBackgroundImage

The UIImage used for the background of the scope bar.

ScopeButtonTitles

The titles of the scope buttons.

SearchBarStyle

The style used for this UISearchBar's appearance.

SearchFieldBackgroundPositionAdjustment

The offset of the search text field background in this UISearchBar.

SearchResultsButtonSelected

Whether the search results button is selected.

SearchTextPositionAdjustment

The offset of the text in the search text field background.

SecureTextEntry

Gets or sets whether this UISearchBar bar hides the text that a user enters.

SelectedScopeButtonIndex

The index of the selected scope button.

Self (Inherited from NSObject)
SemanticContentAttribute

Specifies whether the UIView should maintain its layout or flip when used with a right-to-left layout.

(Inherited from UIView)
ShouldBeginEditing

Delegate invoked by the object to get a value.

ShouldChangeTextInRange

Delegate invoked by the object to get a value.

ShouldEndEditing

Delegate invoked by the object to get a value.

ShouldGroupAccessibilityChildren

Whether the UIView's children should be grouped for the purposes of voice-over, regardless of their position on the screen.

(Inherited from UIView)
ShowsBookmarkButton

Whether the bookmark button is displayed.

ShowsCancelButton

Whether the cancel button is displayed.

ShowsScopeBar

Whether the scope bar is displayed.

ShowsSearchResultsButton

Whether the search results button is displayed.

SmartDashesType

Gets or sets the style for smart dashes.

SmartInsertDeleteType

Gets or sets the strategy for smart insertions and deletions.

SmartQuotesType

Gets or sets the strategy for smart quotes.

SpellCheckingType

The UITextSpellCheckingType used on this UISearchBar.

Subviews

An array of UIViews that are contained within this UIView.

(Inherited from UIView)
Superclass (Inherited from NSObject)
SuperHandle

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

(Inherited from NSObject)
Superview

The UIView, if any, that contains this UIView in its Subviews.

(Inherited from UIView)
Tag

An integer that can be used to identify a specific UIView instance.

(Inherited from UIView)
Text

The current or starting search text.

TextContentType

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

TextInputContextIdentifier

An identifier indicating that this UIResponder should preserve its text input mode information. Read-only.

(Inherited from UIResponder)
TextInputMode

The text input mode for this UIResponder. Read-only.

(Inherited from UIResponder)
TintAdjustmentMode

The tint adjustment applied to this UIView or one of its parent views.

(Inherited from UIView)
TintColor

A highlight color which should be used to indicate interactive controls.

(Inherited from UIView)
TopAnchor

The NSLayoutYAxisAnchor that defines the top of this UIView.

(Inherited from UIView)
TrailingAnchor

The NSLayoutXAxisAnchor that defines the leading edge of this UIView.

(Inherited from UIView)
TraitCollection

Returns a trait collection.

(Inherited from UIView)
Transform

The transform of the UIView, relative to the center of its bounds.

(Inherited from UIView)
TranslatesAutoresizingMaskIntoConstraints

Specifies whether the autoresizing mask should be translated into constraints for Auto Layout.

(Inherited from UIView)
Translucent

True if the search bar is translucent.

UndoManager

The nearest shared NSUndoManager in the responder chain. Read-only.

(Inherited from UIResponder)
UserActivity

Action that encapsulates a user activity that is supported by this responder.

(Inherited from UIResponder)
UserInteractionEnabled

Determines whether input events are processed by this view.

(Inherited from UIView)
ViewForBaselineLayout

Returns the UIView upon which baseline constraints should be applied.

(Inherited from UIView)
ViewForFirstBaselineLayout

When overridden, allows the app dev to return a subview as the basis for baseline constraints.

(Inherited from UIView)
ViewForLastBaselineLayout

When overridden, allows the app dev to return a subview as the basis for baseline constraints.

(Inherited from UIView)
ViewPrintFormatter

Returns a UIViewPrintFormatter appropriate for the UIView.

(Inherited from UIView)
WeakDelegate

An object that can respond to the delegate protocol for this type

WidthAnchor

The NSLayoutDimension that defines the horizontal extent of this UIView.

(Inherited from UIView)
Window

The UIWindow of the UIView.

(Inherited from UIView)
Zone (Inherited from NSObject)

Methods

AccessibilityActivate()

Activates accessibility for this UIView, returning true on success.

(Inherited from UIView)
AccessibilityDecrement()

Tells the accessibility element to decrement the value of its content.

(Inherited from UIResponder)
AccessibilityElementDidBecomeFocused()

Indicates that an assistive technology has set its focus to this UIResponder.

(Inherited from UIResponder)
AccessibilityElementDidLoseFocus()

Indicates that an assistive technology has changed its focus from this UIResponder.

(Inherited from UIResponder)
AccessibilityElementIsFocused()

Indicates whether an assistive technology is focused on this UIResponder.

(Inherited from UIResponder)
AccessibilityIncrement()

Tells the accessibility element to increment the value of its content.

(Inherited from UIResponder)
AccessibilityPerformEscape()

Tells the accessibility system to dismiss a modal popover or hierarchically-displayed element.

(Inherited from UIResponder)
AccessibilityPerformMagicTap()

Toggles the application-defined "most important state" of the app.

(Inherited from UIResponder)
AccessibilityScroll(UIAccessibilityScrollDirection)

When overridden, allows the accessibility system to perform scrolling.

(Inherited from UIResponder)
ActionForLayer(CALayer, String)

Retrieves the default CAAction identified by that targets .

(Inherited from UIView)
Add(UIView)

This is an alias for AddSubview(UIView), but uses the Add pattern as it allows C# 3.0 constructs to add subviews after creating the object.

(Inherited from UIView)
AddConstraint(NSLayoutConstraint)

Adds a constraint to the layout of the receiving view or its subviews.

(Inherited from UIView)
AddConstraints(NSLayoutConstraint[])

Adds multiple constraints to the layout of the receiving view or its subviews.

(Inherited from UIView)
AddGestureRecognizer(UIGestureRecognizer)

Adds a gesture recognizer to this view.

(Inherited from UIView)
AddInteraction(IUIInteraction)

Adds the interaction to the view.

(Inherited from UIView)
AddLayoutGuide(UILayoutGuide)

Adds the specified guide, allowing for Autolayout control without creating dummy views.

(Inherited from UIView)
AddMotionEffect(UIMotionEffect)

Adds the specified motion effect to the view.

(Inherited from UIView)
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)

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>)

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

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

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

(Inherited from NSObject)
AddSubview(UIView)

Adds the specified view as a subview of this view.

(Inherited from UIView)
AddSubviews(UIView[])

Convenience routine to add various views to a UIView.

(Inherited from UIView)
AlignmentRectForFrame(CGRect)

Returns a customized alignment rectangle for Auto Layout.

(Inherited from UIView)
AppearanceWhenContainedIn(Type[])

Returns a strongly typed UIAppearance for instances of this class when the view is hosted in the specified hierarchy.

AwakeFromNib()

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

(Inherited from NSObject)
BackgroundImageForBarPosition(UIBarPosition, UIBarMetrics)

The UIImage used for the background for the specified position and metrics.

BecomeFirstResponder()

Request the object to become the first responder.

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

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)
Obsolete.
(Inherited from NSObject)
BindingInfo(String)
Obsolete.
(Inherited from NSObject)
BindingOptionDescriptions(String)
Obsolete.
(Inherited from NSObject)
BindingValueClass(String)
Obsolete.
(Inherited from NSObject)
BringSubviewToFront(UIView)

Moves the specified subview so that it appears in front of other Subviews.

(Inherited from UIView)
CanPaste(NSItemProvider[])

Gets whether this can accept a paste operation by the .

(Inherited from UIResponder)
CanPerform(Selector, NSObject)

Determines if this UIResponder can perform the specified action. Typically used to probe for editing commands.

(Inherited from UIResponder)
Capture(Boolean)

Performs a screen-capture of the UIView.

(Inherited from UIView)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
ContentCompressionResistancePriority(UILayoutConstraintAxis)

Returns the resistance of an axis to compression below its intrinsic size.

(Inherited from UIView)
ContentHuggingPriority(UILayoutConstraintAxis)

Returns the resistance of an axis to expansion larger than its intrinsic size.

(Inherited from UIView)
ConvertPointFromCoordinateSpace(CGPoint, IUICoordinateSpace)

Converts from the coordinate system to thisUIView object's coordinate system.

(Inherited from UIView)
ConvertPointFromView(CGPoint, UIView)

Converts from the coordinate system of to this object's coordinate system.

(Inherited from UIView)
ConvertPointToCoordinateSpace(CGPoint, IUICoordinateSpace)

Converts from this object's coordinate system to that of .

(Inherited from UIView)
ConvertPointToView(CGPoint, UIView)

Converts from this object's coordinate system to that of .

(Inherited from UIView)
ConvertRectFromCoordinateSpace(CGRect, IUICoordinateSpace)

Converts from the coordinate system of to that of this object.

(Inherited from UIView)
ConvertRectFromView(CGRect, UIView)

Converts from the coordinate system used in to that of this object.

(Inherited from UIView)
ConvertRectToCoordinateSpace(CGRect, IUICoordinateSpace)

Converts from this object's coordinate system to that described by .

(Inherited from UIView)
ConvertRectToView(CGRect, UIView)

Converts from this object's coordinate system to that of .

(Inherited from UIView)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSObject)

Indicates a "Copy" editing operation.

(Inherited from UIResponder)
Cut(NSObject)

Indicates a "Cut" editing operation.

(Inherited from UIResponder)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DecodeRestorableState(NSCoder)

Application developers can override this method to support state restoration.

(Inherited from UIView)
Delete(NSObject)

Indicates a "Delete" editing operation.

(Inherited from UIResponder)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

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

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

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
DidHintFocusMovement(UIFocusMovementHint)

Called to tell the focused item in the UIView that the focus may change.

(Inherited from UIView)
DidUpdateFocus(UIFocusUpdateContext, UIFocusAnimationCoordinator)

Called after the UIView has either lost or received focus. (See also ShouldUpdateFocus(UIFocusUpdateContext).)

(Inherited from UIView)
DisplayLayer(CALayer) (Inherited from UIView)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the UISearchBar object.

DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Draw(CGRect)

Draws the view within the passed-in rectangle.

(Inherited from UIView)
DrawLayer(CALayer, CGContext) (Inherited from UIView)
DrawRect(CGRect, UIViewPrintFormatter)

Developers should override this method if their appr draws the UIView contents.

(Inherited from UIView)
DrawViewHierarchy(CGRect, Boolean)

Renders the complete view hierarchy visible on screen.

(Inherited from UIView)
EncodeRestorableState(NSCoder)

Application developers can override this method to store state associated with the view.

(Inherited from UIView)
EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExchangeSubview(nint, nint)

This method exchanges the indices of two UIViews within the Subviews array.

(Inherited from UIView)
ExerciseAmbiguityInLayout()

Randomly changes the Frame within an ambiguous set of Auto Layout constraints.

(Inherited from UIView)
ExposedBindings() (Inherited from NSObject)
FrameForAlignmentRect(CGRect)

Returns the frame resulting from applying the alignmentRect to the current Auto Layout constraints.

(Inherited from UIView)
GestureRecognizerShouldBegin(UIGestureRecognizer)

Determines if the specified gesture recognizers should be allowed to track touch events.

(Inherited from UIView)
GetAppearance(UITraitCollection)

Returns an appearance proxy for the specified traits.

GetAppearance(UITraitCollection, Type[])

Returns an appearance proxy for the specified traits when found in the containers containment hierarchy.

GetAppearance<T>()

Obtains the appearance proxy UISearchBar.UISearchBarAppearance for the subclass of UISearchBar.

GetAppearance<T>(UITraitCollection)

Obtains the appearance proxy UISearchBar.UISearchBarAppearance for the subclass of UISearchBar.

GetAppearance<T>(UITraitCollection, Type[])

Obtains the appearance proxy UISearchBar.UISearchBarAppearance for the subclass of UISearchBar that has the specified trait collection when the view is hosted in the specified hierarchy.

GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetConstraintsAffectingLayout(UILayoutConstraintAxis)

Returns the array of NSLayoutConstraint that are affecting the layout of the UIView along the specified axis.

(Inherited from UIView)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetEnumerator()

Returns an enumerator that lists all of the subviews in this view

(Inherited from UIView)
GetFocusItems(CGRect)

Returns a list of all the child focus items within the specified rectangle.

(Inherited from UIView)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetImageForSearchBarIcon(UISearchBarIcon, UIControlState)

The UIImage used for the specified search bar icon type and control state.

GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String)
Obsolete.
(Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetPositionAdjustmentForSearchBarIcon(UISearchBarIcon)

The position adjustment for the specified icon.

GetScopeBarButtonBackgroundImage(UIControlState)

The UIImage used for the background for the specified scope bar button and state.

GetScopeBarButtonDividerImage(UIControlState, UIControlState)

The UIImage used for the divider for the specified combination of left and right segment states.

GetScopeBarButtonTitleTextAttributes(UIControlState)

The text attributes of the scope bar button's title for the specified UIControlState.

GetSearchFieldBackgroundImage(UIControlState)

The UIImage used for the background of the search text field for the specified state.

GetTargetForAction(Selector, NSObject)

Returns the object that responds to an action.

(Inherited from UIResponder)
HitTest(CGPoint, UIEvent)

The frontmost visible, interaction-enabled UIView containing .

(Inherited from UIView)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
InsertSubview(UIView, nint)

Inserts the specified subview at the specified location as a subview of this view.

(Inherited from UIView)
InsertSubviewAbove(UIView, UIView)

Inserts the specified view above the siblingSubvie in the view hierarchy

(Inherited from UIView)
InsertSubviewBelow(UIView, UIView)

Inserts the specified view below the siblingSubview in the view hierarchy.

(Inherited from UIView)
InvalidateIntrinsicContentSize()

Alerts the Auto Layout system that the intrinsic value of the UIView has changed.

(Inherited from UIView)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsDescendantOfView(UIView)

Returns true if this UIView is in the view's view hierarchy.

(Inherited from UIView)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
LayoutIfNeeded()

Lays out the subviews if needed.

(Inherited from UIView)
LayoutMarginsDidChange()

Lays out changed subviews

(Inherited from UIView)
LayoutSublayersOfLayer(CALayer)

Called to indicate that the object's Bounds has changed.

(Inherited from UIView)
LayoutSubviews()

Lays out subviews.

(Inherited from UIView)
MakeTextWritingDirectionLeftToRight(NSObject)

Sets the direction in which text is written to be left-to-right.

(Inherited from UIResponder)
MakeTextWritingDirectionRightToLeft(NSObject)

Sets the direction in which text is written to be right-to-left.

(Inherited from UIResponder)
MarkDirty()

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

(Inherited from NSObject)
MotionBegan(UIEventSubtype, UIEvent)

Method invoked when a motion (a shake) has started.

(Inherited from UIResponder)
MotionCancelled(UIEventSubtype, UIEvent)

Method invoked if the operating system cancels a motion (shake) event.

(Inherited from UIResponder)
MotionEnded(UIEventSubtype, UIEvent)

Method invoked when a motion (shake) has finished.

(Inherited from UIResponder)
MovedToSuperview()

Indicates the UIView has had its Superview property changed.

(Inherited from UIView)
MovedToWindow()

Indicates the UIView has had its Window property changed.

(Inherited from UIView)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
NeedsUpdateConstraints()

Indicates that the Auto Layout constraints of the UIView need updating.

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

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

(Inherited from NSObject)
Paste(NSItemProvider[])

Called to perform a paste operation from .

(Inherited from UIResponder)
Paste(NSObject)

Indicates a "Paste" editing operation.

(Inherited from UIResponder)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
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[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PointInside(CGPoint, UIEvent)

Whether is inside thisUIView object's Bounds.

(Inherited from UIView)
PrepareForInterfaceBuilder() (Inherited from NSObject)
PressesBegan(NSSet<UIPress>, UIPressesEvent)

Indicates that a physical button has been pressed on a remote or game controller.

(Inherited from UIResponder)
PressesCancelled(NSSet<UIPress>, UIPressesEvent)

Indicates a physical button-press event has been cancelled due to a system event.

(Inherited from UIResponder)
PressesChanged(NSSet<UIPress>, UIPressesEvent)

Indicates that the Force value of the evt has changed.

(Inherited from UIResponder)
PressesEnded(NSSet<UIPress>, UIPressesEvent)

Indicates the ending of a press of a physical button on a remote or game controller.

(Inherited from UIResponder)
ReloadInputViews()

Updates custom input and accessory views when this object is the first responder.

(Inherited from UIResponder)
RemoteControlReceived(UIEvent)

Indicates that a remote-control event was received.

(Inherited from UIResponder)
RemoveConstraint(NSLayoutConstraint)

Removes an Auto Layout constraint from the UIView's Constraints.

(Inherited from UIView)
RemoveConstraints(NSLayoutConstraint[])

Removes multiple Auto Layout constraints from the UIView's Constraints.

(Inherited from UIView)
RemoveFromSuperview()

Detaches the UIView from its Superview.

(Inherited from UIView)
RemoveGestureRecognizer(UIGestureRecognizer)

Removes a gesture recognizer from the UIView's GestureRecognizers.

(Inherited from UIView)
RemoveInteraction(IUIInteraction)

Removes the interaction from the view.

(Inherited from UIView)
RemoveLayoutGuide(UILayoutGuide)

Removes guide from the LayoutGuides array.

(Inherited from UIView)
RemoveMotionEffect(UIMotionEffect)

Removes the specified motion effect to the view.

(Inherited from UIView)
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)

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

(Inherited from NSObject)
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)

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

(Inherited from NSObject)
ResignFirstResponder()

Called when this UIResponder has been asked to resign its first responder status.

(Inherited from UIResponder)
ResizableSnapshotView(CGRect, Boolean, UIEdgeInsets)

Efficiently creates a rendering of this object's current appearance within .

(Inherited from UIView)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
RestoreUserActivityState(NSUserActivity)

Restores the state that is necessary for continuance of the specified user activity.

(Inherited from UIResponder)
SafeAreaInsetsDidChange()

Method that is called when the safe area changes.

(Inherited from UIView)
Select(NSObject)

Indicates a "Select" editing operation.|b

(Inherited from UIResponder)
SelectAll(NSObject)

Indicates a "Select All" editing operation.

(Inherited from UIResponder)
SendSubviewToBack(UIView)

Moves a UIView so that it appears behind all its siblings.

(Inherited from UIView)
SetBackgroundImage(UIImage, UIBarPosition, UIBarMetrics)

Sets the UIImage used for the background for the specified position and metrics.

SetContentCompressionResistancePriority(Single, UILayoutConstraintAxis)

Sets the resistance to compression below the UIView's IntrinsicContentSize.

(Inherited from UIView)
SetContentHuggingPriority(Single, UILayoutConstraintAxis)

Sets the resistance to expansion beyond the UIView's IntrinsicContentSize.

(Inherited from UIView)
SetImageforSearchBarIcon(UIImage, UISearchBarIcon, UIControlState)

Sets the icon for the specified search bar icon type and control state.

SetNativeField(String, NSObject)
Obsolete.
(Inherited from NSObject)
SetNeedsDisplay()

Marks the view dirty and queues a redraw operation on it.

(Inherited from UIView)
SetNeedsDisplayInRect(CGRect)

Marks a region of the view as dirty and queues a redraw operation on that region.

(Inherited from UIView)
SetNeedsFocusUpdate()

When this is the active focus environment, requests a focus update, which can potentially change the PreferredFocusedView. (See also UpdateFocusIfNeeded().)

(Inherited from UIView)
SetNeedsLayout()

Sets whether subviews need to be rearranged before displaying.

(Inherited from UIView)
SetNeedsUpdateConstraints()

Indicates to the Auto Layout system that it must call UpdateConstraints().

(Inherited from UIView)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetPositionAdjustmentforSearchBarIcon(UIOffset, UISearchBarIcon)

Sets the position adjustment for the specified icon.

SetScopeBarButtonBackgroundImage(UIImage, UIControlState)

Sets the UIImage used as the background image for the specified scope bar button and state.

SetScopeBarButtonDividerImage(UIImage, UIControlState, UIControlState)

Sets the UIImage used as the divider for the specified combination of left and right segment states.

SetScopeBarButtonTitle(UITextAttributes, UIControlState)

The title and attributes of the scope bar button for the specified UIControlState.

SetSearchFieldBackgroundImage(UIImage, UIControlState)

Sets the UIImage used as the background for the search text field for the specified state.

SetShowsCancelButton(Boolean, Boolean)

Sets the display state of the cancel button, optionally animating the change.

SetValueForKey(NSObject, NSString)

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

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

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

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

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

(Inherited from NSObject)
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)

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

(Inherited from NSObject)
ShouldUpdateFocus(UIFocusUpdateContext)

Called prior to the UIView either losing or receiving focus. If either focus environment returns false, the focus update is canceled.

(Inherited from UIView)
SizeThatFits(CGSize)

Returns the SizeF that best fits this UIView.

(Inherited from UIView)
SizeToFit()

Moves and resizes the UIView so that it tightly encloses its Subviews

(Inherited from UIView)
SnapshotView(Boolean)

Creates a UIView that contains a snapshot image of the current view's contents.

(Inherited from UIView)
SubviewAdded(UIView)

Tells the view when subviews are added.

(Inherited from UIView)
SystemLayoutSizeFittingSize(CGSize)

Calculates the smallest or largest size that this UIView can have that satisfies its Auto Layout constraints.

(Inherited from UIView)
SystemLayoutSizeFittingSize(CGSize, Single, Single)

Returns the optimal size for this, based on constraints, and the fitting priority arguments.

(Inherited from UIView)
TintColorDidChange()

Called when the TintColor changes, such as when a UIActionSheet is displayed.

(Inherited from UIView)
ToggleBoldface(NSObject)

Toggles the use of a bold font.

(Inherited from UIResponder)
ToggleItalics(NSObject)

Toggles the use of an italic font.

(Inherited from UIResponder)
ToggleUnderline(NSObject)

Toggles the use of underlining.

(Inherited from UIResponder)
ToString()

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

(Inherited from NSObject)
TouchesBegan(NSSet, UIEvent)

Sent when one or more fingers touches the screen.

(Inherited from UIResponder)
TouchesCancelled(NSSet, UIEvent)

Sent when the touch processing has been cancelled.

(Inherited from UIResponder)
TouchesEnded(NSSet, UIEvent)

Sent when one or more fingers are lifted from the screen.

(Inherited from UIResponder)
TouchesEstimatedPropertiesUpdated(NSSet)

Called when the estimated properties of touches have been updated.

(Inherited from UIResponder)
TouchesMoved(NSSet, UIEvent)

Sent when one or more fingers move on the screen.

(Inherited from UIResponder)
TraitCollectionDidChange(UITraitCollection)

Defines previous trait collection.

(Inherited from UIView)
Unbind(NSString) (Inherited from NSObject)
Unbind(String)
Obsolete.
(Inherited from NSObject)
UpdateConstraints()

Updates the Auto Layout constraints for the UIView.

(Inherited from UIView)
UpdateConstraintsIfNeeded()

Updates the constraints of the UIView and its Subviews.

(Inherited from UIView)
UpdateFocusIfNeeded()

If any focus environment has a pending update, this method forces an immediate focus update. Unlike SetNeedsFocusUpdate(), this method may be called by any UIView, whether it currently contains focus or not.

(Inherited from UIView)
UpdateUserActivityState(NSUserActivity)

Updates a given user activity state.

(Inherited from UIResponder)
ValueForKey(NSString)

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

(Inherited from NSObject)
ValueForKeyPath(NSString)

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

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

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

(Inherited from NSObject)
ViewWithTag(nint)

Returns the UIView identified by the tag. May return null.

(Inherited from UIView)
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) (Inherited from NSObject)
WillChangeValue(String)

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

(Inherited from NSObject)
WillDrawLayer(CALayer)

Called shortly before the is drawn.

(Inherited from UIView)
WillMoveToSuperview(UIView)

Called before the Superview changes.

(Inherited from UIView)
WillMoveToWindow(UIWindow)

This method is called by the runtime when assigning a new UIWindow to the UIView's view hierarcy. This method will be called on all UIViews in the hierarchy, not just the top-level UIView.

(Inherited from UIView)
WillRemoveSubview(UIView)

Called prior to the removal of a subview.

(Inherited from UIView)

Events

BookmarkButtonClicked

Event raised by the object.

CancelButtonClicked

Event raised by the object.

ListButtonClicked

Event raised by the object.

OnEditingStarted

Event raised by the object.

OnEditingStopped

Event raised by the object.

SearchButtonClicked

Event raised by the object.

SelectedScopeButtonIndexChanged

Event raised by the object.

TextChanged

Event raised by the object.

Extension Methods

ActionForLayer(ICALayerDelegate, CALayer, String)
DisplayLayer(ICALayerDelegate, CALayer)
DrawLayer(ICALayerDelegate, CALayer, CGContext)
LayoutSublayersOfLayer(ICALayerDelegate, CALayer)
WillDrawLayer(ICALayerDelegate, CALayer)

Method that is called when layer is about to be drawn.

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

GetCollisionBoundingPath(IUIDynamicItem)

Returns the closed path that is used for collision detection.

GetCollisionBoundsType(IUIDynamicItem)

Returns a value that tells how collision bounds are specified.

GetFocusItemContainer(IUIFocusEnvironment)

Gets the focus container for the environment.

GetParentFocusEnvironment(IUIFocusEnvironment)

Gets the parent focus environment.

GetPreferredFocusEnvironments(IUIFocusEnvironment)

Gets the list of focus environments, ordered by priority, that the environment prefers when updating the focus.

DidHintFocusMovement(IUIFocusItem, UIFocusMovementHint)

Called when a focus change may soon happen.

GetFrame(IUIFocusItem)

Returns the frame in the reference coordinate space of the containing IUIFocusItemContainer.

CanPaste(IUIPasteConfigurationSupporting, NSItemProvider[])

Returns true if the responder can paste from the specified item providers.

Paste(IUIPasteConfigurationSupporting, NSItemProvider[])

Performs the paste.

DecreaseSize(UIResponder, NSObject)

A hardware keyboard request (Command-minus) to decrease the size of the UIResponder.

IncreaseSize(UIResponder, NSObject)

A hardware keyboard request (Command-plus) to increase the size of the UIResponder.

GetPasswordRules(IUITextInputTraits)

Returns the password entry rules.

GetSmartDashesType(IUITextInputTraits)

Gets the smart dashes style.

GetSmartInsertDeleteType(IUITextInputTraits)

Gets the smart insert style.

GetSmartQuotesType(IUITextInputTraits)

Gets the smart quotes style.

GetTextContentType(IUITextInputTraits)

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

SetPasswordRules(IUITextInputTraits, UITextInputPasswordRules)

Sets the password entry rules.

SetSmartDashesType(IUITextInputTraits, UITextSmartDashesType)

Sets the style for smart dashes.

SetSmartInsertDeleteType(IUITextInputTraits, UITextSmartInsertDeleteType)

Sets the style for smart insertion.

SetSmartQuotesType(IUITextInputTraits, UITextSmartQuotesType)

Sets the style for smart quotes.

SetTextContentType(IUITextInputTraits, NSString)

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

EndEditing(UIView, Boolean)

Applies to

See also