Click or drag to resize

Vpg24Base Class

Base class for VPG-24 panel.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.UIVpg24Base
        Crestron.SimplSharpPro.UIVpg24

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public class Vpg24Base : GenericDevice

The Vpg24Base type exposes the following members.

Constructors
 NameDescription
Protected methodVpg24Base Constructor for instantiating VPG24Base object.
Top
Properties
 NameDescription
Public propertyAutoModeFeedback Indicates that the panel is currently set to auto mode.

The output remains true for as long as the panel is in auto mode.

AutoModeFeedbackEventID is triggered for this property.

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 propertyFingerOnlyModeFeedback Property to indicate the finger only mode is active.

The output will remain true for as long as finger only mode is active.

FingerOnlyModeFeedbackEventID is triggered for this property.

Public propertyHidUseAlternate Property to select the destination Alternate where HID data will be sent. The selection will be active for as long as the input is true.

If both UseDmNetForHid and HidUseAlternate inputs are true, the DM Net address takes precedence.

HID data includes touch output data, and, if HidUseKm = false, keyboard/mouse data.

When set to "Alternate", the HID data will be routed to the alternate address specified by UsbAlternateHidControl

Public propertyHidUseAlternateFeedback Property to indicate HID use alternate feedback status.

Indicates the current HID destination is Alternate.

The output remains true for as long as the address is active.

HidUseAlternateFeedbackEventID is triggered for this property.

Public propertyHidUseKm Property to select the destination where keyboard/mouse (KM) data will be sent, as follows:

When the input is true, the KM data will be sent to the address specified by UsbKmHidControl. This will break out the KM data to the VMK-WIN.

When the input is false, the KM data will be sent to the "DM Net" address (when UseDmNetForHidFeedback = true) or the "Alternate" address (when HidUseAlternateFeedback= true).

Public propertyHidUseKmFeedback

Indicates the current HID keyboard/mouse setting.

The output remains true for as long as the setting is selected.

true = Breakaway destination selected.

false = DM Net or Alternate destination selected

HidUseKmFeedbackEventID is triggered for this property.

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 propertyLcdBrightness Property to set the LCD brightness.

Sets the LCD brightness level from 0% (0d) to 100% (65535d).

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.
Public propertyLcdBrightnessDown

Lowers the LCD backlight brightness by 1% on each pulse

If the input remains true for 0.5 seconds, the LCD backlight brightness will auto-decrement until the input goes false or until it reaches the minimum value of 0%.

Public propertyLcdBrightnessFeedback Property to report the LCD brightness level.

LcdBrightnessFeedbackEventIDis triggered for this property.

Public propertyLcdBrightnessUp

Raises the LCD backlight brightness by 1% on each pulse.

If the input remains true for 0.5 seconds, the LCD backlight brightness will auto-increment until the input goes false or until it reaches the maximum value of 100%.

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 propertyPenFingerModeFeedback Property to indicate the pen finger mode is active.

Indicates that the panel is set to dual mode. The output remains true for as long as dual mode is active.

PenFingerModeFeedbackEventID is triggered for this property.

Public propertyPenOffDockFeedback

Indicates that the pen is currently undocked. The output remains true for as long as the pen is undocked.

PenOffDockFeedbackEventID is triggered for this property.

Public propertyPenOnDockFeedback

Indicates that the pen is currently docked. The output remains true for as long as the pen is docked.

PenOnDockFeedbackEventID is triggered for this property.

Public propertyPenOnlyModeFeedback Property to indicate the pen only mode is active.

The output will remain true for as long as pen only mode is active

PenOnlyModeFeedbackEventID is triggered for this property.

Public propertyRebootButtonHeldFeedback

Indicates that the hardkey on the V-Panel is pressed.

The output remains true for the duration of the button press.

RebootButtonHeldFeedbackEventID is triggered for this property.

Public propertyRebootRequestedFeedback

Indicates that the hardkey on the V-Panel has been pressed for 5 seconds, thereby requesting a reboot of the V-Panel.

The output will pulse when the reboot request is received.

RebootRequestedFeedbackEventID is triggered for this property.

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)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySleepWakeManager Sleep wake manager.
Public propertySourceDigitalHdcpSourceFeedback

Indicates the presence of HDCP. The output remains true for as long as HDCP is detected.

SourceDigitalHdcpSourceFeedbackEventID is triggered for this property.

Public propertySourceDigitalNoInputFlagFeedback

Indicates that there is no HDMI source being routed to the DM input of the V-Panel. The output remains true for as long as no digital source is detected.

SourceDigitalNoInputFlagFeedbackEventID is triggered for this property.

Public propertySourceFramesPerSecondFeedback Property to report the frame rate of the input source in 0.01 Hertz (1d = 0.01 Hz), e.g., 4989d = 49.89Hz.

Reported values range from 0d to 8500d.

SourceFramesPerSecondFeedbackEventID is triggered for this property.

