[This is preliminary documentation and is subject to change.]
Represents a single pane within a Workspace.
Declaration Syntax| C# |
public class Pane : Persistent, IMetaReferable, IOrderable
Members| 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.) |
| BottomOrRightChild | Gets the bottom or right child Pane of this one. Null if it
doesn't exist. |
| BuildNames(List<(Of <<'(String>)>>)) | Builds a list of names for use in creating a MetaReference to this object or a contained object. |
| 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.) |
| CentreChild | Gets the centre child Pane of this one. Null if it doesn't
exist. |
| Class | Gets the ObjectClass object associated with this object. (Overrides Persistent.Class.) |
| ClassFlags | Gets the class flags for the Pane class. (Overrides Persistent.ClassFlags.) |
| Clone()()()() | Creates a copy of this object. (Inherited from Persistent.) |
| Closable | Indicates whether this Pane can be removed from its parent Pane.
|
 | Collection()()()() | Creates a Pane collection to contain provisional objects. |
| Collection(Persistent, FlagSet, Int32, Boolean) | Creates a Pane collection to contain persistent objects. |
| CollectionParent | The parent object of the collection currently displayed in this
Pane, if there is one. |
| CollectionSlot | The Slot of the collection
currently displayed in this Pane, if there is one. |
| ContainingEnvironment | Gets the Environment that this object is contained within.
(Inherited from Persistent.) |
| ContainsTabs | Gets a value determining whether this pane contains one or more
tabbed Panes. |
| Content | Gets the content object or collection of this pane. |
| 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.) |
| Declared | Indicates whether this Pane was declared in the Persistate
definition file or created at run time. |
| 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 by
returning the contained pane with the given name |
| DiscriminativeText | Gets a string containing values of discriminative properties. (Overrides Persistent.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.) |
| FirstChildType | Gets the PaneType of this pane's first child pane.
If this pane has no child panes then PaneType._undefined_ is returned.
|
| FixedSize | Indicates whether the size of this Pane can be changed on screen
by the user. |
| 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 Persistent.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 Persistent.GetKey(Int32).) |
| GetMemberValue(Int32) | Gets the value of the member property with a particular slot number. (Overrides Persistent.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.) |
| Horizontal | This property is now obsolete. |
| 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. |
| Layout | Indicates the Layout used for the object or collection currently
displayed in the Pane. |
| LayoutType | Indicates the LayoutType (form grid, etc) that this Pane should
show as defined in the Persistate definition file. |
 | locker |
This object is used to synchronise fetches of contained objects and collections
in generated code.
(Inherited from Persistent.) |
| 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 Pane as defined in the Persistate definition
file and used by UserInterface and IPWindow to
refer to particular Panes. |
 | NameKey | Key value for name index. |
| NominativeText | Gets a string containing values of nominative properties. (Overrides Persistent.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 Pane in its parent Pane's Panes
collection. |
| OwningDomain |
Gets the Domain to which this object originally belongs.
(Inherited from Persistent.) |
| PaneIsEmpty | Gets a value determining whether or not this Pane is empty.
|
| Panes | The child Panes of this Pane. |
| PanesCount | Gets the number of items in the Panes collection. |
| PaneSize | The PaneSize gives the default size of this pane in either pixels
or as a percentage of the space available for it and its siblings.
|
| PaneType | The PaneType indicates the relation of this Pane to its siblings.
|
| 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.) |
| 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 Persistent.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 Persistent.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.) |
| Showing | The object currently displayed in the Pane, if there is one.
|
| ShowsType | Indicates the class of object that this Pane should show as
defined in the Persistate definition file. |
| SizeIsPercent | Indicates whether the PaneSize property gives the
pane size as a percentage. |
| Splittable | Indicates whether the contents of this Pane can be replaced with
two or three child Panes. |
| StoreInDatabase(Database) | Marks this object so that it will be stored in a particular Database. (Inherited from Persistent.) |
| 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.) |
| TopOrLeftChild | Gets the top or left child Pane of this one. Null if it doesn't
exist. |
| 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.) |
| Visibles | Gets the set of visible objects and collections in this Pane,
used to subscribe to updates from a Persistate Server. This is maintained
by Persistate, but you can add items manually if you wish. |
| 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 can define any number of Workspaces in Persistate definition files. Each Workspace is made up a hierarchy of Panes. The Workspace has a root Pane covering the entire window. The root Pane, and of course any of the contained Panes, can be contain one of four things
- Two child panes, split either horizontally or vertically, and referred to as the Top and Bottom or Left and Right panes.
- Three child panes, split either horizontally or vertically, and referred to as the Top, Central and Bottom or Left, Central and Right panes.
- One or more tabbed child panes, covering each other, but with tabs protruding at the top.
- Content - an object or collection displayed using a particular Layout.
Child panes are available in the Panes collection. The relative location of a pane to its siblings is given by the PaneType property. If a pane is showing a single object this is available in the Showing property, and if it's showing a collection, this is available through the CollectionParent and CollectionSlot properties. In both these cases, the Layout with which the object or collection is displayed is available in the Layout property.
Panes can have a number of attributes, set either in the definition file, or by how panes were created. FixedSize means that a pane cannot be resized using the divider between it and another pane. Splittable means that the Pane can be replaced at run time with two or three child panes. Closable means that the pane can be removed by the user. Only tabbed panes created at run time are closable, and have a close glyph at the right of the tab. Declared means that the pane was defined in the definition file rather than being created at run time.
Inheritance Hierarchy| Object | ||
 | Persistent | |
| Pane | |