finQueue Class

Represents a Queue.
Implements I_ISDirty, I_ISObjectName, I_finSummaryPages, I_finExtendedAuditInformation

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.
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 this record.
Duplicate Duplicates this object.
FromXmlString Populates object from an XML string.
GetObjectName
GetTemplateCode Creates an empty Script function definition.
ItemsLoad Loads the Items collection.
ItemsRefresh Forces the 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.
UserDataInitialiseFromParameterSet Initialise User Data from a Parameter Set, i.e., create User Data entries and defaults.

Properties

Name Description
Active Indicates whether this record is Active.
AuditItems Read-Only A collection of Audit Items.
AuditItemsLoaded Read-Only Indicates whether the Audit Items collection has been loaded.
Bookmarks A comma separated list of line numbers which are Bookmarked in the Script Code.
Code The Script Code.
Constants Read-Only Constants that will be available to the Script via the ScriptInfo.Constants Key/Value List.
CopyExportedFilesToFolder Indicates whether Exported Files will be copied to a Folder after the Queue has been run.
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.
Description A Description of this Queue.
EmailExportedFiles Indicates whether Exported Files will be Emailed after the Queue has been run.
EmailMessage The Email Message to use when EmailExportedFiles is True.
EmailMessageTarget The Email Message Target to use when EmailExportedFiles is True
EmailRecipients The Email Recipients to use when EmailExportedFiles is True.
EmailSubject The Email Subject to use when EmailExportedFiles is True.
ExportFolder The Folder to use when CopyExportedFilesToFolder is True.
ExportReportData Indicates whether Report Data will be Exported when this Queue is run.
ExportReports Indicates whether Reports will be Exported when this Queue is run.
HasPermissionToExecute Read-Only Indicates whether the Current User Has Permission to Execute this Script.
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.
Items Read-Only A collection of Items.
ItemsChanged Read-Only Indicates whether the Items collection has been loaded and has had changes made to it.
ItemsLoaded Read-Only Indicates whether the Items collection has been loaded.
Language The Programming Language that the Script Code is written in.
LanguageText The Programming Language in its String representation.
Notes Notes about the Queue.
OverrideReportPrinter Indicates whether the Printer defined on each Report in this Queue should be Overridden.
OverridingPrinterName The Name of the Printer to use if OverrideReportPrinter is True.
Parameters Read-Only A collection of Parameters.
PermissionKeyEdit The Permission Key required to Edit this Queue.
PermissionKeyExecute The Permission Key required to Execute this Queue.
Pk Read-Only This record's primary key.
PreviewFormsClose Indicates whether Report Preview Forms will be Closed after the Report has been Previewed.
PreviewFormsMinimise Indicates whether Report Preview Forms will be Minimised after the Report has been Previewed.
PrintReports Indicates whether Reports will be Printed when this Queue is run.
QueueId The Id of this Queue.
ShowInMenu Indicates whether this Queue should be displayed in the Menu.
SummaryPages Read-Only A collection of Summary Pages.
SummaryPagesLoaded Read-Only Indicates whether the Summary Pages collection has been loaded.
Tag The Tag property can be used to attach another value or object to this object.
TimeoutSeconds Obsolete Script timeout is not supported in versions 6 and above. This will always return zero.
Timestamp Read-Only This record's Timestamp.
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.
UserDataWeb Read-Only System Use Only
UserDefinedParameterSetId The Id of the Parameter Set used to enter User Defined details.
UserDefinedParameterSetPk The primary key of the Parameter Set used to enter User Defined details.
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0