Properties Class

Definition

A collection of properties for a node. Properties allow you to store arbitrary data against a node and will be copying during calls to Copy(). Properties can have a single value or multiple values.

public sealed class Properties : IEnumerable<KeyValuePair<String, Object>>, IEnumerable, IEquatable<Properties>

View source

Properties

Name	Description
`Count`	The number of properties in the collection.

Methods

Name	Description
`AddRangeToMultiple<T>(String, IEnumerable<T>)`	Adds values to a multiple valued property with the specified key.
`AddToMultiple<T>(String, T)`	Adds a value to a multiple valued property with the specified key.
`ContainsKey(String)`	Tests whether a property exists with the specified key.
`Equals(Properties)`	Returns `true` if this collection equals another collection, `false` otherwise. Collections are equal if they have the same property keys, and the values for each key are single or multiple valued to match, have the same type and are equal, using `Equals(Object)` for single values and element-wise for multiple values.
`Equals(Object)`	Determines whether the specified object is equal to the current object.
`GetEnumerator()`	Returns an enumerator that enumerates over the properties. Returns the name as the key and an untyped object for the value. This will be the object itself for single value properties and a `List<T>` of objects for multiple value properties.
`GetHashCode()`	Returns a hash code for this collection consistent with `Equals(Properties)`, based on the number of properties.
`GetMultiple<T>(String)`	Gets the values of a multiple valued property with the specified key.
`GetOrAdd<T>(String, Func<String, T>)`	Gets the value of a single valued property with the specified key or returns a default value if the property does not exist.
`GetOrDefault<T>(String, T)`	Gets the value of a single valued property with the specified key or returns a default value if the property does not exist.
`GetOrThrow<T>(String)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist.
`GetOrThrow<T>(String, T)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist. Uses a field to cache the value for better performance.
`GetOrThrow<T>(String, T?)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist. Uses a field to cache the value for better performance.
`GetOrThrow<T>(String, Func<Exception>)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist.
`GetOrThrow<T>(String, T, Func<Exception>)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist. Uses a field to cache the value for better performance.
`GetOrThrow<T>(String, T?, Func<Exception>)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist. Uses a field to cache the value for better performance.
`GetOrThrow<T>(String, Func<String, Exception>)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist.
`GetOrThrow<T>(String, T, Func<String, Exception>)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist. Uses a field to cache the value for better performance.
`GetOrThrow<T>(String, T?, Func<String, Exception>)`	Gets the value of a single valued property with the specified key or throws an exception if the property does not exist. Uses a field to cache the value for better performance.
`Set<T>(String, T)`	Sets the value of a single valued property with the specified key.
`Set<T>(String, T, T)`	Sets the value of a single valued property with the specified key. Uses a field to cache the value for better performance.
`Set<T>(String, T, T?)`	Sets the value of a single valued property with the specified key. Uses a field to cache the value for better performance.
`SetMultiple<T>(String, IEnumerable<T>)`	Sets the values of a multiple valued property with the specified key. Any existing values are replaced.
`TryAddToMultiple<T>(String, T, IEqualityComparer<T>)`	Tries to add a value to a multiple valued property with the specified key. If the value already exists in the multiple then it is not added.
`TryGet<T>(String, T)`	Tries to get the value of a single valued property with the specified key.

Operators

Name	Description
`op_Equality(Properties, Properties)`	Returns `true` if two collections are equal, `false` otherwise.
`op_Inequality(Properties, Properties)`	Returns `true` if two collections are not equal, `false` otherwise.