Integra for Notes Banner
  QuickReports Integra4Notes Integra Family of Products

Online documentation of the Integra for Notes runtime libraries and object classes



Click here for applet version of the view.

.
Collapse categories      
LibraryCan be sorted ascendingNameCan be sorted ascendingDescription
Show details for Inplace EditingInplace Editing
Hide details for Runtime Object ClassesRuntime Object Classes
Show details for FileExportFileExport
Show details for FileImportFileImport
Show details for FileRecordFileRecord
Hide details for FileStructureFileStructure
Show details for Class DefinitionClass Definition
Show details for Class Method (Function)Class Method (Function)
Hide details for Class PropertyClass Property
ActionRuntime COM action as selected on the Integra profile or by the user in the runtime dialogs (Prompt User option). Possible actions values are 'Activate', 'Print', 'Print/Preview', 'Save To File' and 'None'. Note: this property is redundant. Integra is always referring to the stats.Action property.
CbActionThe CbAction property contains the advanced Lotus Script as defined in the Script Callback field of the Integra profile. Integra executes the script at its runtime events. Default structure of advanced callback script explained
Advanced error handler script explained
CbErrHndThe CbErrHnd property contains the advanced Lotus Script as defined in the Script Error Handler field of the Integra profile. Integra executes the script if an error exception is triggered at runtime either by Integra's own runtime libraries, any advanced callback formula or callback script. Advanc
CbFormulaThe CbFormula property contains the advanced Lotus Formula as defined in the Formula Callback field of the Integra profile. Integra evaluates the formula at its runtime events. Note: advanced formula does not allow to control Integra's process flow, it simply provides an alternative method for data
ColOffsThe ColOffs property represents the Column Offset field in the Integra profile. The default value is 0 (zero), which means that Integra reads and writes starting from the first column in the Excel spreadsheet. An offset of one means Integra starts from column 2, etc. Note: if the Integra profile ha
CopyButtonNote: this property is no more supported since version 3.0 Contains the name of the Action Button Set selected in the Integra profile, to be attached together with the Word or Excel document into a Notes document. This property is not more in use and is kept only for compatibility reasons to Integr
DelimiterRefers to the Text Delimiter field in the Integra profile. It contains the delimiter to be used to enclose the content of fields exported as text (string). Since version 4.0 Integra supports three types of text file exports: XML
CSV
Text (Custom) For XML format this property is ignored, for CSV for
ErrorTextIf an error exception occurs because of an internal error of the Integra script libraries the ErrorText property contains the error message including error code, line number and method of occurance. At the same time the FileStructure.IsError property is set to True. Errors in the FileStructure clas
FileNameRefers to the Filename field in the Integra profile (Word, Excel or Text tab). It stores either a predefined filename for the Integra output file according to the Filename field or Integra creates a random filename in its temporary directory. Note: Integra will not clean up temporary files outside
FileTypeDepending on the profile type it contains either one of the following keywords: Word
Excel
Text
FileUseRefers to the Used for field in the Integra profile. It contains either one of the following keywords: Import
Export
FMacrThis property refers to the Lotus Formula created to computed fields in the Selected Field List in the Integra profile. The number of elements reflects the number of fields in the Selected Field List. If no formula has been defined or the field simply is not of type formula, then the value is "None
FnameThe Fname property contains the fieldnames in order as selected in the Selected Field List of the Integra profile. The number of elements reflects the number of fields in the Selected Field List. If the fieldnames include ohne of the field exchange type extensions (.NFXBOTH, .NFXNOTES, .NFXCOM), th
FNFXThis property refers to the field exchange option for the fields in the Selected Field List in the Integra profile. The number of elements reflects the number of fields in the Selected Field List. If the fieldnames include ohne of the field exchange type extensions (.NFXBOTH, .NFXNOTES, .NFXCOM), t
FtypeThe Ftype property contains the data typew code for each field as selected in the Selected Field List of the Integra profile. The number of elements reflects the number of fields in the Selected Field List. The following table shows the list of supported field (data) types and their respective codi
ImportWordAsThe ImportWordAs property refers to the 'Import Word As' field in the Integra profile. The options are 'Attachment', 'Notes Richtext' or 'Embedded Object'. Attachment: Integra creates a new Notes main document with the Word document attached to it. Notes Richtext: Integra creates a new Notes main d
IsErrorIf an error exception occurs because of an internal error of the Integra script libraries the IsError property is set to True. At the same time the FileStructure.ErrorText property contains the error message. Errors in the FileStructure class can only occur during the runtime initialisation proces
KeepPrivateFor all versions of Integra prior to release 4.3 this property reflects the 'Do Not export if documents are marked private' or 'Export anyway' option in Advanced tab of the Integra profile allowing the profile developer to either allow or not allow the export of private documents . In Integra 4.3
LabelNumThe LabelNum property refers to the '# of Labels' field in the word tab of the Integra profile. Since Integra 4.0 this property is only relevant for Word Label profiles that use the Advanced COM export method.
MailActionThe MailAction property refers to the advanced Send To options 'Immediete', 'Confirm' & 'Memo' in the Notes Action tab of the Integra profile. The availability of each of the three options depends on the context in which the profile runs. Integra provides public constants for the three options. It
MultiValueThe MultiValue property refers to the Multivalue Separator field in the Integra profile. The character or character string stored in this property is used to normalise Notes multi value fields (arrays) to single character string. The default value is CR, which is a shortcut for Carriage Return (whi


     




To download the PDF versions of the on-line documentation click on the icons below:

FileStructure.pdfFileRecord.pdfFileImport.pdfFileExport.pdfUtilities.pdfStaticVars.pdfInplaceEditing.pdf

.

 
QUICK LINKS
 
 

 

  © Shireburn Software Ltd. 2008 - 2024