Click or drag to resize

ShadeGroup Class

A group of shades. Allows simultaneous control of shades that are in group.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DeviceSupportDeviceGroupShadeBase
    Crestron.SimplSharpPro.DeviceSupportShadeGroup

Namespace: Crestron.SimplSharpPro.DeviceSupport
Assembly: Crestron.SimplSharpPro.DeviceSupport (in Crestron.SimplSharpPro.DeviceSupport.dll) Version: 2.21.121
Syntax
C#
public sealed class ShadeGroup : DeviceGroup<ShadeBase>

The ShadeGroup type exposes the following members.

Constructors
 NameDescription
Public methodShadeGroup Creates an instance of a shade group. Group ID can be from 1 to 252. Group IDs must be unique per transport. An exception will be thrown when an add is attempted if there is already a group that has this groups's ID and a shade and the shade is on the same transport as the shade that is being added to this group. The exception will be thrown during the add attempt.
Top
Properties
 NameDescription
Public propertyCount Gets the number of objects in the dictionary.
(Inherited from DeviceGroupT)
Public propertyDisposed Property to indicate if the device group has been disposed.
(Inherited from DeviceGroupT)
Public propertyID Group ID.
(Inherited from DeviceGroupT)
Public propertyLower Moves shades towards the lower limit or closed position.
Public propertyRaise Raises shades towards the upper limit or open position.
Public propertySetPosition Sends all shades that are in this group to a particular position at the same time. Will send the shades to a particular position where 0x0000 is the lower limit and 0xffff corresponds to the upper limit.
Top
Methods
 NameDescription
Public methodAdd Adds a device to this group. All devices added must be on the same transport (e.g. a controller's Cresnet interface, a controller's RF gateway, an RF gateway). The first device added (either after the device group is created or after all devices have been removed from the group) determines the the group designated transport that all other added devices must be on. Devices must implement the appropriate IGroupableDevice interface (e.g. IGroupableDevice for a ShadeGroup) for device group. Devices cannot be added to separate groups that have the same group ID number. No devices can be at ID 255 on the group designated transport. There can be up to 252 groups on each transport. Devices must be registered after they are added to group. Group ID numbers must be unique per transport. For example if two groups are created with the ID 5 and then one of two different devices that are on the same transport are added added to each group an exception will be thrown with the second add attempt because it will be detected that there is already a group at ID 5 on the transport. At that point the group can either be disposed or another device that is on a different transport can be added to it.
(Inherited from DeviceGroupT)
Public methodClear Clears group.
(Inherited from DeviceGroupT)
Public methodClose Closes all shades that are in this group at the same time. Will move the shades to the lower limit.
Public methodContains(T) Determines if this collection contains the specified value.
(Inherited from DeviceGroupT)
Public methodContains(UInt32) Determines if this collection contains the specified key.
(Inherited from DeviceGroupT)
Public methodDispose Dispose of the device group.
(Inherited from DeviceGroupT)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Device group destructor.
(Inherited from DeviceGroupT)
Public methodGetEnumerator Enumerator for the Crestron Collection.
(Inherited from DeviceGroupT)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodOpen Opens all shades that are in this group at the same time. Will move the shades to the upper limit.
Public methodRemove Removes a device from the device group.
(Inherited from DeviceGroupT)
Public methodStop Stops all shades that are in this group at the same time. Will stop all shades movement.
Public methodToString Returns the group type and group ID.
(Inherited from DeviceGroupT)
Top
Remarks
Shade firmware version 1.002.0198 or newer is required for shade groups.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also