finPortal Class

Represents a Portal.
Implements I_ISDirty, I_ISObjectName, I_finSummaryPages, I_finAutoBackupDetails, I_ISRecordXmlImportable

Methods

Name Description
AutoBackupCreateUnsavedObjectFromXml
AutoBackupRollbackFromXml
Clear Clears this object and sets all of its properties to their defaults.
ClientHasPermissionToView Indicates whether a Client Has Permission to View this Portal.
CodeExport ' The unencrypted Code without any directives resolved. '
CodeHash Return a hash of the code, useful to compare two scripts.
CodeImport Import Script Code from a File.
CompileForTesting Obsolete Attempt to Compile the Script Code.
CompileScriptForTesting Attempt to Compile the Script Code.
ConstantsAddFromScript Add Constants from remarks defined in the Script.
CurrentUserHasPermissionToView Indicates whether the Current User Has Permission to View this Portal.
Delete Deletes the current record.
DirtyClear System Use Only
Duplicate Duplicates the current object.
EditProtectionClear Clear User Interface Edit Protection.
EditProtectionSet Set User Interface Edit Protection.
EditProtectionVerifyPassword Verify the Edit Protection Password.
ExecuteHtmlWidget Execute an HTML Widget type script since a Portal is basically the same as an HTML Widget.
FromSplitObjectExportList Populates the object from a finSplitObjectExportList collection.
FromXmlString Populates object from an XML string.
GetAutoBackupComparePropertiesList
GetAutoBackupCompareProperty
GetAutoBackupHistory
GetAutoBackupXml
GetDefaultPageId Get the Page Id of the default Portal Page.
GetObjectName
GetRelatedScriptsList System Use Only Get a List of Scripts that are referenced by this Portal, e.g., HTML Widgets.
GetTemplateCode Creates an empty Script function definition for a Script.
GetTemplateHtml Get Template HTML for a Portal Page.
GetWarnings Get Warnings.
HasCustomLoginPage Check to see if an Active custom Login Page is defined (and that this Page allows Anonymous Access).
HasRemotePublishWarnings Get Remote Publish Warnings.
ImportXml
Load Loads a record from the database.
LoadPk Loads a record from the database.
Publish Publish to a remote database.
Refresh Refreshes this object from the database.
ResourcesLoad Loads the Resources collection.
ResourcesRefresh Forces the Resources collection to be reloaded from the database the next time it is accessed.
Save Save this record.
SecretKeyGenerate Generate a new Secret Key.
SummaryPagesLoad Loads the Summary Pages collection.
SummaryPagesRefresh Forces the Summary Pages collection to be rebuilt the next time it is accessed.
ThemeFromXml Populates Theme information from an XML string.
ThemeToXml Persists Theme information to an XML string.
ToSplitObjectExportList Create a Split Object Export List containing XML, code and master page information etc.
ToXmlString Persists object to an XML string.
UserDataClear Clear User Data.

Properties

