Class SfPicker

Represents the picker class.

Inheritance

System.Object

SfPicker

Namespace: Syncfusion.SfPicker.iOS

Assembly: Syncfusion.SfPicker.iOS.dll

Syntax

public class SfPicker : UIView

Constructors

SfPicker()

Initializes a new instance of the SfPicker class.

Declaration

public SfPicker()

SfPicker(IntPtr)

Initializes a new instance of the SfPicker class.

Declaration

public SfPicker(IntPtr handle)

Parameters

Type	Name	Description
System.IntPtr	handle	The Handle.

Properties

BackgroundColor

Gets or sets background color of the control

Declaration

public override UIColor BackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the background.

BorderColor

Gets or sets border color of the control

Declaration

public UIColor BorderColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the border.

CancelButtonBackgroundColor

Gets or sets background color of cancel button

Declaration

public UIColor CancelButtonBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the cancel button background.

CancelButtonTextColor

Gets or sets text color of cancel button

Declaration

public UIColor CancelButtonTextColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the cancel button text.

ColumnCount

Gets the number of columns in the picker

Declaration

public int ColumnCount { get; }

Property Value

Type	Description
System.Int32	The height of the row.

ColumnHeaderBackgroundColor

Gets or sets the color of the column header background.

Declaration

public UIColor ColumnHeaderBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the column header background.

ColumnHeaderFont

Gets or sets the value that indicating that font of selected item text

Declaration

public UIFont ColumnHeaderFont { get; set; }

Property Value

Type	Description
UIKit.UIFont	The column header font.

ColumnHeaderHeight

Gets or sets the value that determines the height of the column header.

Declaration

public double ColumnHeaderHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the column header.

ColumnHeaderText

Gets or sets the column header text.

Declaration

public object ColumnHeaderText { get; set; }

Property Value

Type
System.Object

ColumnHeaderTextColor

Gets or sets the color of the column header text.

Declaration

public UIColor ColumnHeaderTextColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the column header text.

DisplayMemberPath

Gets or sets the display member path.

Declaration

public object DisplayMemberPath { get; set; }

Property Value

Type	Description
System.Object	The display member path.

EnableGrayOverlay

Gets or sets a value indicating whether to enable the gray overlay in dialog mode

Declaration

public bool EnableGrayOverlay { get; set; }

Property Value

Type
System.Boolean

EnableLooping

Gets or sets a value indicating whether auto reverse of picker.

Declaration

public bool EnableLooping { get; set; }

Property Value

Type
System.Boolean

FooterHeight

Gets or sets the value that determines the height of the footer

Declaration

public double FooterHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the footer.

FooterView

Gets or sets the value of view that will hold on Footer

Declaration

public UIView FooterView { get; set; }

Property Value

Type	Description
UIKit.UIView	The footer view.

Frame

Gets or sets the frame of the control.

Declaration

public override CGRect Frame { get; set; }

Property Value

Type	Description
CoreGraphics.CGRect	The frame.

HeaderBackgroundColor

Gets or sets the color of the header background.

Declaration

public UIColor HeaderBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the header background.

HeaderFont

Gets or sets the value that indicating font of header text

Declaration

public UIFont HeaderFont { get; set; }

Property Value

Type	Description
UIKit.UIFont	The header font.

HeaderHeight

Gets or sets the value that determines the height of the header

Declaration

public double HeaderHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the header.

HeaderText

Gets or sets the value that indicating header of the control

Declaration

public string HeaderText { get; set; }

Property Value

Type	Description
System.String	The header text.

HeaderTextColor

Gets or sets the color of the header text.

Declaration

public UIColor HeaderTextColor { get; set; }

Property Value

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

HeaderView

Gets or sets the value of view that will hold on Header

Declaration

public UIView HeaderView { get; set; }

Property Value

Type	Description
UIKit.UIView	The header view.

IsOpen

Gets or sets a value indicating whether is open.

Declaration

public bool IsOpen { get; set; }

Property Value

Type
System.Boolean

ItemHeight

Gets or sets the value that determines the height of the items

Declaration

public double ItemHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the row.

ItemsSource

Gets or sets a collection of items that can be populated as picker items and get rendered at run-time based on the Template provided

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

Type	Description
System.Collections.IEnumerable	The items source.

