Class SfComboBox

Auto complete class

Inheritance

System.Object

SfComboBox

Namespace: Syncfusion.iOS.ComboBox

Assembly: Syncfusion.SfComboBox.iOS.dll

Syntax

public class SfComboBox : UIControl

Constructors

SfComboBox()

Initializes a new instance of the SfComboBox class.

Declaration

public SfComboBox()

SfComboBox(IntPtr)

Initializes a new instance of the SfComboBox class.

Declaration

public SfComboBox(IntPtr intPtr)

Parameters

Type	Name	Description
System.IntPtr	intPtr	handling pointer.

Properties

AllowFiltering

Gets or sets the AllowFiltering.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	AllowFiltering.

AutoCompleteString

Gets or sets the value of Auto Complete String.

Declaration

public NSString AutoCompleteString { get; set; }

Property Value

Type
Foundation.NSString

AutoCompleteTableView

Gets or sets the value of Auto Complete Table View.

Declaration

public UITableViewController AutoCompleteTableView { get; set; }

Property Value

Type
UIKit.UITableViewController

BorderColor

Gets or sets the value of Border Color.

Declaration

public UIColor BorderColor { get; set; }

Property Value

Type
UIKit.UIColor

ClearButtonColor

Gets or sets the color of the clear button.

Declaration

public UIColor ClearButtonColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the clear button.

ComboBoxMode

Gets or sets the value of AutoCompleteMode

Declaration

public ComboBoxMode ComboBoxMode { get; set; }

Property Value

Type
ComboBoxMode

ComboBoxSource

Gets or sets the value of Auto Complete Source

Declaration

public NSMutableArray ComboBoxSource { get; set; }

Property Value

Type
Foundation.NSMutableArray

CustomView

Gets or sets the CustomView.

Declaration

public UIView CustomView { get; set; }

Property Value

Type	Description
UIKit.UIView	CustomView.

DataSource

Gets or sets the value of DataSource.

Declaration

public IEnumerable<object> DataSource { get; set; }

Property Value

Type
System.Collections.Generic.IEnumerable<System.Object>

Delimiter

Gets or sets the delimiter.

Declaration

public string Delimiter { get; set; }

Property Value

Type	Description
System.String	The delimiter.

DisplayMemberPath

Gets or sets the value of Display Member Path.

Declaration

public NSString DisplayMemberPath { get; set; }

Property Value

Type
Foundation.NSString

DropDownBackgroundColor

Gets or sets the color of the drop down background.

Declaration

public UIColor DropDownBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the drop down background.

DropDownBorderColor

Gets or sets the value of DropDownBorderColor.

Declaration

public UIColor DropDownBorderColor { get; set; }

Property Value

Type
UIKit.UIColor

DropDownButtonSettings

Gets or sets the DropDownButton Settings.

Declaration

public DropDownButtonSettings DropDownButtonSettings { get; set; }

Property Value

Type	Description
DropDownButtonSettings	DropDownButtonSettings.

DropDownCornerRadius

Gets or sets the drop down corner radius.

Declaration

public double DropDownCornerRadius { get; set; }

Property Value

Type	Description
System.Double	The drop down corner radius.

DropDownFont

Gets or sets the value of DropDownFont.

Declaration

public UIFont DropDownFont { get; set; }

Property Value

Type
UIKit.UIFont

DropDownFooterView

Gets or sets the drop down footer view.

Declaration

public UIView DropDownFooterView { get; set; }

Property Value

Type	Description
UIKit.UIView	The drop down footer view.

DropDownFooterViewHeight

Gets or sets the height of the drop down footer view.

Declaration

public double DropDownFooterViewHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the drop down footer view.

DropDownHeaderView

Gets or sets the drop down header view.

Declaration

public UIView DropDownHeaderView { get; set; }

Property Value

Type	Description
UIKit.UIView	The drop down header view.

DropDownHeaderViewHeight

Gets or sets the height of the drop down header view.

Declaration

public double DropDownHeaderViewHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the drop down header view.

DropDownTextColor

