Click or drag to resize

Property Class

An object container used by many of the objects in the NetQuarry platform. Most significant objects in the application include a Properties collection. Many of the Property items in those collections are loaded from meta-data. In this manner virtually all meta-data settings configuration in the platform studio are also available at runtime. In addition to exposing meta-data from the repository, Properties collections are used by platform objects to manage and/or expose certain internal information and can be used similarly by application-specific code such sa mapper extensions.

Note most objects having Properties collections also have TextItems collections that include named text items localized to the user's culture. As with the Properties collections, TextItems collections are loaded from meta-data and expose meta-data maintained by the studio.

Among the most important objects having Properties collections are:

Inheritance Hierarchy
SystemObject
  NetQuarryProperty

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

The Property type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAttributes
Stores the attributes. Should be a mask of PropertyAttrs. Certain PropertyAttrs such as IsDirty are generally set automatically.
Public propertyName
Stores the property name. Note that the name is the same as the collection's key.
Public propertyOwnerID
Gets/Sets the owner ID (for preferences, see Preferences).
Public propertyOwnerLevel
Gets/Sets the owner level (for preferences, see Preferences).
Public propertyParamID
The param_id from the xmt_properties table. Applies only when the property was loaded from the repository.
Public propertyPropID
The prop_id from the xmt_properties table. Applies only when the property was loaded from the repository.
Public propertySubObjectID
Stores the child key (sub_object_id). Note that the obj_id (the main related id) is the same for the entire collection.
Public propertyValue
Stores the value of the property. Note that the value is an object and a property can therefore be used to store anything. However, properties loaded from the repository will always be string values and it is recommended that one of the Properties collection accessor methods be used to safely extract property values:
Top
Methods
  NameDescription
Public methodClone
Creates a copy of this property and all of it's members.
Public methodStatic memberCreatePreference
Create a preference object.
Public methodEquals
The Equals method determines whether the specified object (assumed to be a Property object) is equal to the current Property
(Overrides ObjectEquals(Object).)
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 methodGetHashCode
The GetHashCode method serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPersist
Save this property to the IDatabase.
Public methodPersistEx
Persist the current property to the IDatabase.
Public methodStatic memberSafePrefName
Make a preference name safe (by truncating to maxlength if necessary).
Public methodStatic memberSafePropName
Make a property name safe (by truncating to maxlength if necessary).
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
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