[This is preliminary documentation and is subject to change.]
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class AdkProperties : IPropertyCollection
<SerializableAttribute> _ Public Class AdkProperties _ Implements IPropertyCollection
[SerializableAttribute] public ref class AdkProperties : IPropertyCollection
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | AdkPropertiesAdkPropertiesNew(AdkProperties) | Creates a properties object that inherits values from a parent |
| Contains(String) |
Determines if the collection contains a property with the specified key. It does not check the
parent properties class, so calling GetProperty with the specified key could still return a value.
|
 | Count |
Returns the count of all properties that are currently set in the collection
|
| Defaults(Object) | Called by the default constructor to set default property values.
Defaults are usually imported from the app.config file
|
| GetProperty(String, Int32) | Gets a property value as an int. The property is
inherited from this object's parent if not defined locally.
|
| GetProperty(String, Boolean) | Gets a property value as a boolean. The property is
inherited from this object's parent if not defined.
|
| GetProperty(String) | Overridden to inherit properties from parent |
| GetProperty(String, String) | Gets a property value as a String. The property is
inherited from this object's parent if not defined locally.
|
| Item[([String])] |
The indexer for the property collection
|
| Parent | Gets the parent object from which properties are inherited |
| Remove(String) |
Removes the property with the specified key
|
| SetProperty(String, Int32) | Sets an int property |
| SetProperty(String, Boolean) | Sets a boolean property |
| SetProperty(String, String) | Sets the value of a string property |
RemarksAdkProperties adds convenience methods to the Configuration.AppSettings class for getting and setting property values by data type. In addition, it overrides the getProperty method to inherit the property value from its parent if not defined locally. In the Adk, the properties of a zone are always inherited from the default properties of the agent.
Note that property inheritance is only provided by the getProperty method; no other superclass methods support inheritance. Thus, calling enumerating property elements does not include the properties of the parent object. Similarly, saving an AdkProperties to disk with the store method only writes the properties that are defined locally. When the properties are subsequently read from disk, they will not include the inherited properties of the parent object, nor will the object's relationship with its parent be re-established.
Inheritance Hierarchy| Object | ||
 | AdkProperties | |
 | TransportProperties | |
| AgentProperties | |