Instance Members

<< Click to Display Table of Contents >>

Navigation: Reference > BNCS Namespace > Instance Class >

Instance Members

The Instance type exposes the following members.

Constructors

	Name	Description
	Instance	Constructor for creating an Instance object with the given XElement document.

Methods

	Name	Description
	BuildSettings	(Inherited from BaseSettingsElement.)
	GetChildInstance	Retrieves a child instance based on the provided InstanceId.
	GetSetting(String)	Retrieves the value of a setting based on the provided SettingId. (Inherited from BaseSettingsElement.)
	GetSetting(String, String)	Retrieves a setting value based on the provided SettingId. If the setting is not found, the defaultValue is returned. (Inherited from BaseSettingsElement.)
	GetSetting<T>(String)	Retrieves a setting value of type T based on the provided SettingId. (Inherited from BaseSettingsElement.)
	GetSetting<T>(String, T)	Retrieves a setting value of type T from the settings dictionary. If the setting does not exist, returns the default value provided. (Inherited from BaseSettingsElement.)
	SafeReadAttribute	Safely reads the value of the specified attribute from the XML document. (Inherited from BaseElement.)
	ToString	Returns a string representation of the Instance object.
	TryGetChildInstance	Tries to get the child instance with the specified InstanceId.
	TryGetSetting(String, String)	Tries to get the value of a setting based on the provided SettingId. (Inherited from BaseSettingsElement.)
	TryGetSetting<T>(String, T)	Tries to get the setting value for the specified SettingId. (Inherited from BaseSettingsElement.)

Properties

	Name	Description
	Alt_Id	Gets the value of the "alt_id" attribute.
	ChildInstances	Gets the list of child instances associated with this object.
	Composite	Gets a value indicating whether the element is composite.
	DeviceId	Gets the device ID from the XML attribute "ref"
	Id	Gets the value of the "id" attribute from the XML element.
	InstanceType	Gets the value of the "type" attribute from the XML element.
	Location	Gets the value of the "location" attribute from the XML element.
	Managed	Gets or sets a value indicating whether the object is managed.
	Offset	Gets the offset value from the "ref" attribute by parsing the string using a regular expression.
	Parameters	Gets the parameters for the BNCS instance.
	Settings	Gets the settings dictionary. (Inherited from BaseSettingsElement.)

See Also