IUISearchBarDelegate Interface

Definition

Namespace:: UIKit

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.tvOS.dll

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.

This interface represents the Objective-C protocol UISearchBarDelegate.

[Foundation.Protocol(Name="UISearchBarDelegate", WrapperType=typeof(UIKit.UISearchBarDelegateWrapper))]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldBeginEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldBeginEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStarted", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidBeginEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldEndEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldEndEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStopped", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidEndEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="TextChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.String) }, Selector="searchBar:textDidChange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeTextInRange", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSRange), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRange:replacementText:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SearchButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarSearchButtonClicked:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="BookmarkButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarBookmarkButtonClicked:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="CancelButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarCancelButtonClicked:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SelectedScopeButtonIndexChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.IntPtr) }, Selector="searchBar:selectedScopeButtonIndexDidChange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ListButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarResultsListButtonClicked:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeText", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSValue[]), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRanges:replacementText:")]
public interface IUISearchBarDelegate : IDisposable, UIKit.IUIBarPositioningDelegate

[Foundation.Protocol(Name="UISearchBarDelegate", WrapperType=typeof(UIKit.UISearchBarDelegateWrapper))]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldBeginEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldBeginEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStarted", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidBeginEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldEndEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldEndEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStopped", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidEndEditing:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="TextChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.String) }, Selector="searchBar:textDidChange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeTextInRange", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSRange), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRange:replacementText:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SearchButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarSearchButtonClicked:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SelectedScopeButtonIndexChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.IntPtr) }, Selector="searchBar:selectedScopeButtonIndexDidChange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeText", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSValue[]), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRanges:replacementText:")]
public interface IUISearchBarDelegate : IDisposable, UIKit.IUIBarPositioningDelegate

[<Foundation.Protocol(Name="UISearchBarDelegate", WrapperType=typeof(UIKit.UISearchBarDelegateWrapper))>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldBeginEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldBeginEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStarted", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidBeginEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldEndEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldEndEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStopped", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidEndEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="TextChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.String) }, Selector="searchBar:textDidChange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeTextInRange", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSRange), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRange:replacementText:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SearchButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarSearchButtonClicked:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="BookmarkButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarBookmarkButtonClicked:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="CancelButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarCancelButtonClicked:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SelectedScopeButtonIndexChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.IntPtr) }, Selector="searchBar:selectedScopeButtonIndexDidChange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ListButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarResultsListButtonClicked:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeText", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSValue[]), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRanges:replacementText:")>]
type IUISearchBarDelegate = interface
    interface INativeObject
    interface IDisposable
    interface IUIBarPositioningDelegate

[<Foundation.Protocol(Name="UISearchBarDelegate", WrapperType=typeof(UIKit.UISearchBarDelegateWrapper))>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldBeginEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldBeginEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStarted", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidBeginEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldEndEditing", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, ReturnType=typeof(System.Boolean), Selector="searchBarShouldEndEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="OnEditingStopped", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarTextDidEndEditing:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="TextChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.String) }, Selector="searchBar:textDidChange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeTextInRange", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSRange), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRange:replacementText:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SearchButtonClicked", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar) }, Selector="searchBarSearchButtonClicked:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="SelectedScopeButtonIndexChanged", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(System.IntPtr) }, Selector="searchBar:selectedScopeButtonIndexDidChange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="ShouldChangeText", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(UIKit.UISearchBar), typeof(Foundation.NSValue[]), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="searchBar:shouldChangeTextInRanges:replacementText:")>]
type IUISearchBarDelegate = interface
    interface INativeObject
    interface IDisposable
    interface IUIBarPositioningDelegate

Derived: UIKit.UISearchBarDelegate

Attributes: ProtocolAttribute ProtocolMemberAttribute

Implements: INativeObject IDisposable IUIBarPositioningDelegate

Remarks

A class that implements this interface (and subclasses NSObject) will be exported to Objective-C as implementing the Objective-C protocol this interface represents.

A class may also implement members from this interface to implement members from the protocol.

Properties

Name	Description
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from INativeObject)

Methods

Name	Description
BookmarkButtonClicked(UISearchBar)	Indicates that the bookmark button was tapped.
CancelButtonClicked(UISearchBar)	Indicates that the cancel button was tapped.
GetPositionForBar(IUIBarPositioning)	Returns the position for `barPositioning` after it has been added to the user interface. (Inherited from IUIBarPositioningDelegate)
ListButtonClicked(UISearchBar)	Indicates that the list button was tapped.
OnEditingStarted(UISearchBar)	Indicates that the user has begun editing the search text.
OnEditingStopped(UISearchBar)	Indicates that the user has stopped editing the text field.
SearchButtonClicked(UISearchBar)	Indicates that the search button was tapped.
SelectedScopeButtonIndexChanged(UISearchBar, IntPtr)	Indicates that the scope button selection has changed.
ShouldBeginEditing(UISearchBar)	Whether editing of the search text should be allowed.
ShouldChangeText(UISearchBar, NSValue[], String)
ShouldChangeTextInRange(UISearchBar, NSRange, String)	Whether the text in the specified range should be replaced with the specified text.
ShouldEndEditing(UISearchBar)	Whether the editing of the search text should end.
TextChanged(UISearchBar, String)	Indicates that the search text has changed.

Extension Methods

Name	Description
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
GetPositionForBar(IUIBarPositioningDelegate, IUIBarPositioning)	Returns the position for `barPositioning` after it has been added to the user interface.
BookmarkButtonClicked(IUISearchBarDelegate, UISearchBar)	Indicates that the bookmark button was tapped.
CancelButtonClicked(IUISearchBarDelegate, UISearchBar)	Indicates that the cancel button was tapped.
ListButtonClicked(IUISearchBarDelegate, UISearchBar)	Indicates that the list button was tapped.
OnEditingStarted(IUISearchBarDelegate, UISearchBar)	Indicates that the user has begun editing the search text.
OnEditingStopped(IUISearchBarDelegate, UISearchBar)	Indicates that the user has stopped editing the text field.
SearchButtonClicked(IUISearchBarDelegate, UISearchBar)	Indicates that the search button was tapped.
SelectedScopeButtonIndexChanged(IUISearchBarDelegate, UISearchBar, IntPtr)	Indicates that the scope button selection has changed.
ShouldBeginEditing(IUISearchBarDelegate, UISearchBar)	Whether editing of the search text should be allowed.
ShouldChangeText(IUISearchBarDelegate, UISearchBar, NSValue[], String)
ShouldChangeTextInRange(IUISearchBarDelegate, UISearchBar, NSRange, String)	Whether the text in the specified range should be replaced with the specified text.
ShouldEndEditing(IUISearchBarDelegate, UISearchBar)	Whether the editing of the search text should end.
TextChanged(IUISearchBarDelegate, UISearchBar, String)	Indicates that the search text has changed.

Applies to

Share via