[This is preliminary documentation and is subject to change.]
Property is a type of Member which represents a .Net
property.
Declaration Syntax| C# |
public class Property : Member
Members| All Members | Methods | Properties | Fields | Events | |
| Icon | Member | Description |
|---|---|---|
 | ActualQuantity | Indicates whether this member is a collection, and gives the
collection type - either several, many or selected. (Inherited from Member.) |
 | Adopt(Persistent, IReference%, Int32) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
 | Adopted | Occurs when this object is adopted as a contained (not
associated) child object of another object. (Inherited from Persistent.) |
| AnnotationSeparator | This string is used to separate the text in NominativeText and DiscriminativeText properties
(Inherited from Persistent.) |
| Associate(Persistent, IReference%, Int32) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| Associated | Occurs when this object is taken as an associated child object
of another object. (Inherited from Persistent.) |
| AssociatorCount()()()() | Gets the number of associations made to this object. (Inherited from Persistent.) |
| BaseClassReference(Persistent, Reference) |
Here only to allow consistent use of new keyword in generated classes.
Always throws an exception.
(Inherited from Persistent.) |
| BuildNames(List<(Of <<'(String>)>>)) | Builds a list of names for use in creating a MetaReference to this object. (Inherited from Member.) |
| Calculation | The text of the calculation if this is a calculate property.
|
| CallTree(CallTreeData, Int32) | In derived classes, calls a particular delegate for every node in
a persistent tree. (Inherited from Persistent.) |
| CallTree(CallTreeData) | Starts a recursive descent of the persistent containment tree
from this object, calling a delegate for every node in the tree below this
object. (Inherited from Persistent.) |
| Class | Gets the ObjectClass object associated with this object. (Overrides Member.Class.) |
| ClassFlags | Gets the class flags for the Property class. (Overrides Member.ClassFlags.) |
| Clone()()()() | Creates a copy of this object. (Inherited from Persistent.) |
 | Collection()()()() | Creates a Property collection to contain provisional objects. |
| Collection(Persistent, FlagSet, Int32, Boolean) | Creates a Property collection to contain persistent objects. |
| ContainingEnvironment | Gets the Environment that this object is contained within.
(Inherited from Persistent.) |
| CopyFrom(Persistent) | Copies values of fields from another Persistent of the same type.
(Inherited from Persistent.) |
| CopyTransientFrom(Persistent) | Allows derived classes to copy transient data when CopyFrom is called. (Inherited from Persistent.) |
| Database | Gets the Database object for the database in which
this object is or is to be stored. (Inherited from Persistent.) |
| DeAssociateFrom(Persistent, Int32) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| Deleted | This event occurs when an object is deleted. (Inherited from Persistent.) |
| DeleteVolatile(IReference) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| DePersist(Object) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| DePersistFrom(IPersistateList, Object) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| DeReference(Persistent) | Returns this object. (Inherited from Persistent.) |
| DeReferenceSection(String) | Dereferences a section in a MetaReference.
(Inherited from Member.) |
| DiscriminativeText | Gets a string containing values of discriminative properties. (Overrides Member.DiscriminativeText.) |
| Disowned | Occurs when this object is disowned from being a contained (not
associated) child object of another object. (Inherited from Persistent.) |
| Dissociated | Occurs when this object is removed from being an associated child
object of another object. (Inherited from Persistent.) |
| Equals(Persistent) | Determines if this Persistent is equal to another. (Inherited from Persistent.) |
| Equals(Object) | (Inherited from Object.) |
| FieldName | The name used for the field backing the property for the Member.
(Inherited from Member.) |
| FillFromDatabase(Database, IDataReader) | This method is intended for use only from generated code, and
you should not use it in open code. (Inherited from Persistent.) |
| FillFromMessage(Message) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
 | 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.) |
| FlagSet | A value containing the flags applied to this Member. (Inherited from Member.) |
| FriendlyName | The friendly or display name of the Member used in messages for
the user. (Inherited from Member.) |
| FromClause | The text of the entire from or within clause
for this property from the Persistate definition file, if there is one.
|
| FromClauseAccessString | A traverse which will take you from this property to the
FromClauseSourceMember. |
| FromClauseSourceMember | The Member that the from or within clause
refers to, which is to provide the source of associated objects for this
Property. |
| FullyQualifiedName |
Gets a string containing the fully qualified name of this member.
(Inherited from Member.) |
| GetAssociators()()()() | Gets a collection of all objects which have associations to this
object. (Inherited from Persistent.) |
| GetChildren<(Of <<'(T>)>>)(IndexedList<(Of <<'(T>)>>), ObjectClass, FlagSet, Int32, String, array<Object>[]()[][]) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| GetChildren<(Of <<'(T>)>>)(IndexedList<(Of <<'(T>)>>), ObjectClass, String, array<Object>[]()[][]) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| GetDefaultLayout()()()() |
Finds the default layout for this object. This will always be
of layout type Form.
(Inherited from Persistent.) |
| GetFieldValue(Int32) | Gets the value of the field backing the member with a particular slot number. (Overrides Member.GetFieldValue(Int32).) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetKey(Int32) | Returns property value for given key number. (Overrides Member.GetKey(Int32).) |
| GetMemberCollectionValueFor(Persistent) | Gets the value of this collection member in a given instance.
(Inherited from Member.) |
| GetMemberSingleValueFor(Persistent) | Gets the value of this scalar member in a particular instance.
(Inherited from Member.) |
| GetMemberValue(Int32) | Gets the value of the member property with a particular slot number. (Overrides Member.GetMemberValue(Int32).) |
| GetMemberValueFor(Persistent) | Gets the value of this member in a particular instance.
(Inherited from Member.) |
| GetSelected<(Of <<'(T>)>>)(IndexedList<(Of <<'(T>)>>), ObjectClass, array<Object>[]()[][]) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| InitialiseMembers(Boolean, Boolean) | In derived classes, initialises members of the Persistent object.
(Inherited from Persistent.) |
| IsAssociated | Gets a value indicating whether this is an associated
member. (Inherited from Member.) |
| IsAttached | Determines whether this object is attached to the persistent
tree. (Inherited from Persistent.) |
| IsCalculated | Gets a value indicating whether this is a calculated Property member. (Inherited from Member.) |
| IsDataMember | Gets a value indicating whether the class of this member is a data
class. (Inherited from Member.) |
| IsDistributedFrom(Persistent) | Determines whether this object is held or is to be held in a
different Database than another object. (Inherited from Persistent.) |
| IsEmpty | Determines whether this is the Empty object of its class, as
returned by the EmptyObject
property. (Inherited from Persistent.) |
| IsForeign | Gets a value determining whether this object is originally from a
Domain other than the local Domain. (Inherited from Persistent.) |
| IsInvalid | Gets a value indicating the validity of the current state of this
object. (Inherited from Persistent.) |
| IsLongData | Gets a value indicating whether this is a data class member with a
long text or long binary data type. (Inherited from Member.) |
| IsModified | Gets a value indicating whether this object has been modified
(Inherited from Persistent.) |
| IsObjectMember | Gets a value indicating whether the class of this member is an
object class. (Inherited from Member.) |
| IsPersisted | Gets a value indicating whether the object has been persisted
in a Database.
(Inherited from Persistent.) |
| IsProvisional | Gets a value indicating whether this object is still provisional
- has not been persisted in a Database. (Inherited from Persistent.) |
| IsReadOnly | Gets a value indicating whether this is a read only member.
(Inherited from Member.) |
| ItsObjectClass | Gets the ObjectClass object associated with this class. |
 | locker |
