Click or drag to resize

TsrBase Class

Smart Graphics based WiFi touch screen remote control device base
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public class TsrBase : BasicTriListWithSmartObject, ITP42TSR302Button, 
	IButton

The TsrBase type exposes the following members.

Constructors
 NameDescription
Protected methodTsrBase(String, UInt32, CrestronControlSystem, Int32) Constructor for base class of TSR 3XX panel based remote device.
Protected methodTsrBase(String, UInt32, GatewayBase, Int32) Constructor for base class of TSR 3XX panel based remote device.
Top
Properties
 NameDescription
Public propertyBlue Get the Button object corresponding to the Blue button for this device.
Public propertyBooleanInput Collection of Boolean Inputs sent to the device.
(Inherited from BasicTriList)
Public propertyBooleanOutput Collection of Boolean Outputs received from the device.
(Inherited from BasicTriList)
Public propertyButton Get the collection of the Button objects for this device.
Public propertyChannelDown Get the Button object corresponding to the ChannelDown button for this device.
Public propertyChannelUp Get the Button object corresponding to the ChannelUp button for this device.
Public propertyClear Get the Button object corresponding to the Clear button for this device.
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 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.
Public propertyDialPadLeft Get the Button object corresponding to the DialPadLeft button for this device.
Public propertyDialPadRight Get the Button object corresponding to the DialPadRight button for this device.
Public propertyDialPadSelect Get the Button object corresponding to the DialPadSelect button for this device.
Public propertyDialPadUp Get the Button object corresponding to the DialPadUp button for this device.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyDvr Get the Button object corresponding to the Dvr button for this device.
Public propertyEnter Get the Button object corresponding to the Enter button for this device.
Public propertyExit Get the Button object corresponding to the Exit button for this device.
Public propertyExtenderAuthenticationReservedSigs Extender to access the authentication functionality on this device

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderAutoUpdateReservedSigs Property to access the Auto Update functionality of the TSR-3XX Touch Panel.
Public propertyExtenderSystem3ReservedSigs Property to access the System3 functionality of the TSR-3XX Touch Panel.
Public propertyExtenderSystemReservedSigs Property to access the System functionality of the TSR-XXX Touch Panel.
Public propertyExtenderTouchDetectionReservedSigs Extender to access the touch detection functionality on this device.

This property will trigger DeviceExtenderSigChange event.

Public propertyExtenderVoiceControlReservedSigs Property to access the Voice Control functionality of the TSR-3XX Touch Panel.
Public propertyFastForward Get the Button object corresponding to the FastForward button for this device.
Public propertyGreen Get the Button object corresponding to the Green button for this device.
Public propertyGuide Get the Button object corresponding to the Guide button for this device.
Public propertyHome Get the Button object corresponding to the Home button for this device.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInfo Get the Button object corresponding to the Info button for this device.
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLast Get the Button object corresponding to the Last button for this device.
Public propertyMenu Get the Button object corresponding to the Menu button for this device.
Public propertyMute Get the Button object corresponding to the Mute button for this device.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumber0 Get the Button object corresponding to the Number0 button for this device.

This property is not supported on TSR-310.

Public propertyNumber1 Get the Button object corresponding to the Number1 button for this device.

This property is not supported on TSR-310.

Public propertyNumber2 Get the Button object corresponding to the Number2 button for this device.

This property is not supported on TSR-310.

Public propertyNumber3 Get the Button object corresponding to the Number3 button for this device.

This property is not supported on TSR-310.

Public propertyNumber4 Get the Button object corresponding to the Number4 button for this device.

This property is not supported on TSR-310.

Public propertyNumber5 Get the Button object corresponding to the Number5 button for this device.

This property is not supported on TSR-310.

Public propertyNumber6 Get the Button object corresponding to the Number6 button for this device.

This property is not supported on TSR-310.

Public propertyNumber7 Get the Button object corresponding to the Number7 button for this device.

This property is not supported on TSR-310.

Public propertyNumber8 Get the Button object corresponding to the Number8 button for this device.

This property is not supported on TSR-310.

Public propertyNumber9 Get the Button object corresponding to the Number9 button for this device.

This property is not supported on TSR-310.

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.
Public propertyPlay Get the Button object corresponding to the Play button for this device.
Public propertyPower Get the Button object corresponding to the Power button for this device.
Public propertyRecord Get the Button object corresponding to the Record button for this device.
Public propertyRed Get the Button object corresponding to the Red button for this device.
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 propertyRewind Get the Button object corresponding to the Rewind button for this device.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySkipBack Get the Button object corresponding to the SkipBack button for this device.
Public propertySkipForward Get the Button object corresponding to the SkipForward button for this device.
Public propertySmartObjects Collection containing the loaded SmartObjects of this device.
(Inherited from BasicTriListWithSmartObject)
Public propertyStop Get the Button object corresponding to the Stop button for this device.
Public propertyStringInput Collection of String Inputs sent to the device.
(Inherited from BasicTriList)
Public propertyStringOutput Collection of String Outputs received from the device.
(Inherited from BasicTriList)
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 propertyUShortInput Collection of Integer Inputs sent to the device.
(Inherited from BasicTriList)
Public propertyUShortOutput Collection of Integer Outputs received from the device.
(Inherited from BasicTriList)
Public propertyVolumeDown Get the Button object corresponding to the VolumeDown button for this device.
Public propertyVolumeUp Get the Button object corresponding to the VolumeUp button for this device.
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.
Top
Methods
 NameDescription
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)
Public methodCode exampleLoadSmartObjects(ISmartObject) Load the smart objects to this device that are already loaded for the specified device.
(Inherited from BasicTriListWithSmartObject)
Public methodCode exampleLoadSmartObjects(Stream) Load a smart object given a reference to a stream for the SGD file.
(Inherited from BasicTriListWithSmartObject)
Public methodCode exampleLoadSmartObjects(String) Load a smart object given a SGD Filename with an absolute path.
(Inherited from BasicTriListWithSmartObject)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
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)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
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.
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 eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Public eventSigChange Event triggered when cue information is received from a device. When processing this event, it will hold off other cues from being received from the device. If one desires to continue processing the data and receive more information, launch a new thread and allow this event to exit.
(Inherited from BasicTriList)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also