Click or drag to resize

Properties Class

A collection of Property objects.
Inheritance Hierarchy

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
[SerializableAttribute]
public class Properties : EAPCollectionBase, ICloneable, 
	ICacheable

The Properties type exposes the following members.

Constructors
  NameDescription
Public methodProperties
Default constructor.
Public methodProperties(Boolean)
Constructs a Properties collection that is NOT to be loaded from a database
Public methodProperties(Int32)
Default constructor.
Public methodProperties(IAppContext)
Constructor intended for use by the AppContext object.
Public methodProperties(IAppContext, Int32)
Constructor intended for use by the AppContext object.
Public methodProperties(String, PropertyAttrs, TagImportAttrs)
Constructs a Properties collection initialized by importing the provided TagString. See Import(String, PropertyAttrs, TagImportAttrs) for more information on the import string.
Top
Properties
  NameDescription
Public propertyChildObjectID
Gets or Sets this collection's child object ID
Public propertyCount
The number of elements actually contained in the ArrayList.
(Inherited from EAPCollectionBase.)
Public propertyIsDirty
When set, sets or clears the IsDirty bit on each Property in the collection. When retrieved, returns true if the IsDirty bit is set on any Property in the collection
Public propertyIsFixedSize
true if the ArrayList has a fixed size; otherwise, false. The default is false.
(Inherited from EAPCollectionBase.)
Public propertyIsReadOnly
Returns true if the collection is read-only. (Default is false)
(Inherited from EAPCollectionBase.)
Public propertyIsSynchronized
true if access to the internal ArrayList is synchronized (thread-safe); otherwise, false. The default is false.
(Inherited from EAPCollectionBase.)
Public propertyItemInt32
Indexer declaration
Public propertyItemString
Indexer declaration
Public propertyLoaded
True if the collection has been loaded, False otherwise. Note that the collection may have been loaded and still remain empty. Also, the Load methods do not honor this flag. You can test LoadedDate to determine the UTC date/time that this collection was last marked as Loaded.
Public propertyLoadedDate
Gets the UTC date/time that this collection was last marked as Loaded. If the collection has not been so marked, DateTime.MinValue is returned.
Public propertyObjectID
The obj_id used to load from the database
Public propertyObjectTypeKey
The obj_type_key used to load from the database
Public propertySubObjectType
Gets or Sets this collection's sub object type
Public propertySyncRoot
An object that can be used to synchronize access to the ArrayList.
(Inherited from EAPCollectionBase.)
Top
Methods
  NameDescription
