[This is preliminary documentation and is subject to change.]
This class implements the UserInterface abstract class for a user interface based on Windows Forms controls.
Declaration Syntax| C# |
public class DesktopUserInterface : UserInterface
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | DesktopUserInterface()()()() | Creates a new DesktopUserInterface for the current Session.
|
 | ActiveContainer | Gets the most recently activated IPContainer in the
UI. |
| AskConnectionDetails(ConnectParameterSet) | Puts up the Connect dialogue allowing the user to enter or modify
the connection details used to initialise the Persistate system. (Overrides UserInterface.AskConnectionDetails(ConnectParameterSet).) |
| AskRetry(String, array<Object>[]()[][]) | Shows a warning message to the user, and asks whether the user
wishes to retry. (Overrides UserInterface.AskRetry(String, array<Object>[]()[][]).) |
| AskString(String) | Asks the user to input a single string value. (Overrides UserInterface.AskString(String).) |
| Beep()()()() | Sounds a default beep. (Overrides UserInterface.Beep()()()().) |
| ChooseOne(String, ICollection) | Displays a choice of items from a collection to the user allowing
the choice of one of the items. (Overrides UserInterface.ChooseOne(String, ICollection).) |
| ChooseSeveral(String, ICollection) | Displays a choice of items from a collection to the user allowing
the choice of one or more of the items. (Overrides UserInterface.ChooseSeveral(String, ICollection).) |
| CloseWindow(IPWindow) | Closes an IPWindow in the user interface, releasing
all resources. (Overrides UserInterface.CloseWindow(IPWindow).) |
 | ControlMargin(CaptionPosition, LayoutStyle) | Gets a Padding appropriate for setting
the Margin of a control, for a particular LayoutStyle.
|
| CreateWindow(String) | (Overrides UserInterface.CreateWindow(String).) |
| CreateWindow(String, String) | (Overrides UserInterface.CreateWindow(String, String).) |
| Equals(Object) | (Inherited from Object.) |
| Exit(String) | Terminates the user Session represented by this
UserInterface. (Overrides UserInterface.Exit(String).) |
 | 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.) |
