finDocument Class

Represents a Document.
Implements I_ISDirty, I_ISObjectName, I_finSummaryPages, I_finExtendedAuditInformation, I_finAutoBackupDetails, I_ISRecordXmlImportable

Methods

Name Description
AuditItemsLoad Loads the Audit Items collection.
AuditItemsRefresh Forces the Audit Items collection to be reloaded from the database the next time it is accessed.
AutoBackupCreateUnsavedObjectFromXml
AutoBackupRollbackFromXml
Clear Clears this object and sets all of its properties to their defaults.
CodeDecrypt Decrypt the Script Code.
CodeEncrypt Encrypt the Script Code.
CodeExport Export Script Code to a File.
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.
CreateParameters System Use Only Create an ISParameters object based on this item's custom Parameters.
Delete Deletes the current record.
Duplicate Duplicates the current object.
FromXmlString Populates object from an XML string.
GetAutoBackupComparePropertiesList
GetAutoBackupCompareProperty
GetAutoBackupHistory
GetAutoBackupXml
GetObjectName
GetObsoleteMessage Get a Message and optional details of why this Document is obsolete.
GetTemplateCode Creates an empty Script function definition.
HasTemplateDocumentBinaryData
ImportXml
LinkUsageItemsLoad Loads the Link Usage Items collection.
LinkUsageItemsRefresh Forces the Link Usage Items collection to be reloaded from the database the next time it is accessed.
Load Loads a record from the database.
LoadPk Loads a record from the database.
Refresh Refreshes this object from the database.
Save Save this record.
SummaryPagesLoad Loads the Summary Pages collection.
SummaryPagesRefresh Forces the Summary Pages collection to be rebuilt the next time it is accessed.
ToXmlString Persists object to an XML string.

Properties