OKButtonBackgroundColor

Gets or sets background color of ok button

Declaration

public UIColor OKButtonBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the ok button background.

OKButtonTextColor

Gets or sets text color of ok button

Declaration

public UIColor OKButtonTextColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the ok button text.

PickerHeight

Gets or sets the value that determines the height of the picker dialog

Declaration

public double PickerHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the picker.

PickerMode

Gets or sets the value that indicating display mode of the control either as a dialog or default standalone representation

Declaration

public PickerMode PickerMode { get; set; }

Property Value

Type	Description
PickerMode	The picker mode.

PickerWidth

Gets or sets the value that determines the width of the picker dialog

Declaration

public double PickerWidth { get; set; }

Property Value

Type	Description
System.Double	The width of the picker.

SelectedIndex

Gets or sets the Selected Index.

Declaration

public object SelectedIndex { get; set; }

Property Value

Type
System.Object

SelectedItem

Gets or sets the Selected Item.

Declaration

public object SelectedItem { get; set; }

Property Value

Type
System.Object

SelectedItemFont

Gets or sets the value that indicating that font of selected item text

Declaration

public UIFont SelectedItemFont { get; set; }

Property Value

Type	Description
UIKit.UIFont	The column header font.

SelectedItemTextColor

Gets or sets text color of selected items

Declaration

public UIColor SelectedItemTextColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the selected row text.

SelectionBorderColor

Gets or sets background color of the control

Declaration

public UIColor SelectionBorderColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the background.

ShowColumnHeader

Gets or sets a value indicating whether show column header.

Declaration

public bool ShowColumnHeader { get; set; }

Property Value

Type
System.Boolean

ShowFooter

Gets or sets a value indicating whether in show footer.

Declaration

public bool ShowFooter { get; set; }

Property Value

Type
System.Boolean

ShowHeader

Gets or sets a value indicating whether Show Header.

Declaration

public bool ShowHeader { get; set; }

Property Value

Type
System.Boolean

UnSelectedItemFont

Gets or sets the value that indicating that font of unselected items text

Declaration

public UIFont UnSelectedItemFont { get; set; }

Property Value

Type	Description
UIKit.UIFont	The column header font.

UnSelectedItemTextColor

Gets or sets text color of unselected items

Declaration

public UIColor UnSelectedItemTextColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The color of the un selected row text.

Methods

add_CancelButtonClicked(SfPicker.CancelButtonEventhandler)

Declaration

public void add_CancelButtonClicked(SfPicker.CancelButtonEventhandler value)

Parameters

Type	Name	Description
SfPicker.CancelButtonEventhandler	value

add_Closed(SfPicker.ClosedEventhandler)

Declaration

public void add_Closed(SfPicker.ClosedEventhandler value)

Parameters

Type	Name	Description
SfPicker.ClosedEventhandler	value

add_OkButtonClicked(SfPicker.OkButtonEventhandler)

Declaration

public void add_OkButtonClicked(SfPicker.OkButtonEventhandler value)

Parameters

Type	Name	Description
SfPicker.OkButtonEventhandler	value

add_OnColumnLoaded(SfPicker.ColumnLoadedEventhandler)

Declaration

public void add_OnColumnLoaded(SfPicker.ColumnLoadedEventhandler value)

Parameters

Type	Name	Description
SfPicker.ColumnLoadedEventhandler	value

add_OnPickerItemLoaded(SfPicker.PickerViewEventhandler)

Declaration

public void add_OnPickerItemLoaded(SfPicker.PickerViewEventhandler value)

Parameters

Type	Name	Description
SfPicker.PickerViewEventhandler	value

add_Opened(SfPicker.OpenedEventhandler)

Declaration

public void add_Opened(SfPicker.OpenedEventhandler value)

Parameters

Type	Name	Description
SfPicker.OpenedEventhandler	value

add_SelectionChanged(SfPicker.SelectionChangedChangedEventhandler)

Declaration

public void add_SelectionChanged(SfPicker.SelectionChangedChangedEventhandler value)

Parameters

Type	Name	Description
SfPicker.SelectionChangedChangedEventhandler	value

AwakeFromNib()

The method overrides the AwakeFromNib

Declaration

public override void AwakeFromNib()

Close()

Closes the dialog when the control in Dialog mode

