finPageSetHandler Class

Handles entry of data via a Page Set in a Windows Forms environment.

Methods

Name Description
Clear
ExecuteAction Fires the ActionNotification event.
ExecuteActionKeyValueList Fires the ActionNotification event passing notification data as a Key/ Value List.
ExecuteActionScript Execute an Action Script.
FormClose Ask the User Interface to Close the form.
FormRefresh Refresh all forms with the specified Form Key that have the specified Record Id loaded.
FormShowAccountAppApplicant Show the Account Application Applicant wizard.
FormShowAccountAppApplicantBankAccountEnquiry Show the Bank Account Enquiry wizard for an Account Application Applicant object.
FormShowAccountAppApplicantCreditEnquiry Show the Credit Enquiry wizard for an Account Application Applicant object.
FormShowAccountAppApplicantPPSRSearch Show the PPSR Search wizard for an Account Application Applicant object.
FormShowAccountAppCollateralItem Show the Account Application Collateral Item wizard.
FormShowAccountAppCollateralItemPPSRSearch Show the PPSR Search wizard for an Account Application Collateral Item object.
FormShowAccountFinancial Show the Account Financial Form (a restricted version of the Account Quotation).
FormShowAccountPaymentArrangementAdd Show the Account Payment Arrangement Form.
FormShowAccountSchedule Show an Account Schedule Form.
FormShowAccountTemp Show an Account Form to display an Account object (e.g., a temporary, unsaved Account object).
FormShowAddressSearch Show an Address Search Form.
FormShowClientBankAccountEnquiry Show the Bank Account Enquiry wizard for a Client object.
FormShowClientCreditEnquiry Show the Credit Enquiry wizard for a Client object.
FormShowClientPPSRSearch Show the PPSR Search wizard for a Client object.
FormShowClientTemp Show an Client Form to display a Client object (e.g., a temporary, unsaved Client object).
FormShowCompanyLookup Show a Company Lookup Form.
FormShowNewClientWizard Show the New Client wizard.
FormShowPageSet Show a Page Set.
FormShowPseudoModal Use an Application Shortcut to Show a Form Pseudo-Modal to the Page Set form.
FormShowQuickSearch Show a Quick Search Form for a Page Object.
FormShowRangeLookupFromDataView Show a Range Lookup Form for a DataView for a Page Object.
FormShowRangeLookupFromStandardRange Show a Standard Range Lookup Form for a Page Object.
FormShowSecurityStmtItem Show the Security Statement Item form.
GetBoolean Get the value of a Page Object as a Boolean.
GetDate Get the value of a Page Object as a Date.
GetDecimal Get the value of a Page Object as a Decimal.
GetInteger Get the value of a Page Object as an Integer.
GetPageObject Get a Page Object.
GetPageObjectsByGroupTag Get a list of finPageSetHandlerPageObject objects that have the specified Group Tag.
GetQuickSearchRecordId Show a modal Quick Search form and allow the User to select a record and return the Record Id, e.g., an Account Id.
GetString Get the value of a Page Object as a String.
GroupTagRemove Remove a Group Tag from the GroupTags collection.
GroupTagSetEnabled Set the Enabled property of a Group Tag.
GroupTagSetReadOnly Set the ReadOnly property of a Group Tag.
GroupTagSetVisible Set the Visible property of a Group Tag.
Initialise Initialise the Page Set.
NotifyAccountAppApplicantFormClosed System Use Only Used by the User Interface to notify when the Applicant wizard has been closed.
NotifyAccountAppCollateralItemFormClosed System Use Only Used by the User Interface to notify when the Collateral Item wizard has been closed.
NotifyAccountFinancialFormClosed System Use Only Used by the User Interface to notify when an Account Financial Form has been closed.
NotifyAccountPaymentArrangementAddFormClosed System Use Only Used by the User Interface to notify when a New Client wizard Form has been closed.
NotifyBankAccountEnquiryFormClosed System Use Only Used by the User Interface to notify when a Bank Account Enquiry Form has been closed.
NotifyCommandButtonClick System Use Only Used by the User Interface to notify that a Command Button (i.e., one of the built-in buttons) as been clicked.
NotifyCreditEnquiryFormClosed System Use Only Used by the User Interface to notify when a Credit Enquiry Form has been closed.
NotifyCurrentPageChanged System Use Only Used by the User Interface to notify that the selected page for a 'Tabbed Pages' type Page Set has changed. This gives the Script a chance to load page-dependant data.
NotifyNewClientWizardFormClosed System Use Only Used by the User Interface to notify when a New Client wizard Form has been closed.
NotifyPPSRSearchFormClosed System Use Only Used by the User Interface to notify when a PPSR Search Form has been closed.
NotifyPageObjectAfterRowActivate System Use Only Used by the User Interface when an 'AfterRowActivate' event occurs for a Grid Page Object.
NotifyPageObjectAfterSelectChange System Use Only Used by the User Interface when an 'AfterRowActivate' event occurs for a Grid Page Object.
NotifyPageObjectBeforeCellUpdate System Use Only Used by the User Interface when an 'BeforeCellUpdate' event occurs for a Grid Page Object.
NotifyPageObjectButtonClick System Use Only Used by the User Interface when a 'ButtonClick' event occurs for a Page Object.
NotifyPageObjectChange System Use Only Used by the User Interface when a 'Change' event occurs for a Page Object.
NotifyPageObjectClick System Use Only Used by the User Interface when a 'Click' event occurs for a Page Object.
NotifyPageObjectCustomHyperlinkClick System Use Only Used by the User Interface when a custom hyperlink (e.g., custom://test) occurs for an HTML Panel type Page Object.
NotifyPageObjectEnter System Use Only Used by the User Interface when a 'Enter' event occurs for a Page Object.
NotifyPageObjectInitialiseRow System Use Only Used by the User Interface when an 'InitializeRow' event occurs for a Grid Page Object.
NotifyPageObjectLeave System Use Only Used by the User Interface when a 'Leave' event occurs for a Page Object.
NotifyPageObjectRowDrilldown System Use Only Used by the User Interface when a 'RowDrilldown' event occurs for a Grid Page Object.
NotifyPageResize System Use Only Used by the User Interface to notify when a Page has been resized.
NotifyPageSetActionNotification System Use Only Used by the User Interface to notify when a Page Set has received a Notification Action.
NotifyPageSetActivate System Use Only Used by the User Interface to notify when a Page Set has been activated, e.g., the form on which it resides has been activated.
NotifyPageSetFormClosed System Use Only Used by the User Interface to notify when a child Page Set Form has been closed.
NotifySecurityStmtItemFormClosed System Use Only Used by the User Interface to notify when a Security Statement Item Form has been closed.
NotifyWizardButtonsUpdate System Use Only Used by the User Interface to notify that a wizard's buttons can be updated, e.g., to change their enabled state.
NotifyWizardMove System Use Only Used by the User Interface to notify that a wizard page is being moved to and give the Script a chance to skip it.
NotifyWizardRefresh System Use Only Used by the User Interface to notify that a wizard page is being moved FORWARD onto. This gives the Script a chance to load page-dependant data.
NotifyWizardValidate System Use Only Used by the User Interface to notify that a wizard page requires validating (i.e., moving forward through the wizard or upon clicking Finish).
PageObjectPrint Print a Page Object.
PageObjectsValidate Ask the User Interface to Validate Page Objects for the current page, e.g., check mandatory values are entered and max and min values restricted.
PageSetMakeReadOnly Set this Page Set to be Read-Only.
PerformWizardButtonsUpdate Force the Wizard Buttons Update event to be called.
SetEnabled Set the Enabled state of a Page Object.
SetEnabledByGroupTag Set the Enabled property of all Page Objects that have 'tag' in their comma-separated list of Group Tags.
SetReadOnly Set the Read-Only state of a Page Object.
SetReadOnlyByGroupTag Set the ReadOnly property of all Page Objects that have 'tag' in their comma-separated list of Group Tags.
SetValue Set the value of a Page Object.
SetVisible Set the Visible state of a Page Object.
SetVisibleByGroupTag Set the Visible property of all Page Objects that have 'tag' in their comma-separated list of Group Tags.
UpdateMousePointer Updates the Mouse Pointer to either show or not show the 'Wait' Pointer.
ValidatePageObjects Validate Page Objects, i.e., ensure all mandatory Page Objects have a value entered and all values entered are within maximum and minimum ranges.
WorkflowItemPerformAction Action a Workflow Item.
WorkflowItemSetOutcome Set the Outcome of a Workflow Item.

Properties

Name Description
CommandButtons Read-Only A collection of Command Buttons. Typically this collection would not be touched for 'Wizard' type Page Sets.
CurrentPage Read-Only The Current Page.
CurrentPageId The Id of the current Page.
CurrentPageIndex The Index of the current Page.
DataSource Read-Only The Data Source.
FormHeadingColour The Form Heading colour specified in HTML format, E.g., "red" or "#FF0000".
FormTitle The Form Title for the Page Set data entry form.
FormTitleResolved Read-Only The Form Title.
GroupTags Read-Only A collection of Group Tags which can be set to dynamically affect a control's visibility, read-only and enabled states.
IsInitialised Read-Only Indicates whether this Page Set Handler has been successfully Initialised.
NavigationMethod Read-Only The Navigation Method as defined by the Page Set.
NavigationMethodOverride Read-Only The override Navigation Method as defined by the Page Set.
NavigationMethodResolved Read-Only The Navigation Method as defined by the Page Set or overridden when this Page Set Handler was initialised.
PageSet Read-Only The Read-Only Page Set to which this handler relates.
PageSetId Read-Only The Id of the Page Set that this object has been initialised with.
PageSetPk Read-Only The primary key of the Page Set that this object has been initialised with.
Pages Read-Only A collection of Pages in this Page Set Handler.
Parameters Read-Only Parameters passed to this Page Set Handler when it was initialised.
ParentPageSetHandler Read-Only The Parent Page Set Handler if this Page Set Handler was created as a result of the FormShowPageSet method.
ProcessedWorkflowPk Read-Only The primary key of the Workflow that was processed via either the WorkflowItemPerformAction or WorkflowItemSetOutcome methods.
Reports Read-Only
UserInterface Read-Only
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0