This object is used to synchronise fetches of contained objects and collections
in generated code.
(Inherited from Persistent.) |
| MemberClass | (Inherited from Member.) |
| MemberObjectClass | This is the MemberClass property as an ObjectClass, or null if it isn't. (Inherited from Member.) |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Modified | Occurs when an object is modified. (Inherited from Persistent.) |
| Move(String, Persistent, String) | Moves this object from its current parent object to a new one.
(Inherited from Persistent.) |
| Move(String, Persistent, String, Int32) | Moves this object from its current parent object to a new one,
optionally inserting it at a particular position in a collection.
(Inherited from Persistent.) |
| Name | The name of the Member used to name the property which implements
it. (Inherited from Member.) |
| NominativeText | Gets a string containing values of nominative properties. (Overrides Member.NominativeText.) |
| ObjectNumber | This returns the object number part of the object's Reference.
(Inherited from Persistent.) |
 | OnModified()()()() | Raises events signalling that the current object has been
modified. (Inherited from Persistent.) |
| Order | The order of this Member within the Members collection. (Inherited from Member.) |
| OwningDomain |
Gets the Domain to which this object originally belongs.
(Inherited from Persistent.) |
| Parent | This returns the parent object of this one. (Inherited from Persistent.) |
| ParentReference | Gets a Reference to this object's parent object.
(Inherited from Persistent.) |
| PreviousVersion | Returns the previous version of this object. (Inherited from Persistent.) |
| Refresh()()()() | Gets the current value of this object from persistent storage.
(Inherited from Persistent.) |
| RefreshAndLock()()()() | Gets the current value of this object from persistent storage and
sets a database lock. (Inherited from Persistent.) |
| RefreshTree()()()() | Refreshes the entire persistent containment tree under this
object. (Inherited from Persistent.) |
| Remarks | A more detailed comment which will be used in the remarks section
of the documentation comments for the property that implements this Member.
(Inherited from Member.) |
| RestoreUnmodified(Boolean) | Restores the values of an object's members to those of the
previous version. (Inherited from Persistent.) |
| SaveToDatabase(Database, Reference, Object) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| SaveToMessage(Message) | Saves this Persistent object to a Message.
(Inherited from Persistent.) |
| SaveToMessage(Message, Boolean) | Saves this Persistent object to a Message.
(Inherited from Persistent.) |
| SetFieldValue(Int32, Object) | Sets the value of the field backing the member with a particular slot number. (Overrides Member.SetFieldValue(Int32, Object).) |
| SetMemberFromMessage(Int32, Int32, Message) | This method is intended for use only from generated code, and you
should not use it in open code. (Inherited from Persistent.) |
| SetMemberValue(Int32, Object) | Sets the value of the member property with a particularn slot number. (Overrides Member.SetMemberValue(Int32, Object).) |
| SetMemberValueFor(Persistent, Object) | Sets the value of this member in a particular instance.
(Inherited from Member.) |
| SetModified()()()() | Signals to Persistate that an object has been modified. (Inherited from Persistent.) |
| SetModifiedSynced()()()() | Signals to Persistate that an object has been modified. The call
is protected by a lock on this object. (Inherited from Persistent.) |
| SetRandomValue(Persistent, Random, Int32, Boolean) | Sets a random value into the object property associated with this
Property. |
| SingularName | Same as the FriendlyName but in singular form for
collections. (Inherited from Member.) |
| Slot | The slot number assigned to this member. (Inherited from Member.) |
| Source | Used to comment the section for this member in generated source
files. (Inherited from Member.) |
| SourceName | The words from the source definition file that make up the name
used for the Member. (Inherited from Member.) |
| StoreInDatabase(Database) | Marks this object so that it will be stored in a particular Database. (Inherited from Persistent.) |
| Summary | A short comment which will be used in the summary section of the
documentation comments for the property that implements this Member.
(Inherited from Member.) |
| ThisObj | This property is used in binding combo box selected values. It
returns the current object. (Inherited from Persistent.) |
| TitleText | Gets a title for this object. (Inherited from Persistent.) |
| ToMetaReference()()()() | Creates a MetaReference referring to this object,
if possible. (Inherited from Persistent.) |
| ToMetaReference(Boolean) | Creates an environment relative MetaReference
referring to this object, if possible. (Inherited from Persistent.) |
| ToReference()()()() | Obtains a Reference to this Object. (Inherited from Persistent.) |
| ToString()()()() | Obtains a string describing the object. (Inherited from Persistent.) |
| Traverse(String) | Traverses the persistent object graph from this object using a
period delimited navigation path. (Inherited from Persistent.) |
| Validate()()()() |
Allows inheritors to create a validation method for Persistent classes.
(Inherited from Persistent.) |
| VersionNumber | Gets the version number of this object. (Inherited from Persistent.) |
| Within | Indicates that the property has a within clause, not a
from clause. |
| WriteTestAssociations(IClassified, Int32, CreateTestDataParameterSet) | Creates test association(s) for an associated member of this
object. (Inherited from Persistent.) |
| WriteTestData(Persistent, Int32, CreateTestDataParameterSet) | Fills this object with test data. (Inherited from Persistent.) |
RemarksYou do not create Properties - they are created by Persistate when you process your definition file. Properties can represent a scalar or collection member of a class. Associated Properties can have FromClause and FromClauseSourceMember properties. The latter indicates the Member representing the source that the target association is to be chosen from. If the Within indicator is false, the target should be in the source collection, and if true, the target should be in the persistent tree under the source object.
Inheritance Hierarchy| Object | |||
 | Persistent | ||
| Member | ||
| Property | ||