DeviceIdAttribute Class

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

Inheritance Hierarchy

SystemObject
SystemAttribute
ASCOMDeviceIdAttribute

Namespace: ASCOM
Assembly: ASCOM.Attributes (in ASCOM.Attributes.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484

Syntax

public sealed class DeviceIdAttribute : Attribute

Public NotInheritable Class DeviceIdAttribute
	Inherits Attribute

public ref class DeviceIdAttribute sealed : public Attribute

The DeviceIdAttribute type exposes the following members.

Constructors

	Name	Description
	DeviceIdAttribute	Initializes a new instance of the DeviceIdAttribute class.

Properties

	Name	Description
	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.

Remarks

This attribute is intended for use in two main situations:

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.
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.