Persistate API documentation
Persistate.UI.Desktop Namespace
NamespacesPersistate.UI.Desktop

[This is preliminary documentation and is subject to change.]

This namespace contains all the classes and controls which support the Persistate DesktopUserInterface. This is the Windows Forms version of the abstract UserInterface used in the Persistate system.
Declaration Syntax
C#
namespace Persistate.UI.Desktop
Types
All TypesClassesInterfacesEnumerations
IconTypeDescription
ChoiceDialogue
This dialogue box allows the user to choose one or several objects from a collection.

ChoiceGrid
Shows a grid of Choice objects. This grid is used in all lookup forms.

ColourPickerDialogue
A dialogue box which allows the user to pick either a known colour or a custom colour.

ConnectForm
The ConnectForm shows details in a ConnectParameterSet, allowing the user to select the Persistate root database to connect to to start a Persistate application session.

DesktopUserInterface

This class implements the UserInterface abstract class for a user interface based on Windows Forms controls.


DialogContainer
This class represents a template dialogue box containing OK and Cancel buttons, which is used to display an object in a modal dialogue.

ErrorReportForm
Implements the form used by ReportError(String, String).

FixedPanels
Specifies which if any panels of a PTwoSplitContainer are fixed when the container is resized.

IMappableContainer
Implemented by containers that can be mapped to a Pane in a Workspace

InputBox
InputBox is a dialogue box which provides a quick way to enter some text into a single text box. The label for this text box is passed to the constructor

IPCaptionedControl
This is implemented by controls which attach a caption.

IPContainer
This interface is implemented by all Persistate controls which act as containers and which can be bound to a Persistent object

IPControl
This interface is implemented by all Persistate controls which can be bound to properties of Persistent objects showing in an IPContainer.

IPGridColumn
Describes functionality required by columns in a PGrid

ITitled
Defines properties which provide a title at the top of a container control.

ObjectSelectionBox
Allows selection of one or more objects from the persistent tree.

OperationBinder
This class is used to bind menu and toolbar items to the appropriate Operations.

PAccessButton
Represents a button bound to an object or a collection which, when clicked, displays the object or collection.

PBoundLabel
Provides a label which can be bound to a property of the container's DataSource in the same way as a text box.

PCheckBox
This is a CheckBox with the added functionality of IPControl and IStyled.

PColourPicker
This is a control showing a colour together with a button allowing the user to choose a new colour.

PComboBox
This is a ComboBox with the added functionality of IPControl, IPCaptionedControl and IStyled.

PContainer
This is the main container used for deriving forms and grids implementing Layouts in the Panes of the Workspace attached to a PWindow.

PDateTimePicker
This is a DateTimePicker with the added functionality of IPControl, IPCaptionedControl and IStyled.

PDiverseLookup
Provides a PContainer which can be used to look up object(s) in a collection of many diverse objects.

PEmptyContainer
This container is used as a placeholder in empty panes. Having this instead of just no container allows empty panes to be selected normally.

PFilePicker
Provides a text box with an attached button to browse for a single file on the local file system.

PFittedPanel
This class is used for the content panel of PContainers and provides a Panel with a LayoutEngine which will proportionally reposition controls in order to fit them onto the available surface of the panel.

PFlowLayoutPanel
This class provides a simple styled wrapper around FLowLayoutPanel

PFolderPicker
Provides a text box with an attached button to browse for a folder on the local file system. T

PFontPicker
Represents a control showing a font description together with a button allowing the user to choose a new font.

PGrid
This is a DataGridView with the added functionality of IPControl and IStyled, and the ability to host IPGridColumn columns.

PGridAccessColumn
Represents a column which allows access to an object member of the objects depicted in the rows of a grid.

PGridCheckBoxColumn
This class represents a check box column type for a PGrid.

PGridComboBoxColumn
This class represents a combo box column type for a PGrid.

PGridOperationColumn
This class represents a column containing an image which when clicked will execute an Operation on the object bound to the row containing the clicked cell.

PGridTextBoxColumn
This class represents a text box column type for a PGrid.

PLayoutEngine
This class performs layout duties for all PFittedPanel objects.

PLookupControl
This is the base class for all generated lookup forms.

PNominativeAccessLookupTextBox
Represents a text box showing the nominative text of the Persistent object to which it is bound, along with two buttons, an access button which will display the bound object and a lookup button which will allow you to choose a new object.

PNominativeAndAccessTextBox
This is a text box showing the nominative text of the Persistent object to which it is bound, along with a button giving access to it.

PNominativeAndLookupTextBox
Represents a text box showing the nominative text of the Persistent object to which it is bound, along with a button allowing you to choose a new object.

PSplitContainer
Provides a SplitContainer with added functionality for mapping to Panes within Workspaces

PStatusStrip
Provides a StatusStrip which shows a textual status, a progress bar which is visible only when in use, and a count of changes waiting for the next commit.

PTabContainer
Provides a TabControl which hosts one or more PTabPages, and can be mapped onto a Pane containing one or more tabbed Panes.

PTabPage
Provides a TabPage derived object which is used to create tab pages in a PTabContainer.

PTextBox
This is a TextBox with the added functionality of IPControl, IPCaptionedControl and IStyled.

PToolStripPanel
Provides a ToolStripPanel which contains a main menu and toolbar.

PToolStripRenderer
This renderer for ToolStrips applies a TextStyle to rendered items.

PTreeNode
Represents a node of a PTreeView.

PTreeView
Displays a persistent object tree in a hierarchical view.

PTwoSplitContainer
Provides a split container similar to PSplitContainer, but with three panels and added functionality for mapping to Panes within Workspaces.

PWindow
Provides the top level windows used in a DesktopUserInterface.

ShouldResize
Enumerates the possible values for how IPControls should be resized when the size of their container changes

StatusWindow
This form is used to show status messages when no other windows are available.

ViewerConnectForm
This small form allows the user to specify a Persistate Domain to connect to in the Persistate Viewer.