Click or drag to resize

Mlx3 Class

Color LCD Handheld Wireless Remote MLX3 Device class
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Remotes
Assembly: Crestron.SimplSharpPro.Remotes (in Crestron.SimplSharpPro.Remotes.dll) Version: 2.21.121
Syntax
C#
public sealed class Mlx3 : Mlx3Base

The Mlx3 type exposes the following members.

Constructors
 NameDescription
Public methodMlx3 Constructor to generate a new MLX3 RF Remote
Top
Properties
 NameDescription
Public propertyBlue Get the Button object corresponding to the Blue button for this device.
(Inherited from Mlx3Base)
Public propertyButton Get the collection of the Button objects for this device.
(Inherited from Mlx3Base)
Public propertyChannelDown Get the Button object corresponding to the ChannelDown button for this device.
(Inherited from Mlx3Base)
Public propertyChannelUp Get the Button object corresponding to the ChannelUp button for this device.
(Inherited from Mlx3Base)
Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyCrestron Get the Button object corresponding to the Crestron button for this device.
(Inherited from Mlx3Base)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDialPadDown Get the Button object corresponding to the DialPadDown button for this device.
(Inherited from Mlx3Base)
Public propertyDialPadEnter Get the Button object corresponding to the DialPadEnter button for this device.
(Inherited from Mlx3Base)
Public propertyDialPadLeft Get the Button object corresponding to the DialPadLeft button for this device.
(Inherited from Mlx3Base)
Public propertyDialPadRight Get the Button object corresponding to the DialPadRight button for this device.
(Inherited from Mlx3Base)
Public propertyDialPadUp Get the Button object corresponding to the DialPadUp button for this device.
(Inherited from Mlx3Base)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyExit Get the Button object corresponding to the Exit button for this device.
(Inherited from Mlx3Base)
Public propertyExtenderBatteryReservedSigs Property to access the Battery functionality of the MLX3 Wireless Remote.
(Inherited from Mlx3Base)
Public propertyFastForward Get the Button object corresponding to the FastForward button for this device.
(Inherited from Mlx3Base)
Public propertyFavourite Get the Button object corresponding to the Favourite button for this device.
(Inherited from Mlx3Base)
Public propertyGreen Get the Button object corresponding to the Green button for this device.
(Inherited from Mlx3Base)
Public propertyGuide Get the Button object corresponding to the Guide button for this device.
(Inherited from Mlx3Base)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInformation Get the Button object corresponding to the Information button for this device.
(Inherited from Mlx3Base)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyKeypad0 Get the Button object corresponding to the Keypad0 button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad1 Get the Button object corresponding to the Keypad1 button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad2Abc Get the Button object corresponding to the Keypad2Abc button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad3Def Get the Button object corresponding to the Keypad3Def button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad4Ghi Get the Button object corresponding to the Keypad4Ghi button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad5Jkl Get the Button object corresponding to the Keypad5Jkl button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad6Mno Get the Button object corresponding to the Keypad6Mno button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad7Pqrs Get the Button object corresponding to the Keypad7Pqrs button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad8Tuv Get the Button object corresponding to the Keypad8Tuv button for this device.
(Inherited from Mlx3Base)
Public propertyKeypad9Wxyz Get the Button object corresponding to the Keypad9Wxyz button for this device.
(Inherited from Mlx3Base)
Public propertyKeypadAsteriskPeriod Get the Button object corresponding to the KeypadAsteriskPeriod button for this device.
(Inherited from Mlx3Base)
Public propertyKeypadPoundHyphen Get the Button object corresponding to the KeypadPoundHyphen button for this device.
(Inherited from Mlx3Base)
Public propertyLast Get the Button object corresponding to the Last button for this device.
(Inherited from Mlx3Base)
Public propertyLights Get the Button object corresponding to the Lights button for this device.
(Inherited from Mlx3Base)
Public propertyList Get the Button object corresponding to the List button for this device.
(Inherited from Mlx3Base)
Public propertyMedia Get the Button object corresponding to the Media button for this device.
(Inherited from Mlx3Base)
Public propertyMenu Get the Button object corresponding to the Menu button for this device.
(Inherited from Mlx3Base)
Public propertyMenuBack Get the Button object corresponding to the MenuBack button for this device.
(Inherited from Mlx3Base)
Public propertyMute Get the Button object corresponding to the Mute button for this device.
(Inherited from Mlx3Base)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNextTrack Get the Button object corresponding to the NextTrack button for this device.
(Inherited from Mlx3Base)
Public propertyPageActiveFeedback Parameter to return the page to be displayed. This will return an NULL until the panel does an Update.
(Inherited from WirelessPagedRemoteBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPause Get the Button object corresponding to the Pause button for this device.
(Inherited from Mlx3Base)
Public propertyPlay Get the Button object corresponding to the Play button for this device.
(Inherited from Mlx3Base)
Public propertyPower Get the Button object corresponding to the Power button for this device.
(Inherited from Mlx3Base)
Public propertyPreviousTrack Get the Button object corresponding to the PreviousTrack button for this device.
(Inherited from Mlx3Base)
Public propertyRecord Get the Button object corresponding to the Record button for this device.
(Inherited from Mlx3Base)
Public propertyRed Get the Button object corresponding to the Red button for this device.
(Inherited from Mlx3Base)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertyReplay Get the Button object corresponding to the Replay button for this device.
(Inherited from Mlx3Base)
Public propertyRewind Get the Button object corresponding to the Rewind button for this device.
(Inherited from Mlx3Base)
Public propertyScrollDown Get the Button object corresponding to the ScrollDown button for this device.
(Inherited from Mlx3Base)
Public propertyScrollSelect Get the Button object corresponding to the ScrollSelect button for this device.
(Inherited from Mlx3Base)
Public propertyScrollUp Get the Button object corresponding to the ScrollUp button for this device.
(Inherited from Mlx3Base)
Public propertyShowPage Parameter to set the page number to be displayed.
(Inherited from WirelessPagedRemoteBase)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyStop Get the Button object corresponding to the Stop button for this device.
(Inherited from Mlx3Base)
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Public propertyVolumeDown Get the Button object corresponding to the VolumeDown button for this device.
(Inherited from Mlx3Base)
Public propertyVolumeUp Get the Button object corresponding to the VolumeUp button for this device.
(Inherited from Mlx3Base)
Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Public propertyYellow Get the Button object corresponding to the Yellow button for this device.
(Inherited from Mlx3Base)
Top
Methods
 NameDescription
Public methodAddPage Method to add user configurable page to the corresponding collection. This will override and previous configuration for the specified number. The valid page numbers are from 3 to 254.
(Overrides WirelessPagedRemoteBaseAddPage(eWirelessRemotePageTypes, UInt32))
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitializeSlot1Event Initialize the wireless remote MLX3 global buttons and pages slot event.
(Inherited from Mlx3Base)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Protected methodOnButtonStateChange Method to fire the button state change event.
(Inherited from Mlx3Base)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodRemovePage Method to remove user configured page from the corresponding collection. The valid page numbers are from 3 to 254.
(Overrides WirelessPagedRemoteBaseRemovePage(UInt32))
Public methodReturnPageFlip Method to flip back through the sequence of previously viewed pages.
(Inherited from WirelessPagedRemoteBase)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister Unregister this device with the system. This function can not be called from the device's own SigChange event handler.

On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventButtonStateChange Event fired when a button state change was received from the device.
(Inherited from Mlx3Base)
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventMlx3PageStateChange Event triggered when the Crestron MLX3 reports information to the Control System.
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Protected fieldButtons Collection of button objects.
(Inherited from Mlx3Base)
Protected fieldNumberOfButtons The number of buttons on the device.
(Inherited from Mlx3Base)
Protected fieldRemoteGlobalButtonsAndPagesSlot Advanced Button Events slot device.
(Inherited from WirelessPagedRemoteBase)
Public fieldUserConfigurablePages User Configurable page collection for Crestron Wireless Remote
(Inherited from WirelessPagedRemoteBase)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also