UISearchBar Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[Foundation.Register("UISearchBar", true)]
public class UISearchBar : UIKit.UIView, IDisposable, UIKit.IUIBarPositioning, UIKit.IUILookToDictateCapable, UIKit.IUITextInputTraits
[<Foundation.Register("UISearchBar", true)>]
type UISearchBar = class
inherit UIView
interface INSCoding
interface INativeObject
interface IDisposable
interface IUIBarPositioning
interface IUILookToDictateCapable
interface IUITextInputTraits
[<Foundation.Register("UISearchBar", true)>]
type UISearchBar = class
inherit UIView
interface IUIBarPositioning
interface INativeObject
interface IDisposable
interface IUILookToDictateCapable
interface IUITextInputTraits
- Inheritance
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| UISearchBar() |
Creates a new UISearchBar with default values. |
| UISearchBar(CGRect) | |
| UISearchBar(NativeHandle) |
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
| Name | Description |
|---|---|
| AccessibilityActivationPoint | (Inherited from UIView) |
| AccessibilityAssistiveTechnologyFocusedIdentifiers | (Inherited from UIResponder) |
| AccessibilityAttributedHint | (Inherited from UIView) |
| AccessibilityAttributedLabel | (Inherited from UIView) |
| AccessibilityAttributedUserInputLabels | (Inherited from UIView) |
| AccessibilityAttributedValue | (Inherited from UIView) |
| AccessibilityCustomActions | (Inherited from UIResponder) |
| AccessibilityDirectTouchOptions | (Inherited from UIView) |
| AccessibilityDragSourceDescriptors | (Inherited from UIResponder) |
| AccessibilityDropPointDescriptors | (Inherited from UIResponder) |
| AccessibilityElementsHidden | (Inherited from UIView) |
| AccessibilityExpandedStatus | (Inherited from UIView) |
| AccessibilityFrame | (Inherited from UIView) |
| AccessibilityHeaderElements | (Inherited from UIView) |
| AccessibilityHint | (Inherited from UIView) |
| AccessibilityIdentifier |
Uniquely identifies |
| AccessibilityIgnoresInvertColors | (Inherited from UIView) |
| AccessibilityLabel | (Inherited from UIView) |
| AccessibilityLanguage | (Inherited from UIView) |
| AccessibilityNavigationStyle | (Inherited from UIView) |
| AccessibilityPath | (Inherited from UIView) |
| AccessibilityRespondsToUserInteraction | (Inherited from UIView) |
| AccessibilityTextualContext | (Inherited from UIView) |
| AccessibilityTraits | (Inherited from UIView) |
| AccessibilityUserInputLabels | (Inherited from UIView) |
| AccessibilityValue | (Inherited from UIView) |
| AccessibilityViewIsModal | (Inherited from UIView) |
| ActivityItemsConfiguration | (Inherited from UIResponder) |
| AlignmentRectInsets | (Inherited from UIView) |
| AllowedWritingToolsResultOptions | |
| AllowsNumberPadPopover | |
| Alpha | (Inherited from UIView) |
| AnchorPoint | (Inherited from UIView) |
| Appearance |
Strongly-typed property that returns the UIAppearance class for this class. |
| AppliedContentSizeCategoryLimitsDescription | (Inherited from UIView) |
| AutocapitalizationType |
The UITextAutocapitalizationType used by the IUITextInput. |
| AutocorrectionType |
The UITextAutocorrectionType used by the IUITextInput. |
| AutoresizingMask | (Inherited from UIView) |
| AutosizesSubviews | (Inherited from UIView) |
| BackgroundColor |
The color used for the background. (Inherited from UIView) |
| BackgroundImage |
The UIImage used for the search bar's background. |
| BarPosition |
Gets the bar position. |
| BarStyle | |
| BarTintColor |
The tint of the search bar background. |
| BottomAnchor | (Inherited from UIView) |
| Bounds | (Inherited from UIView) |
| CanBecomeFirstResponder | (Inherited from UIResponder) |
| CanBecomeFocused | (Inherited from UIView) |
| CanResignFirstResponder | (Inherited from UIResponder) |
| Center | (Inherited from UIView) |
| CenterXAnchor | (Inherited from UIView) |
| CenterYAnchor | (Inherited from UIView) |
| Class | (Inherited from NSObject) |
| ClassHandle |
The Objective-C class handle for this class. |
| ClearsContextBeforeDrawing | (Inherited from UIView) |
| ClipsToBounds | (Inherited from UIView) |
| CollisionBoundingPath |
Returns the closed path that is used for collision detection. (Inherited from UIView) |
| CollisionBoundsType |
Returns a value that tells how collision bounds are specified. (Inherited from UIView) |
| Constraints | (Inherited from UIView) |
| ContentMode | (Inherited from UIView) |
| ContentScaleFactor | (Inherited from UIView) |
| ContentStretch | (Inherited from UIView) |
| ConversationContext | |
| CoordinateSpace |
Gets the coordinate space implemenation. (Inherited from UIView) |
| CornerConfiguration | (Inherited from UIView) |
| DebugDescription | (Inherited from NSObject) |
| Delegate |
An instance of the UIKit.IUISearchBarDelegate model class which acts as the class delegate. |
| Description | (Inherited from NSObject) |
| DirectionalLayoutMargins | (Inherited from UIView) |
| EditingInteractionConfiguration | (Inherited from UIResponder) |
| EffectiveUserInterfaceLayoutDirection | (Inherited from UIView) |
| Enabled | |
| EnablesReturnKeyAutomatically |
Whether the return key is automatically enabled. |
| ExclusiveTouch |
Restricts the event delivery to this view. (Inherited from UIView) |
| FirstBaselineAnchor | (Inherited from UIView) |
| Focused |
Whether the UIView is the focused view. (Inherited from UIView) |
| FocusEffect | (Inherited from UIView) |
| FocusGroupIdentifier | (Inherited from UIView) |
| FocusGroupPriority | (Inherited from UIView) |
| FocusItemContainer |
Gets the container that manages focus information for child focus items. (Inherited from UIView) |
| FocusItemDeferralMode | (Inherited from UIView) |
| Frame | (Inherited from UIView) |
| GestureRecognizers | (Inherited from UIView) |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| HasAmbiguousLayout | (Inherited from UIView) |
| HeightAnchor | (Inherited from UIView) |
| Hidden |
Specifies whether the UIView displays or not. (Inherited from UIView) |
| HoverStyle | (Inherited from UIView) |
| InlinePredictionType | |
| InputAccessoryView | |
| InputAccessoryViewController | (Inherited from UIResponder) |
| InputAssistantItem | |
| InputView | (Inherited from UIResponder) |
| InputViewController | (Inherited from UIResponder) |
| InsetsLayoutMarginsFromSafeArea | (Inherited from UIView) |
| Interactions | (Inherited from UIView) |
| IntrinsicContentSize | (Inherited from UIView) |
| IsAccessibilityElement | (Inherited from UIView) |
| IsDirectBinding | (Inherited from NSObject) |
| IsFirstResponder | (Inherited from UIResponder) |
| IsProxy | (Inherited from NSObject) |
| IsTransparentFocusItem | (Inherited from UIView) |
| KeyboardAppearance |
The UIKeyboardAppearance used by the IUITextInput |
| KeyboardLayoutGuide | (Inherited from UIView) |
| KeyboardType |
The UIKeyboardType used by the IUITextInput. |
| KeyCommands | (Inherited from UIResponder) |
| LargeContentImage | (Inherited from UIView) |
| LargeContentImageInsets | (Inherited from UIView) |
| LargeContentTitle | (Inherited from UIView) |
| LastBaselineAnchor | (Inherited from UIView) |
| Layer | (Inherited from UIView) |
| LayoutGuides | (Inherited from UIView) |
| LayoutMargins | (Inherited from UIView) |
| LayoutMarginsGuide | (Inherited from UIView) |
| LeadingAnchor | (Inherited from UIView) |
| LeftAnchor | (Inherited from UIView) |
| LookToDictateEnabled | |
| MaskView | (Inherited from UIView) |
| MathExpressionCompletionType | |
| MaximumContentSizeCategory | (Inherited from UIView) |
| MinimumContentSizeCategory | (Inherited from UIView) |
| MotionEffects | (Inherited from UIView) |
| MultipleTouchEnabled |
Controls whether the UIView can handle multitouch events. (Inherited from UIView) |
| NextResponder | (Inherited from UIResponder) |
| Opaque |
Determines whether the view is opaque or not. (Inherited from UIView) |
| OverrideUserInterfaceStyle | (Inherited from UIView) |
| ParentFocusEnvironment |
Gets the parent focus environment. (Inherited from UIView) |
| PasswordRules |
The password entry rules. |
| PasteConfiguration |
The UIPasteConfiguration supported by |
| Placeholder | |
| PreferredFocusedView |
If not |
| PreferredFocusEnvironments |
Gets the list of focus environments, ordered by priority, that the environment prefers when updating the focus. (Inherited from UIView) |
| PreservesSuperviewLayoutMargins | (Inherited from UIView) |
| Prompt | |
| ReadableContentGuide | (Inherited from UIView) |
| RestorationIdentifier | (Inherited from UIView) |
| RetainCount | (Inherited from NSObject) |
| ReturnKeyType |
The form of the return key for the IUITextInput. |
| RightAnchor | (Inherited from UIView) |
| SafeAreaInsets | (Inherited from UIView) |
| SafeAreaLayoutGuide | (Inherited from UIView) |
| ScalesLargeContentImage | (Inherited from UIView) |
| ScopeBarBackgroundImage |
The image used as the background for the scope bar. |
| ScopeButtonTitles | |
| SearchBarStyle | |
| SearchFieldBackgroundPositionAdjustment | |
| SearchResultsButtonSelected |
Whether the search results button is selected. |
| SearchTextField | |
| SearchTextPositionAdjustment | |
| SecureTextEntry |
Whether the entered text should be hidden. |
| SelectedScopeButtonIndex | |
| Self | (Inherited from NSObject) |
| SemanticContentAttribute | (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 | (Inherited from UIView) |
| ShowsBookmarkButton | |
| ShowsCancelButton | |
| ShowsLargeContentViewer | (Inherited from UIView) |
| ShowsScopeBar | |
| ShowsSearchResultsButton | |
| SmartDashesType |
The smart dashes style. |
| SmartInsertDeleteType |
The smart insert style. |
| SmartQuotesType |
The smart quotes style. |
| 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). |
| Subviews | (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 | (Inherited from UIView) |
| Tag | (Inherited from UIView) |
| Text | |
| TextContentType |
The semantic of the expected input, which allows the system to, for example, provide custom keyboards. |
| TextInputContextIdentifier | (Inherited from UIResponder) |
| TextInputMode | (Inherited from UIResponder) |
| TintAdjustmentMode | (Inherited from UIView) |
| TintColor |
The color used for tinting. (Inherited from UIView) |
| TopAnchor | (Inherited from UIView) |
| TouchBar | (Inherited from UIResponder) |
| TrailingAnchor | (Inherited from UIView) |
| TraitCollection |
Gets the trait collection that describes the environment. (Inherited from UIView) |
| TraitOverrides | (Inherited from UIView) |
| Transform | (Inherited from UIView) |
| Transform3D | (Inherited from UIView) |
| TranslatesAutoresizingMaskIntoConstraints | (Inherited from UIView) |
| Translucent |
True if the search bar is translucent. |
| UndoManager | (Inherited from UIResponder) |
| UserActivity | (Inherited from UIResponder) |
| UserInteractionEnabled |
Determines whether input events are processed by this view. (Inherited from UIView) |
| ViewForBaselineLayout | (Inherited from UIView) |
| ViewForFirstBaselineLayout | (Inherited from UIView) |
| ViewForLastBaselineLayout | (Inherited from UIView) |
| ViewPrintFormatter | (Inherited from UIView) |
| WeakDelegate | |
| WidthAnchor | (Inherited from UIView) |
| Window | (Inherited from UIView) |
| WritingToolsBehavior | |
| Zone | (Inherited from NSObject) |
Methods
Events
| Name | Description |
|---|---|
| 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. |