Public propertySourceHorizontalResolutionFeedback Property to report the horizontal resolution of the input source in pixels (1d = 1 pixel). Reported values range from 0d to 1920d.

SourceHorizontalResolutionFeedbackEventID is triggered for this property.

Public propertySourceVerticalResolutionFeedback Property to report the vertical resolution of the input source in lines (1d = 1 line}. Reported values range from 0d to 1200d.

SourceVerticalResolutionFeedbackEventID is triggered for this property.

Public propertySourceVideoIsInterlacedFeedback Indicates that the digital video source is interlaced.

SourceVideoIsInterlacedFeedbackEventID is triggered for this property.

Public propertySourceVideoLockedStatusFeedback Indicates that the video image has been locked. The output remains true for as long as the video is locked. When the output is false, this indicates no picture.

SourceVideoLockedStatusFeedbackEventID is triggered for this property.

Public propertyStandbyTimeout Property to set the standby timeout (1d = 1 minute). The standby timeout is the period from the last use of the touchscreen before going into standby mode (screen display is off but power is on). Valid values range from 0d (no standby timeout) to 120d (120 minutes)
Public propertyStandbyTimeoutDown

Decrements the screen display standby timeout by one minutes with each pulse.

If the input remains true for 0.5 seconds, the standby timeout period will auto-decrement until the input goes false or until it reaches 0 minutes.

Public propertyStandbyTimeoutFeedback Property to report the standby timeout period.

StandbyTimeoutFeedbackEventIDis triggered for this property.

Public propertyStandbyTimeoutUp

Increments the screen display standby timeout by one minute with each pulse.

If the input remains true for 0.5 seconds,the standby timeout period will auto-increment until the input goes false or until it reaches the maximum value of 120 minutes.

Public propertyTouchCalibrationCompleteFeedback Property to indicate touch calibration complete feedback status.

Pulses to indicate that the touch calibration procedure is complete or has timed out.

TouchCalibrationCompleteFeedbackEventID is triggered for this property.

Public propertyTouchCalibrationFailFeedback Property to report the result of the touch calibration procedure.

When "Fail" is true, this indicates that calibration failed.

The output remains true until TouchCalibrationStart is set to true again.

TouchCalibrationFailFeedbackEventID is triggered for this property.

Public propertyTouchCalibrationInProgressFeedback Property to report that the touch calibration procedure is in progress.

The output becomes true when TouchCalibrationStart is set to true and remains true for as long as the procedure is in progress.

TouchCalibrationInProgressFeedbackEventID is triggered for this property.

Public propertyTouchCalibrationPassFeedback Property to report the result of the touch calibration procedure.

When "Pass" is true, this indicates that calibration was successful.

The output remains true until TouchCalibrationStart is set to true again.

TouchCalibrationPassFeedbackEventID is triggered for this property.

Public propertyTouchCalibrationPositionXFeedback Property to report the current X coordinates of the icon during touch calibration.

TouchCalibrationPositionXFeedbackEventIDis triggered for this property.

Public propertyTouchCalibrationPositionYFeedback Property to report the current coordinates of the icon during touch calibration.

TouchCalibrationPositionYFeedbackEventIDis triggered for this property.

Public propertyTouchCalibrationStartFeedback Property to indicate touch calibration start feedback status.

Indicates that touch calibration has been initiated by a console command. The output remains true for as long as touch calibration is in progress.

TouchCalibrationStartFeedbackEventID is triggered for this property.

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 propertyUsbAlternateHidControl Property to set the destination for HID data when the address is set to "Alternate" (HidUseAlternateFeedback = true).
Public propertyUsbAlternateHidControlFeedback Property to report the current Alternate address.

UsbAlternateHidControlFeedbackEventID is triggered for this property.

Public propertyUsbDeviceDetectedFeedback Indicates that a device is connected at the USB HID port. The output remains true for as long as the device is detected.

UsbDeviceDetectedFeedbackEventID is triggered for this property.

Public propertyUsbHidControl Property to set the destination for HID data when the address is set to "DM Net" (UseDmNetForHidFeedback = true).
Public propertyUsbHidControlFeedback Property to report the current HID address.

UsbHidControlFeedbackEventID is triggered for this property.

Public propertyUsbKmHidControl Property to set the destination for HID data when the address is set to "KM" (HidUseKmFeedback = true). This address is used when the KM data is broken out to a VMK-WIN. This input should be connected to the corresponding output (UsbHidControl) of the VMK-WIN Configuration slot.
Public propertyUsbKmHidControlFeedback Property to report the current KM address.

UsbKmHidControlFeedbackEventID is triggered for this property.

Public propertyUseDmNetForHid Property to select the destination DM Net where HID data will be sent. The selection will be active for as long as the input is true.

If both UseDmNetForHid and HidUseAlternate inputs are true, the DM Net address takes precedence.

HID data includes touch output data, and, if HidUseKm = false, keyboard/mouse data.

When set to "DM Net", the HID data will be routed via DM Net to the address specified by UsbHidControl