Name Description
AccessDeniedMessageHtml HTML formatted Message to display if a Client is denied access to a Portal due to Client Group or User Data Field restrictions.
Active Indicates whether this record is Active.
AllowPasswordResetLink Indicates whether to allow a Password Reset Link to be sent for this Portal.
AllowRemotePublish Indicates whether to allow a Remote Publish of this Portal.
AuthenticationMethod The Authentication Method.
AuthenticationMethodText The Authentication Method in its String representation.
AutoBackupAvailable Read-Only
AutoBackupDescription Read-Only
AutoBackupId Read-Only
AutoBackupRecordType Read-Only
AutoBackupTimestamp Read-Only
AutoBackupUniqueId
AutoBackupUsed Read-Only
Beta The Portal's 'Beta' status.
Bookmarks A comma separated list of line numbers which are Bookmarked in the Script Code.
ChangePasswordFormCustomMessage A Custom HTML Message to display on the Change Password form.
ClientGroupsView A Client Groups Range to restrict viewing of this Portal.
ClientSignInMethod The Authentication Method.
ClientSignInMethodText The Authentication Method in its String representation.
Code The Script Code.
Constants Read-Only Constants that will be available to the Script via the ScriptInfo.Constants Key/Value List.
CreatedDate Read-Only The Local date and time this record was created.
CreatedUserPk Read-Only The primary key of the User that created this record.
CreatedUtcDate Read-Only The UTC date and time this record was created.
CustomLoginPageId The Page Id of the Page designated to represent a Custom Login Page.
DataAdaptorScriptId The Id of the Script that the Portal can use as a Data Adaptor.
DataAdaptorScriptPk The primary key of the Script that the Portal can use as a Data Adaptor.
Description The Description of this Portal.
EditProtectionEnabled Read-Only ' Indicates whether the Script Code is Encrypted. '
EnforcePasswordChange Indicates whether, if a User or Client is flagged to be forced to change their password, this is automatically enforced by the Portal.
ExternalPartiesView An External Parties Range to restrict viewing of this Portal.
FileUploadFileExtensionsCsv A comma-separated list of File Extensions to limit File Uploads to.
FileUploadSizeLimitBytes The number of Bytes to limit File Uploads to.
ForceLoginForNewBrowserTab Indicates whether to force the user to re-login when opening a new browser tab.
FormMinimumHeight The Minimum Height of the Form in pixels.
FormMinimumHeightResolved Read-Only
FormMinimumWidth The Minimum Width of the Form in pixels.
FormMinimumWidthResolved Read-Only
HasScript Read-Only Indicates whether this Portal has Script code to use.
Icon The name of the Icon used to represent this Portal in certain situations.
ImportNotes Import Notes.
IsDirty Read-Only Indicates whether this object has been modified since being created, loaded or refreshed.
IsNew Read-Only Indicates whether this is a new record.
Language The Programming Language that the Script Code is written in.
LanguageText The Programming Language in its String representation.
LockedOutMessageHtml HTML formatted Message to display if a Client or User is denied access due to being Locked Out after too many failed password attempts.
LoginFormBackgroundImageUrlOrResource The Id of a Resource or a fully qualified URL of a Background Image to display on the Login form.
LoginFormCustomMessage A Custom HTML Message to display on the Login form.
LoginFormInlineResource A Resource that will be inlined in the built-in Login form.
LoginFormLogo The Login Form Logo to use.
LoginFormLogoCentre Indicates whether the Centre the Login Form Logo.
LoginFormLogoHeight The Height to fix the Login Form Logo to in pixels.
LoginFormLogoHyperlinkUrl A URL to provide as a hyperlink when clicking the Login Form Logo.
LoginFormLogoText The Login Form Logo in its String representation.
Logo1Url The Theme Logo 1.
Logo2Url The Theme Logo 2.
Logo3Url The Theme Logo 3.
Logo4Url The Theme Logo 4.
MasterPage Master Page.
MasterPageBookmarks A comma separated list of line numbers which are Bookmarked in the Master Page.
MultiFactorAuthenticationDeferDays The number of Days a User can Defer being prompted for a MFA code after signing in from a particular device.
MultiFactorAuthenticationDeferDaysDefault Indicates whether the Defer Days prompt for a MFA is checked by default.
MultiFactorAuthenticationDeferDaysPreventUserChange Prevent the User from NOT deferring MFA for the configured Defer Days.
MultiFactorAuthenticationIssuer The Issuer for OTP-based Multi-Factor Authentication.
MultiFactorAuthenticationIssuerResolved Read-Only The Issuer for OTP-based Multi-Factor Authentication (the Portal Description if unspecified).
MultiFactorAuthenticationMethod The Multi-Factor Authentication Method (MFA) to use.
MultiFactorAuthenticationMethodText The Multi-Factor Authentication Method in its String representation.
MultiFactorAuthenticationRolesExclude A Roles Range to exclude from Multi-Factor Authentication for User-based Portals.
MultiFactorAuthenticationTotpAllowEmail Indicates whether, when using an Authenticator App (TOTP) for Multi-Factor Authentication Method (MFA), a Client can opt to authenticate via their Email address.
MultiFactorAuthenticationTotpAllowEmailDefault Indicates whether, when using an Authenticator App (TOTP) for Multi-Factor Authentication Method (MFA), a Client can opt to authenticate via their Email address and then make this their default MFA method (i.e., they can bypass the Authenticator App and just use Email).
Name The Name of this Portal.
NameResolved Read-Only The Name of this Portal.
Notes Notes regarding the Portal.
Pages Read-Only A collection of Pages.
PasswordResetSentMessageHtml HTML formatted Message to display if a Client or User has requested a Password Reset Email.
PasswordResetSentMessageHtmlResolved Read-Only HTML formatted Message to display if a Client or User has requested a Password Reset Email.
PasswordResetUseClientWebUserId Indicates whether a Client's Web User Id is also their Email to send Password Reset links to and also for Email-based Multi-Factor Authentication.
PermissionKeyView The Permission Key required to view this Portal.
PermissionShowExternalPartyBroker Indicates whether User's for Broker External Parties can view this Portal.
PermissionShowExternalPartyBulkFunder Indicates whether User's for Bulk Funder External Parties can view this Portal.
PermissionShowExternalPartyDealer Indicates whether User's for Dealer External Parties can view this Portal.
PermissionShowExternalPartyInsurer Indicates whether User's for Insurer External Parties can view this Portal.
PermissionShowExternalPartyOther Indicates whether User's for Other External Parties can view this Portal.
Pk Read-Only This record's primary key.
PortalId The Id of this Portal.
PwaEnabled Indicates whether Progressive Web App support is enabled.
PwaIcon256Url The PWA Icon as a 256x256 PNG Image URL.
PwaName The PWA App Name.
PwaShortName The PWA App Short Name.
RemotePublishPassword The Web Services User Password to Remote Publish to.
RemotePublishUrl The Web Services URL to Remote Publish to.
RemotePublishUserId The Web Services User Id to Remote Publish to.
ResetPasswordFormCustomMessage A Custom HTML Message to display on the Reset Password form.
ResourceCssSummaryPage2 Indicates whether an HTML Widget requires the Summary Page (Version 2) Stylesheet.
ResourceCssWidget Indicates whether to include the HTML Widget Stylesheets for ALL Portal Pages.
ResourceJQuery Indicates whether an HTML Widget requires jQuery.
ResourceJQueryVersion The jQuery Version to use for HTML Widgets.
ResourceJQueryVersionResolved Read-Only The jQuery Version to use for HTML Widgets.
Resources Read-Only A collection of Resources for this Portal.
ResourcesChanged Read-Only Indicates whether the Resources collection has been loaded and has had changes made to it.
ResourcesLoaded Read-Only Indicates whether the Resources collection has been loaded.
RolesView A Roles Range to restrict viewing of this Portal.
SecretKey The Web Subscriber's Secret Key.
SendDebugInformation Indicates whether send 'Debug-NNN' HTTP Headers with the HTTP Response.
SessionTimeoutMinutes The Session Timeout in Minutes.
SessionTimeoutMinutesResolved Read-Only The Session Timeout in Minutes.
StylingUseDesktopStyles Use Desktop Styling in HTML Widgets hosted within finPOWER Connect (desktop) to make HTML Widgets more resemble Desktop forms
StylingUseGlobalSettings Use Global Styling (defined within finPOWER Connect Cloud Preferences) in HTML Widgets hosted within finPOWER Connect (Global) to make HTML Widgets more resemble Global forms
StylingUseInHtmlWidgetsExternal Use Styling information in HTML Widgets hosted in External Portals.
StylingUseInHtmlWidgetsInternal Use Styling information in HTML Widgets hosted within finPOWER Connect (desktop).
SummaryPages Read-Only A collection of Summary Pages.
SummaryPagesLoaded Read-Only Indicates whether the Summary Pages collection has been loaded.
SupportsSessionState Indicates whether this Portal supports Session State.
Tag The Tag property can be used to attach another value or object to this object.
Theme Read-Only Theme Settings for HTML Widgets.
ThemeColourOther1 The Theme "Other 1" Colour.
ThemeColourOther1Resolved Read-Only The Theme "Other 1" Colour.
ThemeColourOther2 The Theme "Other 2" Colour.
ThemeColourOther2Resolved Read-Only The Theme "Other 2" Colour.
ThemeContrastColourBackground The Theme Contrast Background Colour.
ThemeContrastColourBackgroundResolved Read-Only The Theme Contrast Background Colour.
ThemeContrastColourForeground The Theme Contrast Foreground Colour.
ThemeContrastColourForegroundResolved Read-Only The Theme Contrast Foreground Colour.
ThemeMainColourBackground The Theme Main Background Colour.
ThemeMainColourBackgroundResolved Read-Only The Theme Main Background Colour.
ThemeMainColourForeground The Theme Main Foreground Colour.
ThemeMainColourForegroundResolved Read-Only The Theme Main Foreground Colour.
ThemeName The Theme Name.
ThemeNamePlus1 Additional Theme Name 1.
ThemeNamePlus2 Additional Theme Name 2.
Timestamp Read-Only This record's Timestamp.
UniqueId A Unique Id that identifies this record for Auto-Backup and Source Control operations.
UpdatedDate Read-Only The Local date and time this record was last updated.
UpdatedUserPk Read-Only The primary key of the User that last updated this record.
UpdatedUtcDate Read-Only The UTC date and time this record was last updated.
UserData Read-Only User Defined data.
UserDataFieldView A name of a Boolean User Data Field. If this field does not exist or is not True then the Client will be denied access to this Portal.
UserDataWebFieldView A name of a Boolean Web User Data Field. If this field does not exist or is not True then the Client will be denied access to this Portal.
Version A Version number that can be used to track the latest Version of this Portal (for information purposes).
VersionDate A Version number that can be used to track the latest Version of this Portal (for information purposes).
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0