DeviceIdAttribute Class

An attribute for declaratively associating an assembly, class or property with an ASCOM device ID (and optionally, a display name).

Definition

Namespace: ASCOM
Assembly: ASCOM.Attributes (in ASCOM.Attributes.dll) Version: 7.1.3+4851.c5da65c2b
C#
public sealed class DeviceIdAttribute : Attribute
Inheritance
Object    Attribute    DeviceIdAttribute

Remarks

This attribute is intended for use in two main situations:
  1. Settings management and integration with Visual Studio designers – When this attribute is placed on the driver's Properties.Settings class, it propagates down to each of the settings properties. When the setting is passed to the ASCOM.SettingsProvider class at runtime, the settings provider looks for this attribute to determine which settings hive to save the value in when it is passed to Profile.
  2. Deployment – The values in this attribute could be used by an installer custom action to perform ASCOM registration during setup. Historically this has been handled programmatically, but there are trends towards a more declarative approach to deployment (for example WiX, Windows Installer Xml). It is expected that such an installer may need to obtain registration data by reflecting on the assemblies being installed. Placing this attribute at the assembly level will assist in this situation.

Constructors

DeviceIdAttribute Initializes a new instance of the DeviceIdAttribute class.

Properties

DeviceId Gets the ASCOM DeviceID, also known as the COM ProgID.
DeviceName Gets or sets the display name of the device. This would be the short display name, as displayed in the ASCOM Chooser.

See Also