Public propertyUseDmNetForHidFeedback Property to indicate Use DM Net for HID feedback status.

Indicates the current HID destination (DM Net).

The output remains true for as long as the address is active.

UseDmNetForHidFeedbackEventID is triggered for this property.

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 methodAutoModeOn

Sets the panel to auto mode.

In auto mode, the panel will auto-detect the docked status of the pen (which is physically mounted to the side of the V-Panel) as follows:

When docked(PenOnDockFeedback = true), this will enable finger mode.

When undocked(PenOffDockFeedback = true), this will enable pen mode.

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 methodFingerOnlyModeOn

Sets the panel to finger only mode.

When set to finger mode, the panel will only respond to touch input and the pen will not work.

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 methodPenFingerModeOn

Sets the panel to dual mode.

When dual mode is active, the panel will recognize both finger and pen input.

Public methodPenOnlyModeOn

Sets the panel to pen only mode.

When set to pen mode, the panel will only respond to pen input and the finger input will not work.

Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodTouchCalibrationStart

Puts the V-Panel into touch calibration mode.

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 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 memberAutoModeFeedbackEventID Event ID for AutoModeFeedback change event.
Public fieldStatic memberFingerOnlyModeFeedbackEventID Event ID for FingerOnlyModeFeedback change event.
Public fieldStatic memberHidUseAlternateFeedbackEventID Event ID for HidUseAlternateFeedback change event.
Public fieldStatic memberHidUseKmFeedbackEventID Event ID for HidUseKmFeedback change event.
Public fieldStatic memberLcdBrightnessFeedbackEventID Event ID for LcdBrightnessFeedback change event.
Public fieldStatic memberPenFingerModeFeedbackEventID Event ID for PenFingerModeFeedback change event.
Public fieldStatic memberPenOffDockFeedbackEventID Event ID for PenOffDockFeedback change event.
Public fieldStatic memberPenOnDockFeedbackEventID Event ID for PenOnDockFeedback change event.
Public fieldStatic memberPenOnlyModeFeedbackEventID Event ID for PenOnlyModeFeedback change event.
Public fieldStatic memberRebootButtonHeldFeedbackEventID Event ID for RebootButtonHeldFeedback change event.
Public fieldStatic memberRebootRequestedFeedbackEventID Event ID for RebootRequestedFeedback change event.
Public fieldStatic memberSourceDigitalHdcpSourceFeedbackEventID Event ID for SourceDigitalHdcpSourceFeedback change event.
Public fieldStatic memberSourceDigitalNoInputFlagFeedbackEventID Even ID for SourceDigitalNoInputFlagFeedback change event.
Public fieldStatic memberSourceFramesPerSecondFeedbackEventID Event ID for SourceFramesPerSecondFeedback change event.
Public fieldStatic memberSourceHorizontalResolutionFeedbackEventID Event ID for SourceHorizontalResolutionFeedback change event.
Public fieldStatic memberSourceVerticalResolutionFeedbackEventID Event ID for SourceVerticalResolutionFeedback change event.
Public fieldStatic memberSourceVideoIsInterlacedFeedbackEventID Event ID for SourceVideoIsInterlacedFeedback change event.
Public fieldStatic memberSourceVideoLockedStatusFeedbackEventID Event ID for SourceVideoLockedStatusFeedback change event.
Public fieldStatic memberStandbyTimeoutFeedbackEventID Event ID for StandbyTimeoutFeedback change event.
Public fieldStatic memberTouchCalibrationCompleteFeedbackEventID Event ID for TouchCalibrationCompleteFeedback change event.
Public fieldStatic memberTouchCalibrationFailFeedbackEventID Event ID for TouchCalibrationFailFeedback change event.
Public fieldStatic memberTouchCalibrationInProgressFeedbackEventID Event ID for TouchCalibrationInProgressFeedback change event.
Public fieldStatic memberTouchCalibrationPassFeedbackEventID Event ID for TouchCalibrationPassFeedback change event.
Public fieldStatic memberTouchCalibrationPositionXFeedbackEventID Event ID for TouchCalibrationPositionXFeedback change event.
Public fieldStatic memberTouchCalibrationPositionYFeedbackEventID Event ID for TouchCalibrationPositionYFeedback change event.
Public fieldStatic memberTouchCalibrationStartFeedbackEventID Event ID for TouchCalibrationStartFeedback change event.
Public fieldStatic memberUsbAlternateHidControlFeedbackEventID Event ID for UsbAlternateHidControlFeedback change event.
Public fieldStatic memberUsbDeviceDetectedFeedbackEventID Event ID for UsbDeviceDetectedFeedbackchange event.
Public fieldStatic memberUsbHidControlFeedbackEventID Event ID for UsbHidControlFeedback change event.
Public fieldStatic memberUsbKmHidControlFeedbackEventID Event ID for UsbKmHidControlFeedback change event.
Public fieldStatic memberUseDmNetForHidFeedbackEventID Event ID for UseDmNetForHidFeedback change event.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also