| GetFile(String, String) | Allows the user to select a file and returns its contents.
(Overrides UserInterface.GetFile(String, String).) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetStatus()()()() | Gets the current status message showing in the user interface.
(Overrides UserInterface.GetStatus()()()().) |
| GetTextFile(String, String, Encoding) | Allows the user to select a text file and returns its contents.
(Overrides UserInterface.GetTextFile(String, String, Encoding).) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| GetWindow(Int32) | Obtains the IPWindow in the user interface with a
particular window number. (Overrides UserInterface.GetWindow(Int32).) |
| HideWindow(IPWindow) | Hides an IPWindow which is currently visible in the
user interface. (Overrides UserInterface.HideWindow(IPWindow).) |
| Inform(String, array<Object>[]()[][]) | Shows an information message to the user. (Overrides UserInterface.Inform(String, array<Object>[]()[][]).) |
| Invoke(Delegate, array<Object>[]()[][]) | Calls a particular method on the UI thread with a set of
parameters, returning an object. (Overrides UserInterface.Invoke(Delegate, array<Object>[]()[][]).) |
| MainWindow | Gets the visible IPWindow which most recently had
the focus. If no window is visible, then this will be null.
(Overrides UserInterface.MainWindow.) |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| RefreshAllPanes()()()() | Requests the user interface to refresh the data in all currently
showing Panes. This refreshes the user interface
from data held in memory only. It does not refresh data from the database.
(Overrides UserInterface.RefreshAllPanes()()()().) |
| ReportError(String, String) | Reports an error to the user. (Overrides UserInterface.ReportError(String, String).) |
| SelectObjects(String, ObjectClass, IClassified, Boolean, Boolean) | Displays an object selection modal form to allow the user to
choose one or more objects. (Overrides UserInterface.SelectObjects(String, ObjectClass, IClassified, Boolean, Boolean).) |
| Session | Gets the Session running this user interface
(Inherited from UserInterface.) |
| SetFocusTo(Persistent) | Sets the focus in the user interface to the Pane
showing a particular object. (Overrides UserInterface.SetFocusTo(Persistent).) |
| SetFocusTo(Persistent, IPersistateList) | Sets the focus in the user interface to a row in a grid showing a
particular object. (Overrides UserInterface.SetFocusTo(Persistent, IPersistateList).) |
| SetStatus(String, Single) | Shows the user a current status. (Overrides UserInterface.SetStatus(String, Single).) |
| Show(IClassified, Layout, String) | (Overrides UserInterface.Show(IClassified, Layout, String).) |
| Show(IClassified) | (Inherited from UserInterface.) |
| Show(IClassified, Layout) | (Inherited from UserInterface.) |
| Show(IClassified, String) | (Inherited from UserInterface.) |
| ShowModal(IClassified, Layout, ContainerProperties) | Displays an object or collection to the user using a particular
Layout. (Overrides UserInterface.ShowModal(IClassified, Layout, ContainerProperties).) |
| ShowModal(IClassified, ContainerProperties) | Displays an object or collection to the user using the default
Layout. (Inherited from UserInterface.) |
| ShowModal(IClassified, String) | Displays an object or collection to the user using the default
Layout. (Inherited from UserInterface.) |
| ShowModal(IClassified, Layout, String) | Displays an object or collection to the user using a particular
Layout. (Inherited from UserInterface.) |
| ShowModalButtons(IClassified, Layout, ContainerProperties, array<String>[]()[][]) | Displays an object or collection to the user using the default
Layout, and with up to three custom buttons (Overrides UserInterface.ShowModalButtons(IClassified, Layout, ContainerProperties, array<String>[]()[][]).) |
| ShowModalButtons(IClassified, PContainer, ContainerProperties, array<String>[]()[][]) | Puts up an already instantiated PContainer form in
a modal dialogue with one or three buttons. |
| ShowModalButtons(IClassified, String, array<String>[]()[][]) | Displays an object or collection to the user using the default
Layout, and with up to three custom buttons (Inherited from UserInterface.) |
| ShowModalButtons(IClassified, Layout, String, array<String>[]()[][]) | Displays an object or collection to the user using a particular
Layout, and with up to three custom buttons (Inherited from UserInterface.) |
| ShowModalButtons(IClassified, ContainerProperties, array<String>[]()[][]) | Displays an object or collection to the user using the default
Layout, and with up to three custom buttons (Inherited from UserInterface.) |
| ShowModalOkCancel(IClassified, String) | Displays an object or collection to the user using the default
Layout, and with Ok and Cancel buttons. (Inherited from UserInterface.) |
| ShowModalOkCancel(IClassified, Layout, String) | Displays an object or collection to the user using a particular
Layout, and with Ok and Cancel buttons. (Inherited from UserInterface.) |
| ShowModalOkCancel(IClassified, ContainerProperties) | Displays an object or collection to the user using the default
Layout, and with Ok and Cancel buttons. (Inherited from UserInterface.) |
| ShowModalOkCancel(IClassified, Layout, ContainerProperties) | Displays an object or collection to the user using a particular
Layout, and with Ok and Cancel buttons. (Inherited from UserInterface.) |
| ShowWindow(IPWindow) | Makes an IPWindow visible in the user interface.
(Overrides UserInterface.ShowWindow(IPWindow).) |
| ShowWindow(IPWindow, String) | Makes an IPWindow visible in the user interface,
setting its title. (Overrides UserInterface.ShowWindow(IPWindow, String).) |
| ShowWindowModal(IPWindow, String) | Makes an IPWindow visible in the user interface,
setting its title. (Overrides UserInterface.ShowWindowModal(IPWindow, String).) |
| ToFlatStyle(FlatStyle) |
Converts a Persistate.FlatStyle to a System.Windows.Forms.FlatStyle
|
| ToString()()()() | (Inherited from Object.) |
| UserConfirms(String, array<Object>[]()[][]) | Shows a message to the user, and asks for confirmation.
(Overrides UserInterface.UserConfirms(String, array<Object>[]()[][]).) |
| Warn(String, array<Object>[]()[][]) | Shows a warning message to the user. (Overrides UserInterface.Warn(String, array<Object>[]()[][]).) |
| WindowNumber(IPWindow) | Obtains the index within the list returned by the Windows property for a particular window. (Overrides UserInterface.WindowNumber(IPWindow).) |
| Windows | Gets a collection of all IPWindows
that have been created in the user interface. (Overrides UserInterface.Windows.) |
RemarksSee the UserInterface documentation for details of the abstract members implemented here. The IPWindow interface used by UserInterface is here implemented by PWindow. The IPContainer interface is used to display items in panes, the standard implementation of it being PContainer
As well as implemented abstract members, this class has an ActiveContainer property which gets the IPContainer most recently activated. There is also a ShowModalButtons method to display an already instantiated PContainer in a dialogue box.
Inheritance Hierarchy| Object | ||
 | UserInterface | |
| DesktopUserInterface | |