DialDevicePicker
DialDevicePicker
DialDevicePicker
DialDevicePicker
Class
Definition
Represents a picker flyout that contains a list of remote devices for the user to choose from.
public : sealed class DialDevicePicker : IDialDevicePickerpublic sealed class DialDevicePicker : IDialDevicePickerPublic NotInheritable Class DialDevicePicker Implements IDialDevicePicker// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Constructors
DialDevicePicker() DialDevicePicker() DialDevicePicker() DialDevicePicker()
Creates a new DialDevicePicker object.
public : DialDevicePicker()public DialDevicePicker()Public Sub New()// You can use this method in JavaScript.
Properties
Appearance Appearance Appearance Appearance
Used to change the colors of the picker.
public : DevicePickerAppearance Appearance { get; }public DevicePickerAppearance Appearance { get; }Public ReadOnly Property Appearance As DevicePickerAppearance// You can use this property in JavaScript.
The color of the picker.
Filter Filter Filter Filter
Gets the filter used to choose what devices to show in the picker.
public : DialDevicePickerFilter Filter { get; }public DialDevicePickerFilter Filter { get; }Public ReadOnly Property Filter As DialDevicePickerFilter// You can use this property in JavaScript.
The dial device picker filter.
Methods
Hide() Hide() Hide() Hide()
Hides the picker.
public : void Hide()public void Hide()Public Function Hide() As void// You can use this method in JavaScript.
PickSingleDialDeviceAsync(Rect) PickSingleDialDeviceAsync(Rect) PickSingleDialDeviceAsync(Rect) PickSingleDialDeviceAsync(Rect)
Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event.
public : IAsyncOperation<DialDevice> PickSingleDialDeviceAsync(Rect selection)public IAsyncOperation<DialDevice> PickSingleDialDeviceAsync(Rect selection)Public Function PickSingleDialDeviceAsync(selection As Rect) As IAsyncOperation( Of DialDevice )// You can use this method in JavaScript.
The device the user selected from the picker.
- See Also
PickSingleDialDeviceAsync(Rect, Placement) PickSingleDialDeviceAsync(Rect, Placement) PickSingleDialDeviceAsync(Rect, Placement) PickSingleDialDeviceAsync(Rect, Placement)
Shows the picker. Call this method directly to show to show the picker, instead of showing it in response to an event.
public : IAsyncOperation<DialDevice> PickSingleDialDeviceAsync(Rect selection, Placement preferredPlacement)public IAsyncOperation<DialDevice> PickSingleDialDeviceAsync(Rect selection, Placement preferredPlacement)Public Function PickSingleDialDeviceAsync(selection As Rect, preferredPlacement As Placement) As IAsyncOperation( Of DialDevice )// You can use this method in JavaScript.
The edge of the rectangle from which to show the picker.
The DialDevice object selected.
- See Also
SetDisplayStatus(DialDevice, DialDeviceDisplayStatus) SetDisplayStatus(DialDevice, DialDeviceDisplayStatus) SetDisplayStatus(DialDevice, DialDeviceDisplayStatus) SetDisplayStatus(DialDevice, DialDeviceDisplayStatus)
Updates the picker UI to reflect the status fo a given remote device.
public : void SetDisplayStatus(DialDevice device, DialDeviceDisplayStatus status)public void SetDisplayStatus(DialDevice device, DialDeviceDisplayStatus status)Public Function SetDisplayStatus(device As DialDevice, status As DialDeviceDisplayStatus) As void// You can use this method in JavaScript.
- device
- DialDevice DialDevice DialDevice DialDevice
The remote device whose status you want to display.
- status
- DialDeviceDisplayStatus DialDeviceDisplayStatus DialDeviceDisplayStatus DialDeviceDisplayStatus
The status you want displayed.
Show(Rect) Show(Rect) Show(Rect) Show(Rect)
Displays the picker to the user. When called, the picker flies out from an edge of the provided rectangle.
public : void Show(Rect selection)public void Show(Rect selection)Public Function Show(selection As Rect) As void// You can use this method in JavaScript.
- See Also
Show(Rect, Placement) Show(Rect, Placement) Show(Rect, Placement) Show(Rect, Placement)
Displays the picker to the user. When called, the picker flies out from the specified edge of the provided rectangle.
public : void Show(Rect selection, Placement preferredPlacement)public void Show(Rect selection, Placement preferredPlacement)Public Function Show(selection As Rect, preferredPlacement As Placement) As void// You can use this method in JavaScript.
The edge from which you want the picker to show.
- See Also
Events
DialDevicePickerDismissed DialDevicePickerDismissed DialDevicePickerDismissed DialDevicePickerDismissed
Indicates that the device picker was light dismissed, which means that the user clicked or touched anywhere other than the picker UI, and so the picker will be closed.
public : event TypedEventHandler DialDevicePickerDismissed<DialDevicePicker, object>public event TypedEventHandler DialDevicePickerDismissed<DialDevicePicker, object>Public Event DialDevicePickerDismissed<DialDevicePicker, object>// You can use this event in JavaScript.
DialDeviceSelected DialDeviceSelected DialDeviceSelected DialDeviceSelected
Indicates that the user selected a device from the picker.
public : event TypedEventHandler DialDeviceSelected<DialDevicePicker, DialDeviceSelectedEventArgs>public event TypedEventHandler DialDeviceSelected<DialDevicePicker, DialDeviceSelectedEventArgs>Public Event DialDeviceSelected<DialDevicePicker, DialDeviceSelectedEventArgs>// You can use this event in JavaScript.
DisconnectButtonClicked DisconnectButtonClicked DisconnectButtonClicked DisconnectButtonClicked
Indicates that the user clicked on the disconnect button in the picker.
public : event TypedEventHandler DisconnectButtonClicked<DialDevicePicker, DialDisconnectButtonClickedEventArgs>public event TypedEventHandler DisconnectButtonClicked<DialDevicePicker, DialDisconnectButtonClickedEventArgs>Public Event DisconnectButtonClicked<DialDevicePicker, DialDisconnectButtonClickedEventArgs>// You can use this event in JavaScript.