Click or drag to resize

C2nLcdBXXBaseClass Class

Base class for the C2nLcdBx family of devices.

This class will trigger BaseEvent and SystemChange events.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.KeypadsC2nLcdBXXBaseClass
        Crestron.SimplSharpPro.KeypadsC2nLcdb3

Namespace: Crestron.SimplSharpPro.Keypads
Assembly: Crestron.SimplSharpPro.Keypads (in Crestron.SimplSharpPro.Keypads.dll) Version: 2.21.121
Syntax
C#
public class C2nLcdBXXBaseClass : GenericDevice, 
	IButton

The C2nLcdBXXBaseClass type exposes the following members.

Properties
 NameDescription
Public propertyBacklightControl The Backlight object.

This property will trigger BaseEvent event with C2nLcdBXXBaseClass.

Public propertyButton Get the collection of the Button objects for this device.
Public propertyClimateControl The Climate object.

This property will trigger BaseEvent event with C2nLcdBXXBaseClass.

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 propertyCurrentPageFeedback Property to report the number of the page currently displayed by the device. This property value is a numerical representation of the page currently displayed on the device screen.

This property will trigger BaseEvent event with CurrentPageFeedbackEventId.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDesiredPage Property to select the page we want the device to display. This property value is a numerical representation of the page we want the device to display when we pulse the property TriggerPageChange value.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
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 propertyLightingSystem The Lighting System object.

This property will trigger SystemChange event with LightingSystem.

Public propertyMediaControl The Media object.

This property will trigger BaseEvent event with C2nLcdBXXBaseClass.

Public propertyMiddle Get the Button object corresponding to the Middle button for this device.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyPageChangeInvalidFeedback Property to indicate that page number selected is invalid. This property value becomes 'true' momentarily and again becomes 'false', when TriggerPageChange value is pulsed and an invalid page number input to DesiredPage.

The BaseEvent event will trigger with PageChangeInvalidFeedbackEventId.

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.
Public propertyScreenSaverActiveFeedback Property to indicate the screen saver active status. This property value will be 'true' while the device’s screen is asleep and 'false' when the screen backlight is lit.

The BaseEvent event will trigger with ScreenSaverActiveFeedbackEventId.

Public propertyShadingSystem The Shading System object.

This property will trigger SystemChange event with ShadingSystem.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySuspendScreenUpdate Property to suspend the screen update. While 'true', this property will suppress any updates to the device’s screen. This is used at times when there are multiple pieces of information that you want to appear on the screen simultaneously, rather than see them filter in one at a time.
Public propertySystemSetup The Setup object.

This property will trigger BaseEvent event with C2nLcdBXXBaseClass.

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)
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 methodActivateScreenSaver Method to set the screen to go to “sleep”. This is basically forces a timeout. The unit will still wake up under normal circumstances.
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 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)
Top
Fields
 NameDescription
Public fieldStatic memberAmbientLightLevelFeedbackEventId The value of AmbientLightLevelFeedback property has changed.

The SystemChange event will trigger for this event id.

Public fieldStatic memberBottomLeftInfoButtonFeedbackEventId The state of BottomLeftInfoButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberBottomLeftListButtonFeedbackEventId The state of BottomLeftListButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberBottomLeftSelectionButtonFeedbackEventId The state of BottomLeftSelectionButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberBottomRightInfoButtonFeedbackEventId The state of BottomRightInfoButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberBottomRightSelectionButtonFeedbackEventId The state of BottomRightSelectionButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberBottomSelectionButtonFeedbackEventId The state of BottomSelectionButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberChangeFanModeFeedbackEventId The state of ChangeFanModeFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberChangeModeFeedbackEventId The state of ChangeModeFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCoolSetpointDownFeedbackEventId The state of CoolSetpointDownFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCoolSetpointUpFeedbackEventId The state of CoolSetpointUpFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCurrentPageFeedbackEventId The value of CurrentPageFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDayNightThresholdFeedbackEventId The value of DayNightThresholdFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberEngravedDayBacklightFeedbackEventId The value of EngravedDayBacklightFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberEngravedNightBacklightFeedbackEventId The value of EngravedNightBacklightFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberExternalTemperatureFeedbackEventId The value of ExternalTemperatureFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberHeatSetpointDownFeedbackEventId The state of HeatSetpointDownFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberHeatSetpointUpFeedbackEventId The state of HeatSetpointUpFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberInternalTemperatureFeedbackEventId The value of InternalTemperatureFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberListDownButtonFeedbackEventId The state of ListDownButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberListSelectButtonFeedbackEventId The state of ListSelectButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberListUpButtonFeedbackEventId The state of ListUpButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberLowerFeedbackEventId The state of LowerFeedback property has changed.

The SystemChange event will trigger for this event id.

The Index will define the index into the Loads collection.

Public fieldStatic memberLowerRoomFeedbackEventId The state of LowerRoomFeedback property has changed.

The SystemChange event will trigger for this event id.

Public fieldStatic memberPageChangeInvalidFeedbackEventId The state of PageChangeInvalidFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRaiseFeedbackEventId The state of RaiseFeedback property has changed.

The SystemChange event will trigger for this event id.

The Index will define the index into the Loads collection.

Public fieldStatic memberRaiseRoomFeedbackEventId The state of RaiseRoomFeedback property has changed.

The SystemChange event will trigger for this event id.

Public fieldStatic memberRecallSceneFeedbackEventId The state of RecallFeedback property has changed.

The SystemChange event will trigger for this event id.

The Index will define the index into the Scenes collection.

Public fieldStatic memberScreenDayBacklightFeedbackEventId The value of ScreenDayBacklightFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberScreenNightBacklightFeedbackEventId The value of ScreenNightBacklightFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberScreenSaverActiveFeedbackEventId The state of ScreenSaverActiveFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberScreenTimeoutFeedbackEventId The value of ScreenTimeoutFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTopInfoButtonFeedbackEventId The state of TopInfoButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTopLeftInfoButtonFeedbackEventId The state of TopLeftInfoButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTopLeftListButtonFeedbackEventId The state of TopLeftListButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTopLeftSelectionButtonFeedbackEventId The state of TopLeftSelectionButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTopRightInfoButtonFeedbackEventId The state of TopRightInfoButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTopRightSelectionButtonFeedbackEventId The state of TopRightSelectionButtonFeedback property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberVersionInformationFeedbackEventId The value of VersionInformationFeedback property has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also