Properties Class |
A container for settings - key/value pairs where keys are strings, and values are arbitrary objects.
Instances of this class are thread-safe.
Inheritance HierarchyNamespace: Altaxo.Main.Services
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
public sealed class Properties : INotifyPropertyChanged, ICloneable
The Properties type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Properties | Initializes a new instance of the Properties class. |
Properties| Name | Description | |
|---|---|---|
 | Count | Gets the number of stored entries. |
| DictionaryEntries | Gets the raw dictionary entries stored in this container. |
| IsDirty | Gets/Sets whether this properties container is dirty. IsDirty automatically gets set to true when a property in this container (or a nested container) changes. |
| Item | Retrieves a string value from this Properties-container. Using this indexer is equivalent to calling Get(key, string.Empty). |
| Keys | Gets the keys that are in use by this properties container. |
| Parent | Gets the parent property container. |
Methods| Name | Description | |
|---|---|---|
| Clone | Creates a deep clone of this Properties container. |
| Contains | Gets whether this properties instance contains any entry (value, list, or nested container) with the specified key. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Get(String, Properties) |
Obsolete nested-properties accessor. Use NestedProperties(String) instead.
Obsolete |
| GetT(String, T) | Retrieves a single element from this Properties-container. |
| GetT(String, T) |
Obsolete array-based accessor. Use GetList instead.
Obsolete |
| GetT(String, ArrayList) |
Obsolete ArrayList accessor. Use GetList instead.
Obsolete |
| GetT(String, ListT) |
Obsolete list-based accessor. Use GetList instead.
Obsolete |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetListT | Retrieves the list of items stored with the specified key. If no entry with the specified key exists, this method returns an empty list. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
 | Load(FileName) | Loads a properties container from the specified file. |
| Load(XElement) | Loads a properties container from the specified XML element. |
| NestedProperties | Retrieves a nested property container; creating a new one on demand. Multiple calls to this method will return the same instance (unless the entry at this key is overwritten by one of the Set-methods). Changes performed on the nested container will be persisted together with the parent container. |
| Remove | Removes the entry (value, list, or nested container) with the specified key. |
| Save | Saves the properties container to an XML element. |
| Save(FileName) | Saves the properties container to the specified file. |
| Set(String, Properties) |
Obsolete nested-properties mutator. Use SetNestedProperties instead.
Obsolete |
| SetT(String, T) | Sets a single element in this Properties-container. The element will be serialized using a TypeConverter if possible, or XAML serializer otherwise. |
| SetT(String, T) |
Obsolete array-based mutator. Use SetList instead.
Obsolete |
| SetT(String, ArrayList) |
Obsolete ArrayList mutator. Use SetList instead.
Obsolete |
| SetT(String, ListT) |
Obsolete list-based mutator. Use SetList instead.
Obsolete |
| SetListT | Sets a list of elements in this Properties-container. The elements will be serialized using a TypeConverter if possible, or XAML serializer otherwise. |
| SetNestedProperties | Attaches the specified properties container as nested properties. This method is intended to be used in conjunction with the IMementoCapable pattern where a new unattached properties container is created and then later attached to a parent container. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged | Occurs when a property value changes. |
Fields| Name | Description | |
|---|---|---|
 | FileVersion | Gets the version number of the XML file format. |
See Also