Public methodAdd(Property)
Add a property object to the collection
Public methodAdd(String, Property)
Add a property object to the collection
Public methodAdd(String, Object)
Adds a property to the collection with the default Attributes set (PropertyAttrs.writeable)
Protected methodAdd(String, Object, CollectionAddFlags)
Adds an item to the collection
(Inherited from EAPCollectionBase.)
Public methodAdd(String, Property, PropertyAttrs)
Add a property object to the collection
Public methodAdd(String, Object, PropertyAttrs)
Adds a property to the collection
Public methodAdd(String, Object, PropertyAttrs, String)
Add a new property object to the collection
Protected methodAddAt
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.)
Public methodClear
Clears the collection
(Inherited from EAPCollectionBase.)
Public methodClearAttr
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.
Public methodClone
Creates a copy of this collection and all of it's members
Public methodContains
Determines whether an element is in the collection.
(Inherited from EAPCollectionBase.)
Public methodContainsKey
Checks for the existence of an item in the hashtable
(Inherited from EAPCollectionBase.)
Public methodCopyTo
Copies the entire ArrayList to a compatible one-dimensional Array, starting at the beginning of the target array.
(Inherited from EAPCollectionBase.)
Public methodDevInfoHtml
Generates an HTML representation of the properties collection appropriate for display to a developer.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExportTagString
Export the contents of the collection to a tag string.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFlushMetaProperties
Flush the specified Properties meta-data, if cached.
Public methodGetBoolValue(String)
Returns a value as a boolean for a property in the collection. If the property doesn't exist, then false is returned.
Public methodGetBoolValue(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.
Public methodGetDecimalValue(String)
Returns a value as an decimal for a property in the collection. If the property doesn't exist, then 0 is returned.
Public methodGetDecimalValue(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.
Public methodGetDoubleValue(String)
Returns a value as an double for a property in the collection. If the property doesn't exist, 0 is returned.
Public methodGetDoubleValue(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.
Public methodGetEnumerator
Returns an enumerator that can iterate through the ArrayList.
(Inherited from EAPCollectionBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIntValue(String)
Returns a value as an integer for a property in the collection. If the property doesn't exist, then 0 is returned.
Public methodGetIntValue(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.
Public methodGetIntValue(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.
Protected methodGetItem(Int32)
Returns an item that matches the specified string index
(Inherited from EAPCollectionBase.)
Protected methodGetItem(String)
Returns an item that matches the specified string index
(Inherited from EAPCollectionBase.)
Public methodGetItemName
Returns the name of the object (must be an object of type Property)
(Overrides EAPCollectionBaseGetItemName(Object).)
Public methodGetStringValue(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.
Public methodGetStringValue(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.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns a value for a property in the collection. If the property doesn't exist, then the defaultValue is returned.
Public methodImport(NameValueCollection, PropertyAttrs)
Imports a NameValueCollection into this collection
Public methodImport(String, PropertyAttrs)
Imports a tag-string into this collection. The string should be in the format of: name=value;name=value
Public methodImport(Properties, CollectionAddFlags)
Imports a collection of properties into this collection
Public methodImport(String, PropertyAttrs, TagImportAttrs)
Imports a tag-string into this collection. The string should be in the format of: name=value;name=value
Public methodImport(String, PropertyAttrs, TagImportAttrs, Char)
Imports a tag-string into this collection. The string should be in the format of: name=value;name=value
Public methodIndexOf
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.)
Public methodIndexOfKey
Returns the index of the item in the collection (by key)
(Inherited from EAPCollectionBase.)
Public methodInsert
Inserts an element into the internal ArrayList at the specified index
(Inherited from EAPCollectionBase.)
Public methodIsAttrSet
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.
Protected methodIsMarkedForDeletion
Determine if the provided item is marked for deletion.
(Overrides EAPCollectionBaseIsMarkedForDeletion(Object).)
Protected methodIsTypeOK
Returns true if the object is the correct type (Property)
(Overrides EAPCollectionBaseIsTypeOK(Object).)
Public methodLoad(IDatabase, String, String)
Load overload. This overload loads only from the xmt_properties table.
Public methodLoad(IDatabase, String, String, String)
Load overload. This overload loads only from the xmt_properties table.
Public methodLoad(IDatabase, String, String, String, String, PropertyLoadFlags)
Load overload. This overload loads only from the xmt_properties table.
Public methodLoadAndDistribute(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
Public methodLoadAndDistribute(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
Public methodLoadMetaProperties(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).
Public methodLoadMetaProperties(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).
Public methodLoadMetaProperties(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).
Public methodStatic memberLookupParameter(IAppContext, String, String, String)
Look up a parameter in the repository.
Public methodStatic memberLookupParameter(IDatabase, String, String, String)
Look up a parameter in the repository.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMerge
Merge the properties from another Properties collection into this collection.
Public methodPersist(IDatabase)
Persist each property marked as PropAttrEnum.persist to the xmt_properties table
Public methodPersist(IDatabase, String, String)
Persist's the properties to the database
Public methodPersist(IDatabase, String, String, String)
Persist's the properties to the database
Public methodPersist(IDatabase, String, String, String, Boolean)
Persist's the properties to the database
Public methodPrepareForCache
Prepares this object for cache
Protected methodRecalcHash
Recalculates the internal hash
(Inherited from EAPCollectionBase.)
Public methodRemove(Object)
Removes the first occurrence of a specific object from the collection
(Inherited from EAPCollectionBase.)
Public methodRemove(String)
Remove the specified item from the collection.
(Inherited from EAPCollectionBase.)
Public methodRemoveAt
Removes the element at the specified index
(Inherited from EAPCollectionBase.)
Public methodRemoveMarked
Removes the properties marked with the ToRemove attribute.
Public methodRemoveMarkedItems
Removes the properties marked for deletion.
(Inherited from EAPCollectionBase.)
Public methodRemoveRange
Removes the element at the specified index
(Inherited from EAPCollectionBase.)
Public methodSetAttr
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.
Protected methodSetItem(Int32, Object)
Sets an item's value at the specified index.
(Inherited from EAPCollectionBase.)
Protected methodSetItem(String, Object)
Sets an item's value at the string index indicated by the parameters.
(Inherited from EAPCollectionBase.)
Public methodSort(Boolean)
Sort the list by its key value.
(Inherited from EAPCollectionBase.)
Public methodSort(IComparer)
Sort the collection using the provided comparer.
(Inherited from EAPCollectionBase.)
Public methodSortByValue
Sort the properties by their values.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodTruncate
Truncate the array starting at the specified index.
(Inherited from EAPCollectionBase.)
Protected methodUnload
Called when the collection is cleared allowing a derived class to clean up.
(Inherited from EAPCollectionBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
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.)
Top
See Also