Properties Methods |
The Properties type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Add(Property) |
Add a property object to the collection
|
| Add(String, Property) |
Add a property object to the collection
|
| Add(String, Object) |
Adds a property to the collection with the default Attributes set (PropertyAttrs.writeable)
|
 | Add(String, Object, CollectionAddFlags) |
Adds an item to the collection
(Inherited from EAPCollectionBase.) |
| Add(String, Property, PropertyAttrs) |
Add a property object to the collection
|
| Add(String, Object, PropertyAttrs) |
Adds a property to the collection
|
| Add(String, Object, PropertyAttrs, String) |
Add a new property object to the collection
|
| AddAt |
Adds an item to the collection at the specified index. To append an item use -1 or
the collection item count as the index.
(Inherited from EAPCollectionBase.) |
| Clear |
Clears the collection
(Inherited from EAPCollectionBase.) |
| ClearAttr |
Clears the specified attribute (or multiple attribute bits if the attr value includes multiple attribute bits)
in the specified property.
The property is assumed to be an int (presumably representing an enumeration) defaulting to zero if not found.
If the property already exists then the provided attr bits are cleared from the existing value (using a bit-wise AND of the complement).
If the property does not already exist then it is NOT added.
You can use IsAttrSet(String, Enum) to determine if one or more attribute bits are set.
Use SetAttr(String, Enum) to set a bit or bits.
|
| Clone |
Creates a copy of this collection and all of it's members
|
| Contains |
Determines whether an element is in the collection.
(Inherited from EAPCollectionBase.) |
| ContainsKey |
Checks for the existence of an item in the hashtable
(Inherited from EAPCollectionBase.) |
| CopyTo |
Copies the entire ArrayList to a compatible one-dimensional Array, starting at the beginning of the target array.
(Inherited from EAPCollectionBase.) |
| DevInfoHtml |
Generates an HTML representation of the properties collection appropriate
for display to a developer.
|
| Equals | (Inherited from Object.) |
| ExportTagString |
Export the contents of the collection to a tag string.
|
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| FlushMetaProperties |
Flush the specified Properties meta-data, if cached.
|
| GetBoolValue(String) |
Returns a value as a boolean for a property in the collection. If the property doesn't exist, then false is returned.
|
| GetBoolValue(String, Boolean) |
Returns a value as a boolean for a property in the collection. If the property doesn't exist, then the defaultValue is returned.
|
| GetDecimalValue(String) |
Returns a value as an decimal for a property in the collection. If the property doesn't exist, then 0 is returned.
|
| GetDecimalValue(String, Decimal) |
Returns a value as an decimal for a property in the collection. If the property doesn't exist, then the defaultValue is returned.
|
| GetDoubleValue(String) |
Returns a value as an double for a property in the collection. If the property doesn't exist, 0 is returned.
|
| GetDoubleValue(String, Double) |
Returns a value as an double for a property in the collection. If the property doesn't exist, then the defaultValue is returned.
|
| GetEnumerator |
Returns an enumerator that can iterate through the ArrayList.
(Inherited from EAPCollectionBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetIntValue(String) |
Returns a value as an integer for a property in the collection. If the property doesn't exist, then 0 is returned.
|
| GetIntValue(String, Enum) |
Returns a value as an integer (presumably to be interpreted as an enumeration value) for a property in the collection.
If the property doesn't exist, then the defaultValue is returned.
|
| GetIntValue(String, Int32) |
Returns a value as an integer for a property in the collection. If the property doesn't exist, then the defaultValue is returned.
|
| GetItem(Int32) |
Returns an item that matches the specified string index
(Inherited from EAPCollectionBase.) |
| GetItem(String) |
Returns an item that matches the specified string index
(Inherited from EAPCollectionBase.) |
| GetItemName |
Returns the name of the object (must be an object of type Property)
(Overrides EAPCollectionBaseGetItemName(Object).) |
| GetStringValue(String) |
Returns a value for a property in the collection. If the property doesn't exist or is blank,
then an empty string is returned.
|
| GetStringValue(String, String) |
Returns a value for a property in the collection. If the property doesn't exist or is blank,
then the defaultValue is returned.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue |
Returns a value for a property in the collection. If the property doesn't exist, then the defaultValue is returned.
|
| Import(NameValueCollection, PropertyAttrs) |
Imports a NameValueCollection into this collection
|
| Import(String, PropertyAttrs) |
Imports a tag-string into this collection. The string should be in the format of:
name=value;name=value
|
| Import(Properties, CollectionAddFlags) |
Imports a collection of properties into this collection
|
| Import(String, PropertyAttrs, TagImportAttrs) |
Imports a tag-string into this collection. The string should be in the format of:
name=value;name=value
|
| Import(String, PropertyAttrs, TagImportAttrs, Char) |
Imports a tag-string into this collection. The string should be in the format of:
name=value;name=value
|
| IndexOf |
Returns the zero-based index of the first occurrence of an object in the internal ArrayList or in a portion of it.
(Inherited from EAPCollectionBase.) |
| IndexOfKey |
Returns the index of the item in the collection (by key)
(Inherited from EAPCollectionBase.) |
| Insert |
Inserts an element into the internal ArrayList at the specified index
(Inherited from EAPCollectionBase.) |
| IsAttrSet |
Determines if the specified attribute is set (or any of the specified attributes are set if the attr value includes multiple
attribute bits) in the specified property.
The property is assumed to be an int (presumably representing an enumeration) defaulting to zero if not found.
You can use SetAttr(String, Enum) to set one or more attribute bits.
Use ClearAttr(String, Enum) to clear a bit or bits.
|
| IsMarkedForDeletion |
Determine if the provided item is marked for deletion.
(Overrides EAPCollectionBaseIsMarkedForDeletion(Object).) |
| IsTypeOK |
Returns true if the object is the correct type (Property)
(Overrides EAPCollectionBaseIsTypeOK(Object).) |
| Load(IDatabase, String, String) |
Load overload. This overload loads only from the xmt_properties table.
|
| Load(IDatabase, String, String, String) |
Load overload. This overload loads only from the xmt_properties table.
|
| Load(IDatabase, String, String, String, String, PropertyLoadFlags) |
Load overload. This overload loads only from the xmt_properties table.
|
| LoadAndDistribute(EAPCollectionBase, IAppContext, String, String, String, Boolean) |
Loads the properties for all objects of specified type, then assigns them to each object
Note that the child objects must implement INQBase
|
| LoadAndDistribute(EAPCollectionBase, IAppContext, String, String, String, Boolean, String) |
Loads the properties for all objects of specified type, then assigns them to each object
Note that the child objects must implement INQBase
|
| LoadMetaProperties(IAppContext, String, String, Boolean) |
Loads the collection of property metadata. This collection is used during load and distribute to distribute a set
of properties across a collection and it's collected objects. (e.g. Mapper and Fields).
|
| LoadMetaProperties(IAppContext, String, String, Boolean, IDatabase) |
Loads the collection of property metadata. This collection is used during load and distribute to distribute a set
of properties across a collection and it's collected objects. (e.g. Mapper and Fields).
|
| LoadMetaProperties(IAppContext, String, String, Boolean, IDatabase, String) |
Loads the collection of property metadata. This collection is used during load and distribute to distribute a set
of properties across a collection and it's collected objects. (e.g. Mapper and Fields).
|
 | LookupParameter(IAppContext, String, String, String) |
Look up a parameter in the repository.
|
| LookupParameter(IDatabase, String, String, String) |
Look up a parameter in the repository.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Merge |
Merge the properties from another Properties collection into this collection.
|
| Persist(IDatabase) |
Persist each property marked as PropAttrEnum.persist to the xmt_properties table
|
| Persist(IDatabase, String, String) |
Persist's the properties to the database
|
| Persist(IDatabase, String, String, String) |
Persist's the properties to the database
|
| Persist(IDatabase, String, String, String, Boolean) |
Persist's the properties to the database
|
| PrepareForCache |
Prepares this object for cache
|
| RecalcHash |
Recalculates the internal hash
(Inherited from EAPCollectionBase.) |
| Remove(Object) |
Removes the first occurrence of a specific object from the collection
(Inherited from EAPCollectionBase.) |
| Remove(String) |
Remove the specified item from the collection.
(Inherited from EAPCollectionBase.) |
| RemoveAt |
Removes the element at the specified index
(Inherited from EAPCollectionBase.) |
| RemoveMarked |
Removes the properties marked with the ToRemove attribute.
|
| RemoveMarkedItems |
Removes the properties marked for deletion.
(Inherited from EAPCollectionBase.) |
| RemoveRange |
Removes the element at the specified index
(Inherited from EAPCollectionBase.) |
| SetAttr |
Set the specified attribute (or multiple attribute bits if the attr value includes multiple attribute bits)
in the specified property.
The property is assumed to be an int (presumably representing an enumeration) defaulting to zero if not found.
If the property already exists then the provided attr bits are ORed into the existing value.
If the property does not already exist then it is created and the value set to the provided attr bits.
You can use IsAttrSet(String, Enum) to determine if one or more attribute bits are set.
Use ClearAttr(String, Enum) to clear a bit or bits.
|
| SetItem(Int32, Object) |
Sets an item's value at the specified index.
(Inherited from EAPCollectionBase.) |
| SetItem(String, Object) |
Sets an item's value at the string index indicated by the parameters.
(Inherited from EAPCollectionBase.) |
| Sort(Boolean) |
Sort the list by its key value.
(Inherited from EAPCollectionBase.) |
| Sort(IComparer) |
Sort the collection using the provided comparer.
(Inherited from EAPCollectionBase.) |
| SortByValue |
Sort the properties by their values.
|
| ToString | (Inherited from Object.) |
| Truncate |
Truncate the array starting at the specified index.
(Inherited from EAPCollectionBase.) |
| Unload |
Called when the collection is cleared allowing a derived class to clean up.
(Inherited from EAPCollectionBase.) |
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |
See Also