Click or drag to resize

ShadeDrapeController Class

Shade Drape Controller
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.ShadesShadeDrapeController
    Crestron.SimplSharpPro.LightingClsC6xBaseClsC6ShadeController

Namespace: Crestron.SimplSharpPro.Shades
Assembly: Crestron.SimplSharpPro.Shades (in Crestron.SimplSharpPro.Shades.dll) Version: 2.21.121
Syntax
C#
public class ShadeDrapeController : IParentInformation

The ShadeDrapeController type exposes the following members.

Properties
 NameDescription
Public propertyCloseMomentary Closes Shade toward the lower limit of travel when set to true, and stops when set to false On the C2nSdc or C2nSdcDc device, the shade will stop when MaxTime expires.
Public propertyJogTime Defines the period that Shade will jog open or jog closed. Valid values range from 0.05s (5) to 2s (200). Values above 2s will set the jog time to 2 seconds; values below 0.05s will set the jog time to 0.05s
Public propertyLastDirCloseFeedback Indicates that the current direction of movement is toward the lower limit. If not currently moving, indicates that the previous direction of movement was toward the lower limit.

The "BaseEvent" event will trigger with LastDirCloseFeedbackEventId.

The BaseEvent event will trigger with LastDirCloseFeedbackEventId for "ClsC6xBase.ClsC6ShadeController" and with Index will indicate the index into the "ClsC6xBase.ShadeGroups" collection.

Public propertyLastDirOpenFeedback Indicates that the current direction of movement is toward the upper limit. If not currently moving, indicates that the previous direction of movement was toward the upper limit.

The "BaseEvent" event will trigger with LastDirOpenFeedbackEventId.

The BaseEvent event will trigger with LastDirOpenFeedbackEventId for "ClsC6xBase.ClsC6ShadeController" and with Index will indicate the index into the "ClsC6xBase.ShadeGroups" collection.

Public propertyLockOutTime Defines the minimum period that Shade must remain in the stop state before changing directions. Valid values range from 0.2s (2) to 2s (200). The default is 1s. This property is only valid on the C2nSdc and C2nSdcDc devices.
Public propertyLowerLimitDown Close Shade while the input is true, and sets the lower travel limit when set to false.
Public propertyLowerLimitUp Opens Shade while the input is true, and sets the lower travel limit when set to false.
Public propertyMaxTime Defines the maximum period that Shade will operate while opening or closing. Valid values range from 10 seconds to 360 seconds (6 minutes). The default is 10 seconds. This property is only valid on the C2nSdc and C2nSdcDc devices.
Public propertyMovingFeedback Sig to indicate that the shade is moving.

The "BaseEvent" event will trigger with MovingFeedbackEventId.

The BaseEvent event will trigger with MovingFeedbackEventId for "ClsC6xBase.ClsC6ShadeController" and with Index will indicate the index into the "ClsC6xBase.ShadeGroups" collection.

Public propertyNotPresentFeedback Indicates if the shade is present or not.

The "BaseEvent" event will trigger with NotPresentEventId.

Public propertyNumber Controller number
Public propertyOpenMomentary Opens Shade toward the upper limit of travel when set to true, and stops when set to false On the C2nSdc or C2nSdcDc device, the shade will stop when MaxTime expires.
Public propertyParent The parent that a given object was added to.
Public propertyPosition Sets the position of the Shade relative to the full range of travel between the upper and lower limits. Valid values range from 0d to 65,535d (upper limit), which is 0000h to FFFFh (upper limit). Note: Only the most significant bits affect the position. 0000h = No movement 00xxh (where xx is any value between 01 and FF) = Lower limit FFxxh (where xx is any value between 01 through FF) = Upper limit This property is only valid on the C2nSsc2 device.
Public propertyPositionFeedback Indicates the position of Shade when ReportPosition is set to true, and all subsequent changes in position for as long as ReportPosition is set to true. Reported values range from 0 to 65,535 (upper limit), which is 0000h to FFFFh (upper limit).

The "BaseEvent" event will trigger with PositionFeedbackEventId.

The BaseEvent event will trigger with PositionFeedbackEventId for "ClsC6xBase.ClsC6ShadeController" and with Index will indicate the index into the "ClsC6xBase.ShadeGroups" collection.

Public propertyPresetNumber Sets the preset number for which a position will be saved when the SetPreset is called or recalled when the RecallPreset is called. This property is only valid on the C2nSsc2 device.
Public propertyReportPosition Reports the position of the Shade via the PositionFeedback when set to true. Subsequent changes in position continue to be reported for as long as the input remains true.
Public propertyUpperLimitDown Close Shade while the input is true, and sets the upper travel limit when set to false.
Public propertyUpperLimitUp Opens Shade while the input is true, and sets the upper travel limit when set to false.
Public propertyUserSpecifiedObject User specified object.
Top
Methods
 NameDescription
Public methodClose Closes shade to the lower limit of travel On the C2nSdc or C2nSdcDc device, the shade will stop when MaxTime expires or Stop is called.
Public methodCloseJog Closes Shade toward the lower limit of travel for JogTime seconds.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
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)
Public methodOpen Opens Shade to the upper limit of travel. On the C2nSdc or C2nSdcDc device, the shade will stop when MaxTime expires or Stop is called.
Public methodOpenJog Opens Shade toward the upper limit of travel for JogTime seconds.
Public methodRecallPreset Moves the Shade to the stored position corresponding to preset number given by PresetNumber The has no effect if the PresetNumber is invalid, or if the preset has no position stored.
Public methodReverse Reverses the direction of motor rotation.Reversing the rotation will set the upper and lower limits to the current position of the shade. For this reason the upper and lower limits must be reset after the reverse command is triggered.
Public methodSetPreset Stores the current position of Shade to the preset number given by PresetNumber
Public methodStop Stops the shade movement
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also