Name Description
Active Indicates whether this record is Active.
AllowExternalParty If this is an Account Document then this indicates whether an External Party can be linked to the Account Log created by this Document.
AllowExternalPartyText The Allow External Party in its String representation.
AllowLog Indicates whether this Document can be printed from a Log.
AllowStandalone Indicates whether this Document can used for 'Standalone' situations.
AuditItems Read-Only A collection of Audit Items.
AuditItemsLoaded Read-Only Indicates whether the Audit Items collection has been loaded.
AutoBackupAvailable Read-Only
AutoBackupDescription Read-Only
AutoBackupId Read-Only
AutoBackupRecordType Read-Only
AutoBackupTimestamp Read-Only
AutoBackupUniqueId
AutoBackupUsed Read-Only
AutoPublishPriority The Priority for this type of Document in any external (or internal) Automatic Publishing functionality.
AutoSaveDocument Indicates whether a copy of this Document should automatically be saved when it is created.
Bookmarks A comma separated list of line numbers which are Bookmarked in the Script Code.
Category The Category of this Document.
ChargeFee Indicates whether to charge a Fee when this Document is published.
CloudConnectAllowPublish Indicates whether this Document can be Published in finPOWER Connect Cloud.
CloudConnectAvailable Indicates whether this Document is available in finPOWER Connect Cloud.
Code The Script Code.
Constants Read-Only Constants that will be available to the Script via the ScriptInfo.Constants Key/Value List.
CreateLog Indicates whether a Log record should be created when this Document is created.
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.
DefaultPublishStatus The Default Publish Status.
DefaultPublishStatusText The Default Publish Status in its String representation.
Description The Description of this Document.
DoNotEmailDocumentForStandalone Indicates whether, in a Standalone publish of the Document is being performed and EmailDocument is set to Yes, this should be ignored.
DocumentEmailCopyOfPrimary Indicates whether Documents Emailed to Account Clients and Account Application Applicants should always be a copy of the primary Document rather than a personalised Document that would be created for printing purposes.
DocumentEmailDoNotCombineForJoints Indicates whether Document Emails contain personalised information and therefore should not be combined for Joint Clients or Applicants.
DocumentId The Id of this Document.
DocumentLogSubject The default Subject to use when creating Document Logs.
DocumentType The Document Type.
DocumentTypeAccountApp Indicates whether this 'Account' type Document also supports Account Applications.
DocumentTypeText The Document Type in its String representation.
EmailDocument Determines whether a Document should be emailed in preference to being printed.
EmailDocumentText The Email Document setting in its String representation.
EmailElectronicDisclosureClientCommunicationType
EmailElectronicDisclosureClientCommunicationTypeText
EmailHtml Indicates whether this Email type Document should be sent in HTML format.
EmailMessageTarget The Message Target for Email type Documents.
EmailMessageTargetText The Message Target for Email type Documents in its String representation.
EmbedDocumentInLog Indicates whether this Document should be Embedded in a Log (this is up to the Document Script to implement).
ExternalPartyCategories If 'AllowExternalParty' then this is the list of Categories to use when filtering the External Parties.
Fee The Fee Value to charge.
FeeElementId The Id of the Element to charge a Fee to.
FeeElementPk The primary key of the Fee Element.
FeeNotes The Fee Transaction Notes.
FeeReference The Fee Transaction Reference.
FileCategory The File Category to use when saving the File to the Document Manager.
FileName The Name of the Document File.
FileNameResolved Read-Only The Full Name of the Document File.
FileType The File Type.
FileTypeText The File Type in its String representation.
GenerateLog Determines whether a Log will be generated if applicable.
GenerateLogText The Generate Log setting in its String representation.
HtmlViewAsPdf Indicates whether HTML type Documents should be viewed as PDF documents.
IsDirty Read-Only Indicates whether this object has been modified since being created, loaded or refreshed.
IsEncrypted Read-Only Indicates whether the Script Code is Encrypted.
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.
LinkUsageItems Read-Only A read-only collection of Link Usage Items that relate to this Script.
LinkUsageItemsLoaded Read-Only Indicates whether the Link Usage Items collection has been loaded.
LogConfirmPrinted Indicates whether upon publishing a Document from a Log (E.g. a Client Log), the User should always be prompted to confirm that everything has printed successfully before the Logs are updated and fees charged.
LogType The Log Type to generate for Documents with a File Type of 'Log'.
LogTypeText The Log Type in its String representation.
Notes Notes about the Document.
ParameterSetId The Id of the Parameter Set used.
ParameterSetPk The primary key of the Parameter Set used.
Parameters Read-Only A collection of Parameters.
ParametersType The Type of Parameters used.
ParametersTypeText The Parameters Type in its String representation.
PermissionKeyExecute The Permission Key required to Execute this Document.
Pk Read-Only This record's primary key.
PrintDocumentEvenIfEmailed Indicates whether this Document should also be Printed if Emailed.
PrintOnPublish Indicates whether this 'Word Document' or 'Excel Workbook' should be printed upon publishing in certain places in the User Interface, e.g., the Create Document wizard.
SendToAccountGuarantors Indicates whether this Account Document should be sent to Guarantor Clients.
SendToAccountJoints Indicates whether this Account Document should be sent to Clients who are Joint to the Client above them.
SendToAccountOther Indicates whether this Account Document should be sent to Other Clients.
SendToAccountOwners If this is an Account Document then this indicates which Account Owner Clients will receive a copy of this Document.
SendToAccountOwnersText The Send To Account Owners in its String representation.
ShowInReportExplorer Indicates whether this Document should be displayed in the Report Explorer.
SplitDocumentByPostalZone Indicates whether a bulk Document i.e.. one printing copies for multiple Clients should generate a separate Document or at least a split in the Document being created (this is at the discretion of the Document) for each Postal Zone.
SummaryPages Read-Only A collection of Summary Pages.
SummaryPagesLoaded Read-Only Indicates whether the Summary Pages collection has been loaded.
SupportsBatchPrint Indicates whether this Document Supports Batch Print functionality.
Tag The Tag property can be used to attach another value or object to this object.
TargetObjectType A 'Context' for the Document Type; e.g., a Client Document might have a context of 'Credit Bureau Bank Account Enquiry'.
TemplateAllowModify Indicates whether the Template Message and Subject for SMS and Email documents can be modified by the User.
TemplateDocument The Template Document used for HTML Documents.
TemplateDocumentBinaryData The Template Document Binary Data used for Word Documents and Excel WorkBooks.
TemplateDocumentFormat The Template Document Format. NOT CURRENTLY USED.
TemplateMessage The Template Message used for SMS and Email Documents.
TemplateSubject The Template Text used for SMS and Email Documents.
TimeoutSeconds Obsolete Script timeout is not supported in versions 6 and above. This will always return zero.
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 System Use Only
UserDataWeb Read-Only System Use Only
UserFlagA A custom Flag which can be use from Summary Page Scripts, other Scripts or External Applications.
UserFlagB A custom Flag which can be use from Summary Page Scripts, other Scripts or External Applications.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0