Click or drag to resize

Tss5Button Class

Base class for Touchscreens: Tss752 Touch Panel to define the common buttons with BasicTrilist and common Reserved Sigs

This class will trigger SigChange, ButtonStateChange and DeviceExtenderSigChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.DeviceSupport
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class Tss5Button : BasicTriListWithSmartObject, ITP5TSSButton, 
	IButton

The Tss5Button type exposes the following members.

Properties
 NameDescription
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 propertyClose Get the Button object corresponding to the Close 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 propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyDown Get the Button object corresponding to the Down button for this device.
Public propertyExtenderAudioReservedSigs Property to access the Audio functionality of the TSX, FT Family Touch Panels and TSS 752 Touch Panel.

This property will trigger DeviceExtenderSigChange for sigs defined in TsxCcsUcCodec100AudioReservedSigs.

Public propertyExtenderAutoUpdateReservedSigs Property to access the Auto Update functionality of the TSS 752 Touch Panel.

This property will trigger DeviceExtenderSigChange for sigs defined in AutoUpdateReservedSigs.

Public propertyExtenderEthernetReservedSigs Property to access the Ethernet functionality of the TSX, FT Family Touch Panels and TSS 752 Touch Panel.

This property will trigger DeviceExtenderSigChange for sigs defined in TsxCcsUcCodec100EthernetReservedSigs.

Public propertyExtenderScreenSaverReservedSigs Property to access the Screen Saver functionality of the TSS 752 Touch Panel.

This property will trigger DeviceExtenderSigChange for sigs defined in TsxScreenSaverReservedSigs.

Public propertyExtenderSystem3ReservedSigs Property to access the System3 functionality of the TSS 752 Touch Panel.

This property will trigger DeviceExtenderSigChange for sigs defined in Tss752System3ReservedSigs.

Public propertyExtenderSystemReservedSigs Property to access the System functionality of the TSX, FT Family Touch Panels and TSS 752 Touch Panel.

This property will trigger DeviceExtenderSigChange for sigs defined in TswFtSystemReservedSigs.

Public propertyExtenderVoipReservedSigs Property to access the VOIP functionality of the TSS 752 Touch Panel.

This property will trigger DeviceExtenderSigChange for sigs defined in Tss752VoipReservedSigs.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLeft Get the Button object corresponding to the Left button for this device.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
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 propertyRight Get the Button object corresponding to the Right button for this device.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySmartObjects Collection containing the loaded SmartObjects of this device.
(Inherited from BasicTriListWithSmartObject)
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 propertyUp Get the Button object corresponding to the Up button for this device.
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)
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)
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 triggered when the Button reports information to the Control System.

Valid Button States are available in eButtonState.

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