Gets or sets the value of Drop Down Text Color.

Declaration

public UIColor DropDownTextColor { get; set; }

Property Value

Type
UIKit.UIColor

DropDownTextSize

Gets or sets the value of DropDownTextSize.

Declaration

public double DropDownTextSize { get; set; }

Property Value

Type
System.Double

ElementArray

Gets or sets the value of Element Array.

Declaration

public NSMutableArray ElementArray { get; set; }

Property Value

Type
Foundation.NSMutableArray

EnableAutoSize

Gets or sets a value indicating whether auto size is enabled.

Declaration

public bool EnableAutoSize { get; set; }

Property Value

Type
System.Boolean

EnableSelectionIndicator

Gets or sets a value indicating whether the value of enable selection indicator.

Declaration

public bool EnableSelectionIndicator { get; set; }

Property Value

Type
System.Boolean

FilteredItems

Gets or sets the filtered items.

Declaration

public IEnumerable<object> FilteredItems { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Object>	The filtered items.

Font

Gets or sets the value of Font.

Declaration

public UIFont Font { get; set; }

Property Value

Type
UIKit.UIFont

Frame

Gets or sets the value of Frame.

Declaration

public override CGRect Frame { get; set; }

Property Value

Type
CoreGraphics.CGRect

HighlightedTextColor

Gets or sets the color of the highlight text.

Declaration

public UIColor HighlightedTextColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the highlight text.

HighlightedTextFontAttributes

Gets or sets the highlight text font attributes.

Declaration

public UIFont HighlightedTextFontAttributes { get; set; }

Property Value

Type	Description
UIKit.UIFont	The highlight text font attributes.

IgnoreDiacritic

Gets or sets a value indicating whether this SfAutoComplete enable diacritics.

Declaration

public bool IgnoreDiacritic { get; set; }

Property Value

Type	Description
System.Boolean	true if enable diacritics; otherwise, false.

ImageArray

Gets or sets the value of Image Array.

Declaration

public NSMutableArray ImageArray { get; set; }

Property Value

Type
Foundation.NSMutableArray

ImageCollection

Gets or sets the value of Image Collection.

Declaration

public NSString ImageCollection { get; set; }

Property Value

Type
Foundation.NSString

ImageMemberPath

Gets or sets the image path.

Declaration

public string ImageMemberPath { get; set; }

Property Value

Type	Description
System.String	The image path.

IndicatorFont

Gets or sets the value of Indicator Font.

Declaration

public UIFont IndicatorFont { get; set; }

Property Value

Type
UIKit.UIFont

IndicatorText

Gets or sets the value of Indicator Text.

Declaration

public string IndicatorText { get; set; }

Property Value

Type
System.String

IndicatorTextColor

Gets or sets the value of indicator Text Color.

Declaration

public UIColor IndicatorTextColor { get; set; }

Property Value

Type
UIKit.UIColor

IndicatorTextSize

Gets or sets the value of IndicatorTextSize.

Declaration

public double IndicatorTextSize { get; set; }

Property Value

Type
System.Double

IsDropDownOpen

Gets or sets a value indicating whether the value of IsDropDownOpen.

Declaration

public bool IsDropDownOpen { get; set; }

Property Value

Type
System.Boolean

IsEditable

Gets or sets the IsEditable.

Declaration

public bool IsEditable { get; set; }

Property Value

Type	Description
System.Boolean	IsEditable.

IsFocused

Gets or sets a value indicating whether Focus value to Autocomplete.

Declaration

public bool IsFocused { get; set; }

Property Value

Type
System.Boolean

IsSelectedItemsVisibleInDropDown

Gets or sets a value indicating whether selected items visible in drop down property.

Declaration

public bool IsSelectedItemsVisibleInDropDown { get; set; }

Property Value

Type
System.Boolean

IsSuggestionOpen

Gets or sets a value indicating whether the value of is Suggestion Open.

Declaration

public bool IsSuggestionOpen { get; set; }

Property Value

Type
System.Boolean

ItemHeight

Gets or sets the value of ItemHeight.

Declaration

public nfloat ItemHeight { get; set; }

Property Value

Type
System.nfloat

ItemPadding

Gets or sets the value of Item Padding.

Declaration

public UIEdgeInsets ItemPadding { get; set; }

Property Value

Type
UIKit.UIEdgeInsets

itemsSource

Gets or sets the value of items Source

Declaration

public NSMutableArray itemsSource { get; set; }

Property Value

Type
Foundation.NSMutableArray

KeyboardType

Gets or sets the type of the keyboard.

Declaration

public UIKeyboardType KeyboardType { get; set; }

Property Value

Type	Description
UIKit.UIKeyboardType	The type of the keyboard.

LoadMoreText

Gets or sets the load more text.

Declaration

public string LoadMoreText { get; set; }

Property Value

Type	Description
System.String	The load more text.

LoadMoreView

Gets or sets the load more view.

Declaration

public UIView LoadMoreView { get; set; }

Property Value

Type	Description
UIKit.UIView	The load more default value is null

MaxDropDownHeight

Gets or sets the value of MaxDropDownHeight.

Declaration

public double MaxDropDownHeight { get; set; }

Property Value

Type
System.Double

MaximumSuggestion

Gets or sets the value of Maximum Suggestion method

Declaration

public nint MaximumSuggestion { get; set; }

Property Value

Type
System.nint

MinimumPrefixCharacters

Gets or sets the value of MinimumPrefixCharacters.

Declaration

public nint MinimumPrefixCharacters { get; set; }

Property Value

Type
System.nint

MultiSelectMode

Gets or sets the multi select mode.

Declaration

public MultiSelectMode MultiSelectMode { get; set; }

Property Value

Type	Description
MultiSelectMode	The multi select mode.

NoResultsFoundFont

Gets or sets the no results found font family.

Declaration

public UIFont NoResultsFoundFont { get; set; }

Property Value

Type	Description
UIKit.UIFont	The no results found font family.

NoResultsFoundText

Gets or sets the no results found text.

Declaration

public string NoResultsFoundText { get; set; }

Property Value

Type	Description
System.String	The no results found text.

NoResultsFoundTextColor

Gets or sets the no results found text color.

Declaration

public UIColor NoResultsFoundTextColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The no results found text color.

Obj

Gets or sets the value of Object.

Declaration

public NSObject Obj { get; set; }

Property Value

Type
Foundation.NSObject

PopUpDelay

Gets or sets the value of PopUpDelay.

Declaration

public double PopUpDelay { get; set; }

Property Value

Type
System.Double

ReferenceView

Gets or sets the value of Reference View.

Declaration

public UIView ReferenceView { get; set; }

Property Value

Type
UIKit.UIView

SearchDelay

Gets or sets the value of SearchDelay

Declaration

public int SearchDelay { get; set; }

Property Value

Type
System.Int32

SearchItemPath

Gets or sets the value of Search Item Path.

Declaration

public NSString SearchItemPath { get; set; }

Property Value

Type
Foundation.NSString

SelectAllOnFocus

Gets or sets a value indicating whether boolean value

Declaration

public bool SelectAllOnFocus { get; set; }

Property Value

Type
System.Boolean

SelectedDropDownItemColor

Gets or sets the ComboBoxDropDownButton.

Declaration

public UIColor SelectedDropDownItemColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	ComboBoxDropDownButton.

SelectedIndex

Gets or sets the value of Selected Index.

Declaration

public nint SelectedIndex { get; set; }

Property Value

Type
System.nint

SelectedIndices

Gets or sets collection of indices.

Declaration

public object SelectedIndices { get; set; }

Property Value

Type
System.Object

SelectedItem

Gets or sets the value of Selected Item.

Declaration

public object SelectedItem { get; set; }

Property Value

Type
System.Object

SelectedValue

Gets or sets the value of Selected Value.

Declaration

public NSObject SelectedValue { get; set; }

Property Value

Type
Foundation.NSObject

SelectedValuePath

Gets or sets the value of Selected Value Path.

Declaration

public NSString SelectedValuePath { get; set; }

Property Value

Type
Foundation.NSString

SelectionType

Gets or sets the value of Selection Type.

Declaration

public SelectionType SelectionType { get; set; }

Property Value

Type
SelectionType

SemanticContentAttribute

Gets or sets the semantic content attribute.

Declaration

public override UISemanticContentAttribute SemanticContentAttribute { get; set; }

Property Value

Type	Description
UIKit.UISemanticContentAttribute	The semantic content attribute.

Separator

Gets or sets the value of Separator.

Declaration

public UITableViewCellSeparatorStyle Separator { get; set; }

Property Value

Type
UIKit.UITableViewCellSeparatorStyle

ShowBorder

Gets or sets a value indicating whether this SfAutoComplete show border.

Declaration

public bool ShowBorder { get; set; }

Property Value

Type	Description
System.Boolean	true if show border; otherwise, false.

ShowClearButton

Gets or sets a value indicating whether this SfAutoComplete show clear button.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean	true if show clear button; otherwise, false.

ShowDropDownFooterView

Gets or sets a value indicating whether this SfAutoComplete show drop down footer view.

Declaration

public bool ShowDropDownFooterView { get; set; }

Property Value

Type	Description
System.Boolean	true if show drop down footer view; otherwise, false.

ShowDropDownHeaderView

Gets or sets a value indicating whether this SfAutoComplete show drop down header view.

Declaration

public bool ShowDropDownHeaderView { get; set; }

Property Value

Type	Description
System.Boolean	true if show drop down header view; otherwise, false.

ShowSuggestionsOnFocus

Gets or sets a value indicating whether the value of Show Suggestions OnFocus.

Declaration

public bool ShowSuggestionsOnFocus { get; set; }

Property Value

Type
System.Boolean

SuggestionBoxPlacement

Gets or sets the value of SuggestionBoxPlacement

Declaration

public SuggestionBoxPlacement SuggestionBoxPlacement { get; set; }

Property Value

Type
SuggestionBoxPlacement

SuggestionMode

Gets or sets the value of SuggestionMode

Declaration

public SuggestionMode SuggestionMode { get; set; }

Property Value

Type
SuggestionMode

tableViewStyle

Declaration

public UITableViewCellStyle tableViewStyle { get; set; }

Property Value

Type
UIKit.UITableViewCellStyle

TableViewStyle

Gets or sets the value of tableViewStyle

Declaration

public UITableViewCellStyle TableViewStyle { get; set; }

Property Value

Type
UIKit.UITableViewCellStyle

Text

Gets or sets the value of Text.

Declaration

public NSString Text { get; set; }

Property Value

Type
Foundation.NSString

TextColor

Gets or sets the value of Text Color.

Declaration

public UIColor TextColor { get; set; }

Property Value

Type
UIKit.UIColor

TextField

Gets or sets the value of Text field property.

Declaration

public UITextField TextField { get; set; }

Property Value

Type
UIKit.UITextField

TextHighlightMode

Gets or sets the text highlight mode.

Declaration

public OccurrenceMode TextHighlightMode { get; set; }

Property Value

Type	Description
OccurrenceMode	The text highlight mode.

TextSize

Gets or sets the value of Text Size.

Declaration

public nfloat TextSize { get; set; }

Property Value

Type
System.nfloat

TokenSettings

Gets or sets token settings to AutoComplete.

Declaration

public TokenSettings TokenSettings { get; set; }

Property Value

Type
TokenSettings

TokensWrapMode

Gets or sets TokensWrapMode to AutoComplete.

Declaration

public TokensWrapMode TokensWrapMode { get; set; }

Property Value

Type
TokensWrapMode

ViewArray

Gets or sets the value of View Array.

Declaration

public NSMutableArray ViewArray { get; set; }

Property Value

Type
Foundation.NSMutableArray

Watermark

Gets or sets the value of Watermark.

Declaration

public NSString Watermark { get; set; }

Property Value

Type
Foundation.NSString

WatermarkColor

Gets or sets the value of Watermark Color.

Declaration

public UIColor WatermarkColor { get; set; }

Property Value

Type
UIKit.UIColor

Methods

add_Completed(SfComboBox.CompleteEventHandler)

Declaration

public void add_Completed(SfComboBox.CompleteEventHandler value)

Parameters

Type	Name	Description
SfComboBox.CompleteEventHandler	value

add_DropDownItemChanged(SfComboBox.DrawDropDownItemEventHandler)

Declaration

public void add_DropDownItemChanged(SfComboBox.DrawDropDownItemEventHandler value)

Parameters

Type	Name	Description
SfComboBox.DrawDropDownItemEventHandler	value

add_FilterCollectionChanged(SfComboBox.FilterCollectionChangeEventHandler)

Declaration

public void add_FilterCollectionChanged(SfComboBox.FilterCollectionChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.FilterCollectionChangeEventHandler	value

add_FilterItemChanged(SfComboBox.FilterItemEventHandler)

Declaration

public void add_FilterItemChanged(SfComboBox.FilterItemEventHandler value)

Parameters

Type	Name	Description
SfComboBox.FilterItemEventHandler	value

add_FocusChanged(SfComboBox.FocusChangeEventHandler)

Declaration

public void add_FocusChanged(SfComboBox.FocusChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.FocusChangeEventHandler	value

add_SelectionChanged(SfComboBox.SelectionChangeEventHandler)

Declaration

public void add_SelectionChanged(SfComboBox.SelectionChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.SelectionChangeEventHandler	value

add_SelectionChanging(SfComboBox.SelectionChangingEventHandler)

Declaration

public void add_SelectionChanging(SfComboBox.SelectionChangingEventHandler value)

Parameters

Type	Name	Description
SfComboBox.SelectionChangingEventHandler	value

add_TextChanged(SfComboBox.TextChangeEventHandler)

Declaration

public void add_TextChanged(SfComboBox.TextChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.TextChangeEventHandler	value

AwakeFromNib()

Awake from nib.

Declaration

public override void AwakeFromNib()

BecomeFirstResponder()

Becomes the first responder.

Declaration

public override bool BecomeFirstResponder()

Returns

Type	Description
System.Boolean	true, if first responder was become, false otherwise.

Clear()

Clear method.

Declaration

public void Clear()

Dispose(Boolean)

Dispose the specified disposing.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	If set to true disposing.

Focus()

Focus the AutoComplete instance.

Declaration

public void Focus()

LayoutSubviews()

Layouts the sub views

Declaration

public override void LayoutSubviews()

LoadMoreItems()

Loads the more.

Declaration

public void LoadMoreItems()

LoadMoreItems(Int32)

Loads the more with argument.

Declaration

public void LoadMoreItems(int suggestionCount)

Parameters

Type	Name	Description
System.Int32	suggestionCount	Integer count

remove_Completed(SfComboBox.CompleteEventHandler)

Declaration

public void remove_Completed(SfComboBox.CompleteEventHandler value)

Parameters

Type	Name	Description
SfComboBox.CompleteEventHandler	value

remove_DropDownItemChanged(SfComboBox.DrawDropDownItemEventHandler)

Declaration

public void remove_DropDownItemChanged(SfComboBox.DrawDropDownItemEventHandler value)

Parameters

Type	Name	Description
SfComboBox.DrawDropDownItemEventHandler	value

remove_FilterCollectionChanged(SfComboBox.FilterCollectionChangeEventHandler)

Declaration

public void remove_FilterCollectionChanged(SfComboBox.FilterCollectionChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.FilterCollectionChangeEventHandler	value

remove_FilterItemChanged(SfComboBox.FilterItemEventHandler)

Declaration

public void remove_FilterItemChanged(SfComboBox.FilterItemEventHandler value)

Parameters

Type	Name	Description
SfComboBox.FilterItemEventHandler	value

remove_FocusChanged(SfComboBox.FocusChangeEventHandler)

Declaration

public void remove_FocusChanged(SfComboBox.FocusChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.FocusChangeEventHandler	value

remove_SelectionChanged(SfComboBox.SelectionChangeEventHandler)

Declaration

public void remove_SelectionChanged(SfComboBox.SelectionChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.SelectionChangeEventHandler	value

remove_SelectionChanging(SfComboBox.SelectionChangingEventHandler)

Declaration

public void remove_SelectionChanging(SfComboBox.SelectionChangingEventHandler value)

Parameters

Type	Name	Description
SfComboBox.SelectionChangingEventHandler	value

remove_TextChanged(SfComboBox.TextChangeEventHandler)

Declaration

public void remove_TextChanged(SfComboBox.TextChangeEventHandler value)

Parameters

Type	Name	Description
SfComboBox.TextChangeEventHandler	value

SetCursorPosition(Int32)

Sets the cursor position.

Declaration

public void SetCursorPosition(int curserIndex)

Parameters

Type	Name	Description
System.Int32	curserIndex	Curser index.

SizeThatFits(CGSize)

Size that fits.

Declaration

public override CGSize SizeThatFits(CGSize size)

Parameters

Type	Name	Description
CoreGraphics.CGSize	size	Control Size.

Returns

Type	Description
CoreGraphics.CGSize	The CGSize size.

TraitCollectionDidChange(UITraitCollection)

Orientation Change Detection method.

Declaration

public override void TraitCollectionDidChange(UITraitCollection previousTraitCollection)

Parameters

Type	Name	Description
UIKit.UITraitCollection	previousTraitCollection	The Previous Trait Collection.

Events

Completed

Occurs when completed.

Declaration

public event SfComboBox.CompleteEventHandler Completed

Event Type

Type
SfComboBox.CompleteEventHandler

DropDownClosed

Occurs when drop down is closed.

Declaration

public event EventHandler<EventArgs> DropDownClosed

Event Type

Type
System.EventHandler<System.EventArgs>

DropDownClosing

Occurs when load more button tapped.

Declaration

public event EventHandler<DropDownCancelEventArgs> DropDownClosing

Event Type

Type
System.EventHandler<DropDownCancelEventArgs>

DropDownItemChanged

Occurs only the dropdown item

Declaration

public event SfComboBox.DrawDropDownItemEventHandler DropDownItemChanged

Event Type

Type
SfComboBox.DrawDropDownItemEventHandler

DropDownOpened

Occurs when drop down is opened.

Declaration

public event EventHandler<EventArgs> DropDownOpened

Event Type

Type
System.EventHandler<System.EventArgs>

FilterCollectionChanged

Occurs when filtered items changed.

Declaration

public event SfComboBox.FilterCollectionChangeEventHandler FilterCollectionChanged

Event Type

Type
SfComboBox.FilterCollectionChangeEventHandler

FilterItemChanged

Occurs only the dropdown item changed

Declaration

public event SfComboBox.FilterItemEventHandler FilterItemChanged

Event Type

Type
SfComboBox.FilterItemEventHandler

FocusChanged

Occurs only the Focus changed

Declaration

public event SfComboBox.FocusChangeEventHandler FocusChanged

Event Type

Type
SfComboBox.FocusChangeEventHandler

LoadMoreButtonTapped

Occurs when load more button tapped.

Declaration

public event EventHandler<EventArgs> LoadMoreButtonTapped

Event Type

Type
System.EventHandler<System.EventArgs>

SelectionChanged

Occurs only the selection changed

Declaration

public event SfComboBox.SelectionChangeEventHandler SelectionChanged

Event Type

Type
SfComboBox.SelectionChangeEventHandler

SelectionChanging

Occurs only the selection changed

Declaration

public event SfComboBox.SelectionChangingEventHandler SelectionChanging

Event Type

Type
SfComboBox.SelectionChangingEventHandler

TextChanged

Occurs only the value changed

Declaration

public event SfComboBox.TextChangeEventHandler TextChanged

Event Type

Type
SfComboBox.TextChangeEventHandler