Rx Page Manger

RX Library

Control Name Unit Class
RX Page Manger PageMngr TPageManager

Note:
Please see the demo. It is really difficult to explain what the PageManager does in English as most of the operations are taken care of by Borland's tNoteBook.

In other words, PageManger acts as a middle-man between buttons assigned to OkButton, CancelButton, HelpButton and tNoteBook.


Description:
TPageManager gives you the possibility of "one-click" creating "step-by-step" dialogs (known as "experts" or "wizards"). The database form Wizard dialog is a typical example of that. This component has no pages, it uses another page owner defined by PageOwner property. Currently only TNotebook is supported as page owner.TPageManager has OnGetNextPage and OnGetPriorPage events to handle sequence of pages. Also TPageManager has PageProxies property which contains list of page proxies («steps»), each of them has OnEnter, OnShow, OnHide è OnLeave events. These events occur when the user clicks the Back and Next buttons specified by NextBtn and PriorBtn properties. You can also change current page programatically by calling NextPage and PriorPage methods.


Property NextBtn
Declaration: NextBtn: TControl;

NextBtn defines which control to the NextBtn on the form which should be used to control the pages


Property NextEnabled
Declaration: NextEnabled: Boolean;

The variable contained enables or disable the "Next" button defined on the form.


Property PageCount
Declaration: PageCount: Integer;

PageCount is the total number of pages that the PageManager contains.


Property PageIndex
Declaration: PageIndex: Integer;

PageIndex is the total number of pages that the PageManager contains.


Property PageNames[Index: Integer]
Declaration: PageNames[Index: Integer]: string;

PageNames is the current name of the selected page..


Property PageOwner
Declaration: PageOwner: TPageOwner;

This is the notebook component that the MRU manager hooks upon.


Property PageProxies
Declaration: PageProxies: TList;

PageProxies is the list of cached pages that is contained in the notebook.


Property PriorBtn
Declaration: PriorBtn: TControl;

PriorBtn defines which control to the PriorBtn on the form which should be used to control the pages.


Property PriorEnabled
Declaration: PriorEnabled: Boolean;

The variable contained enables or disable the "Prior" button defined on the form.


Property SetStartPage
Declaration: SetStartPage: Boolean;

SetStartPage property sets the start page.

In other words, SetStartPage sets the particular page to start.


Event OnCheckButtons
Declaration: OnCheckButtons: TNotifyEvent;

OnCheckButtons


Event OnGetNextPage
Declaration: OnGetNextPage: TPageRequestEvent;

OnGetNextPage is a tPageRequestEvent


Event OnGetPriorPage
Declaration: OnGetPriorPage: TPageRequestEvent;

OnGetNextPage is a tPageRequestEvent

GetPriorpage


Method GetNextPageIndex
Declaration: function GetNextPageIndex(Page: Integer): Integer;

THIS TOPIC IS NOT COMPLETE!


Method GetPriorPageIndex
Declaration: function GetPriorPageIndex(Page: Integer): Integer;

THIS TOPIC IS NOT COMPLETE!


Method GetUniqueName
Declaration: function GetUniqueName(Component: TComponent): string;

THIS TOPIC IS NOT COMPLETE!


Method NextPage
Declaration: procedure NextPage;

NextPage procedure triggers the subclassed tNoteBook to switch to the next page.


Method PriorPage
Declaration: procedure PriorPage;

PriorPage procedure triggers the subclassed tNoteBook to switch to the previos page.


Method SetPage
Declaration: procedure SetPage(NewPageIndex: Integer; Next: Boolean);

Set the current page to the new page.


Class TPageProxy

PageProxy defin


Property PageManager
Declaration: PageManager: TPageManager;

PageManager contains the tNotebook custom control on the form.


Property PageName
Declaration: PageName: string;

PageName property is the name of the current notebook page that is active or shown.


Event OnEnter
Declaration: OnEnter: TPageNotifyEvent;

OnHide event is triggered when focus comes into the Notebook.


Event OnHide
Declaration: OnHide: TPageNotifyEvent;

OnHide event is triggered when a hidden page is triggered or accessed.

Example:
You want to password protect the form. Use OnHide to prevent the user from hacking the EXE file to trigger the active page instead <g>.


Event OnLeave
Declaration: OnLeave: TPageNotifyEvent;

OnLeave event is triggered when focus from a page from tNoteBook is no longer active.


Event OnShow
Declaration: OnShow: TPageNotifyEvent;

OnShow event is triggered when a page from tNoteBook is switched.


Type TPageNotifyEvent

Declaration: TPageNotifyEvent = procedure(Next: Boolean) of object;

TPageNotifyEvent is used for events of the TPageProxy class, which occurs when the notebook's page changed.


Type TPageOwner
Declaration: TPageOwner =TNotebook;

Defines type of PageOwner property of TPageManager component. Currently only TNotebook is supported as page owner.


Type TPageRequestEvent

Declaration: TPageRequestEvent = procedure(CurrentPage: Integer; var NewPage: Integer) of object;

TPageRequestEvent type is used for the OnGetNextPage and OnGetPriorPage events of the TPageManager component.


Index Page | About | Download
Creation Date: 4 Feb 1998 | Last Update: 16 Mar 2000