Declaration

public void Close()

Dispose(Boolean)

The dispose method.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	The disposing.

HitTest(CGPoint, UIEvent)

Hits the test.

Declaration

public override UIView HitTest(CGPoint point, UIEvent uievent)

Parameters

Type	Name	Description
CoreGraphics.CGPoint	point	The Point.
UIKit.UIEvent	uievent	The U i event.

Returns

Type	Description
UIKit.UIView	The test.

LayoutSubviews()

Override Layout sub views.

Declaration

public override void LayoutSubviews()

Open()

Opens the dialog when the control in Dialog mode

Declaration

public void Open()

remove_CancelButtonClicked(SfPicker.CancelButtonEventhandler)

Declaration

public void remove_CancelButtonClicked(SfPicker.CancelButtonEventhandler value)

Parameters

Type	Name	Description
SfPicker.CancelButtonEventhandler	value

remove_Closed(SfPicker.ClosedEventhandler)

Declaration

public void remove_Closed(SfPicker.ClosedEventhandler value)

Parameters

Type	Name	Description
SfPicker.ClosedEventhandler	value

remove_OkButtonClicked(SfPicker.OkButtonEventhandler)

Declaration

public void remove_OkButtonClicked(SfPicker.OkButtonEventhandler value)

Parameters

Type	Name	Description
SfPicker.OkButtonEventhandler	value

remove_OnColumnLoaded(SfPicker.ColumnLoadedEventhandler)

Declaration

public void remove_OnColumnLoaded(SfPicker.ColumnLoadedEventhandler value)

Parameters

Type	Name	Description
SfPicker.ColumnLoadedEventhandler	value

remove_OnPickerItemLoaded(SfPicker.PickerViewEventhandler)

Declaration

public void remove_OnPickerItemLoaded(SfPicker.PickerViewEventhandler value)

Parameters

Type	Name	Description
SfPicker.PickerViewEventhandler	value

remove_Opened(SfPicker.OpenedEventhandler)

Declaration

public void remove_Opened(SfPicker.OpenedEventhandler value)

Parameters

Type	Name	Description
SfPicker.OpenedEventhandler	value

remove_SelectionChanged(SfPicker.SelectionChangedChangedEventhandler)

Declaration

public void remove_SelectionChanged(SfPicker.SelectionChangedChangedEventhandler value)

Parameters

Type	Name	Description
SfPicker.SelectionChangedChangedEventhandler	value

TouchesEnded(NSSet, UIEvent)

The override method for touches ended.

Declaration

public override void TouchesEnded(NSSet touches, UIEvent evt)

Parameters

Type	Name	Description
Foundation.NSSet	touches	The touches.
UIKit.UIEvent	evt	The event.

Events

CancelButtonClicked

Occurs when cancel button clicked.

Declaration

public event SfPicker.CancelButtonEventhandler CancelButtonClicked

Event Type

Type
SfPicker.CancelButtonEventhandler

Closed

Occurs when on dialog closed.

Declaration

public event SfPicker.ClosedEventhandler Closed

Event Type

Type
SfPicker.ClosedEventhandler

Closing

Occurs when on dialog closed.

Declaration

public event CancelEventHandler Closing

Event Type

Type
System.ComponentModel.CancelEventHandler

OkButtonClicked

Occurs when ok button clicked.

Declaration

public event SfPicker.OkButtonEventhandler OkButtonClicked

Event Type

Type
SfPicker.OkButtonEventhandler

OnColumnLoaded

Occurs when on column loaded.

Declaration

public event SfPicker.ColumnLoadedEventhandler OnColumnLoaded

Event Type

Type
SfPicker.ColumnLoadedEventhandler

OnPickerItemLoaded

Occurs when on picker item loaded.

Declaration

public event SfPicker.PickerViewEventhandler OnPickerItemLoaded

Event Type

Type
SfPicker.PickerViewEventhandler

Opened

Occurs when on dialog opened.

Declaration

public event SfPicker.OpenedEventhandler Opened

Event Type

Type
SfPicker.OpenedEventhandler

SelectionChanged

Occurs when selection changed.

Declaration

public event SfPicker.SelectionChangedChangedEventhandler SelectionChanged

Event Type

Type
SfPicker.SelectionChangedChangedEventhandler