Persistate API documentation
IPWindow Interface
NamespacesPersistateIPWindow

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

Represents a top level application window in any type of user interface.
Declaration Syntax
C#
public interface IPWindow : IStatusTarget, 
	IStyled
Members
All MembersMethodsProperties



IconMemberDescription
ActivePane
Gets the currently active Pane - the Pane which is currently selected by the user.

AddTab(String)
Adds a new empty tabbed Pane with an automatically generated name to a parent Pane.

AddTab(String, String)
Adds a new empty named tabbed Pane to a parent Pane.

ApplyLayoutStyle()()()()
Sets appropriate property values from the current LayoutStyle for the control.
(Inherited from IStyled.)
BackStack
Gets the BackStack for this IPWindow, which allows going Back and Forward to redisplay Pane contents which have been overlaid.

GetPane(String)
Gets the Pane in this IPWindow with a particular name.

GetStatus()()()()
Gets the current status message showing in the session.
(Inherited from IStatusTarget.)
LayoutStyle
Gets or sets the current LayoutStyle of the control.
(Inherited from IStyled.)
RemovePane(String)
Removes a tabbed Pane.

SelectContainer()()()()
Selects the containing Pane of the currently active Pane in the user interface.

SetFocus(Persistent)
Finds the Pane showing a particular object, makes it visible if necessary and gives it the user interface focus.

SetFocus(Persistent, IPersistateList)
Finds the Pane showing a particular object in a particular grid, makes it visible if necessary and gives it the user interface focus.

SetFocus(String)
Gives the user interface focus to the object(s) showing in a particular Pane.

SetStatus(String, Single, Int32)
Shows the user a current status.
(Inherited from IStatusTarget.)
Show(IClassified)
Displays an object or collection using the default Layout, and in a Pane chosen automatically.

Show(IClassified, Layout)
Displays an object or collection using a particular Layout, and in a Pane chosen automatically.

Show(IClassified, String)
Displays an object or collection using the default Layout, and in a particular named Pane.

Show(IClassified, Layout, String)
Displays an object or collection using a particular Layout, and in a particular named Pane.

SplitPane(String, PaneType)
Replaces a Pane contents with two new panes arranged horizontally or vertically.

SplitPane(String, String, String, PaneType)
Replaces a Pane contents with two new panes arranged horizontally or vertically.

UseAppliedStyles
Gets or sets a value indicating whether LayoutStyles should be applied to this control at run time.
(Inherited from IStyled.)
UserInterface
Gets the UserInterface in which this IPWindow has been created.

WindowNumber
Gets an integer value unique to every window created.

Workspace
Gets or sets the current Workspace showing in this IPWindow.

Remarks

This interface is part of the Persistate scheme for decoupling the user interface from controller modules. Controllers access the user interface through the abstract UserInterface class, and this interface. Objects implementing this interface will represent top level forms in a desktop user interface, or browser windows or tabs in a web based interface.

An IPWindow displays objects within an arrangement of Panes determined by its Workspace property. Workspaces are persistent objects and you can define any number of them in a Persistate definition file, and also alter, save and restore them using the SplitPane, RemovePane and AddTab methods. Standard user interface operations are also available to all Persistate applications to allow the user to manipulate Workspaces at run time.

You show objects in an IPWindow using one of the Show method overloads. These allow you to show a particular object or collection, using a particular or default Layout, in a particular or default Pane in the Workspace.

Assembly: Persistate (Module: Persistate) Version: 0.6.1.20 (0.6.1.20)