[This is preliminary documentation and is subject to change.]
C# |
public class DataClass : PersistentClass
All Members | Methods | Properties | Fields | Events | |
Icon | Member | Description |
---|---|---|
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.) | |
BaseDataType | The type of data that this DataClass represents.
| |
BuildNames(List<(Of <<'(String>)>>)) | Builds a list of names for use in creating a MetaReference to this object. (Inherited from PersistentClass.) | |
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 PersistentClass.Class.) | |
ClassFlags | Gets the class flags for the DataClass class. (Overrides PersistentClass.ClassFlags.) | |
Clone()()()() | Creates a copy of this object. (Inherited from Persistent.) | |
Collection()()()() | Creates a DataClass collection to contain provisional objects. | |
Collection(Persistent, FlagSet, Int32, Boolean) | Creates a DataClass 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.) | |
DataValues | The set of DataValues allowed for this multi-value DataClass. | |
DataValuesCount | Gets the number of items in the DataValues collection. | |
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 PersistentClass.) | |
DiscriminativeText | Gets a string containing values of discriminative properties. (Overrides PersistentClass.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.) | |
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.) | |
FriendlyName | The friendly or display name of this PersistentClass, used in the
Persistate definition file and to display messages in a user interface.
(Inherited from PersistentClass.) | |
FullyQualifiedName | Gets the fully qualified name of this class which is of the
format [package name].[class name] (Inherited from PersistentClass.) | |
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 PersistentClass.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 PersistentClass.GetKey(Int32).) | |
GetMemberValue(Int32) | Gets the value of the member property with a particular slot number. (Overrides PersistentClass.GetMemberValue(Int32).) | |
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.) | |
HighDatetime | If set, the maximum value for items with this datetime DataClass. | |
HighFixed | If set, the maximum value for items with this fixed point DataClass. | |
HighFloating | If set, the maximum value for items with this floating point DataClass. | |
HighIntegral | If set, the maximum value for items with this integer DataClass. | |
InitialiseMembers(Boolean, Boolean) | In derived classes, initialises members of the Persistent object.
(Inherited from Persistent.) | |
IsAttached | Determines whether this object is attached to the persistent
tree. (Inherited from Persistent.) | |
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.) | |
IsModified | Gets a value indicating whether this object has been modified
(Inherited from Persistent.) | |
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.) | |
ItsObjectClass | Gets the ObjectClass object associated with this class. | |
Length | The maximum number of characters or bytes for textual or binary
data respectively. | |
locker |
This object is used to synchronise fetches of contained objects and collections
in generated code.
(Inherited from Persistent.) | |
LowDatetime | If set, the minimum value for items with this datetime DataClass. | |
LowFixed | If set, the minimum value for items with this fixed point DataClass. | |
LowFloating | If set, the minimum value for items with this floating point DataClass. | |
LowIntegral | If set, the minimum value for items with this integer DataClass. | |
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 this PersistentClass used in code. (Inherited from PersistentClass.) | |
NominativeText | Gets a string containing values of nominative properties. (Overrides PersistentClass.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.) | |
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.) | |
ParentPackage | Gets the Parent object as a Package. (Inherited from PersistentClass.) | |
ParentReference | Gets a Reference to this object's parent object.
(Inherited from Persistent.) | |
Plural | The plural form of the FriendlyNameFriendlyName
property. (Inherited from PersistentClass.) | |
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.) | |
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.) | |
Scale | The scale for decimal data. | |
SetFieldValue(Int32, Object) | Sets the value of the field backing the member with a particular slot number. (Overrides PersistentClass.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 PersistentClass.SetMemberValue(Int32, Object).) | |
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.) | |
StoreInDatabase(Database) | Marks this object so that it will be stored in a particular Database. (Inherited from Persistent.) | |
TargetType | Returns the .Net type which is used to hold members with this
data class. (Overrides PersistentClass.TargetType.) | |
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.) | |
TypicalLength | The typical number of characters or bytes for textual or binary
data respectively. | |
Validate(String, Object%) | Validates the contents of a given string against the DataClass.
| |
Validate()()()() |
Allows inheritors to create a validation method for Persistent classes.
(Inherited from Persistent.) | |
ValidationRequired | Whether values with this DataClass require
validation. | |
VersionNumber | Gets the version number of this object. (Inherited from Persistent.) | |
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.) |
DataClasses, together with ObjectClasses, and ViewClasses, make up the PersistentClasses which describe all Persistent data in a Persistate domain.
A DataClass is somewhat similar to a value type in .Net, but not identical. whereas all .Net primitive value types are represented in Persistate by DataClasses, some reference types are also represented by data classes. For example, string, font and colour values are DataClasses in Persistate.
You define DataClasses in Persistate definition files. Each DataClass is associated with a BaseDataType which defines the type of information that members with that DataClass can hold. As well as the base data type, DataClasses can also have constraints. Different types can have different constraints.
For example textual and binary types can take a length constraint, non integral numeric types can take precision and scale constraints, and all numeric and datetime types can take uppers and lower bounds. You can also create DataClasses which can hold one or more of a fixed set of values. These Multi-value classes are held in structs in memory.
Object | |||
Persistent | |||
PersistentClass | |||
DataClass |