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
Hide details for FileExportFileExport
Show details for Class DefinitionClass Definition
Show details for Class Method (Function)Class Method (Function)
Hide details for Class Method (Procedure)Class Method (Procedure)
ActionAction (stats As StaticVars) This method executes the defined COM (Word or Excel) actions. It also calls the export.NotesAction method. Though the method does exist for Text profiles including the associated CB_BFORCOMACTION event, Text profiles by nature do not include (support) any COM action and
AttachToDocumentAttachToDocument (stats As StaticVars) This method represents the likewise named Attach To Document option in the Notes Action tab of the Integra profile. The method attaches a Word or Excel document to each exported Notes document. However, before doing so it calls the CB_BFORNOTESACTION event. It
BlankNotUsedLabelBlankNotUsedLabel (stats As StaticVars) In the context of a Word Label profile, using Advanced COM as the method of export, Integra feeds every label in the Word template one by one. On the last exported label page, one or more labels might not be filled because the last to be exported document has
CopyAndPasteRTFCopyAndPasteRTF(stats As staticVars, rtfield As String, WordRange As Variant, callinstance As Integer) Main procedure called for exporting Notes rich text fields to Word. Since the introduction of the API export as the default method with Integra for Notes version 3, this procedure simply calls the
InitialiseWordDocInitialiseWordDoc (stats As staticVars) This method is called whenever Integra requires to create a draft Word document from the template attached to the Integra profile (if any) or otherwise a blank document. Parameters: stats (StaticVars) Handle to Integra's runtime object stats
MailRecipientEvalMailRecipientEval (stats As StaticVars, evalstr As String, resarr() As String) This method evaluates the formulae defined in the Send To, Copy To and BCC fields in the Integra profile. The method is called for each formula from within the export.SendTo method. If the formula in evalstr returns an a
MergeFileMergeFile (stats As StaticVars, keepold As Integer) This method is only called for Word profiles using the Advanced COM export method. For the Advanced COM method, Integra needs to merge the Word documents rather then leaving it to Word's inbuilt functionality. Parameters: stats (StaticVars) Handle
NotesActionSub NotesAction (stats As StaticVars) The export.NotesAction method executes the Send To... or Save As... options as defined in the Integra profile (see stats.NotesAction property) Parameters: stats (StaticVars) Handle to Integra's runtime object stats
ProtectDocumentProtectDocument (stats As staticvars) This method sets the Word document protection properties as defined in the Integra profile and or selected in the Prompt User dialog. The method is called just before the Word document is activated, sent or saved back to Notes. In mailmerge scenarios this call
ProtectXlsProtectXls (stats As staticvars) This method sets the Excel workbook protection properties as defined in the Integra profile and or selected in the Prompt User dialog. The method is called just before the Excel document is activated, sent or saved back to Notes. Parameters: stats (StaticVars) Handl
RunCOMmacroRunCOMmacro (stats As staticvars, macroname As String) This method is called from export.IsExecuteCallback before the CB_AFTERWRITECOM and CB_BFORCOMACTION event to execute the respective Word or Excel macros as defined in the Integra profile's advanced tab. Parameters: stats (StaticVars) Handle to
SaveAsDocument SaveAsDocument (stats As StaticVars) This method represents the likewise named Save As Document option in the Notes Action tab of the Integra profile. The method creates a new Notes document in either the source or alternatively defined database and attaches the Word or Excel document to it. Howeve
SaveAsResponse SaveAsResponse (stats As StaticVars) This method represents the likewise named Save As Response option in the Notes Action tab of the Integra profile. The method creates a new Notes response document to each exported Notes document in the source database and attaches the Word or Excel document to i
SendToSendTo (stats As StaticVars) This method represents the likewise named Send To option in the Notes Action tab of the Integra profile. The method creates a memo (mail) document (stats.memo) for a set of recipients as defined in the Integra profile and either attaches copy of the Word or Excel docume
UnProtectDocumentUnProtectDocument (stats As staticvars) This method removes all the Word document protection properties. The method is called at different stages of the processing to ensure that Integra doesn't fail writing to the Word document. Any protection settings in the profile or at runtime will be enabled
UnProtectXlsUnProtectXls (stats As staticvars) This method removes all Excel workbook protection properties. The method is called at different stages of the processing to ensure that Integra doesn't fail writing to the Excel spreadsheet. Any protection settings in the profile or at runtime will be enabled afte
UpdateFXFieldsUpdateFXFields(stats As StaticVars) This method creates / updates fields on a Notes document created by one of the export.SaveAsDocument, export.SaveAsResponse and export.AttachToDocument methods from fields or tags in the Word or Excel file that is to be attached to that same Notes document. The f
WordActivateWordActivate (stats As staticvars) The method activates the Word document on screen. If the profile forces PDF output or the user chose to convert to PDF output then this method will convert the Word document to PDF and activate the PDF file. For profiles using the Normal export method, export.Word
WordPreviewWordPreview (stats As staticvars) The method activates the Word document in Word's preview mode on screen. If the profile forces PDF output or the user chose to convert to PDF output then this method will convert the Word document to PDF and activate the PDF file. For profiles using the Normal exp
WordWebActivateWordWebActivate (stats As staticvars) Note: the method is only relevant for web enabled profiles. The method activates the Word document in the web browser by way of sending the Word document's URL to the currently open browser window (which is the Integra progress bar). The URL points to Integra's
WriteExcelPropertiesWriteExcelProperties (stats As staticvars) This method writes the value of the fields listed in the Selected Field List of the Integra profile which refer to Excel Properties (EXCEL.PROPERTIES.property) to the respective Excel Workbook properties. The value is either taken from a field of the Note
WriteNextWriteNext (stats As StaticVars) Integra for Notes release 4 and later This method is called for every Notes document to write the collected data depending on the method of export to one of the following output files: CSV Used for either Text profiles or as a temporary export file for Word and Excel
WriteWordPropertiesWriteWordProperties (stats As staticvars) This method writes the value of the fields listed in the Selected Field List of the Integra profile which refer to Word Properties (WORD.PROPERTIES.property) to the respective Word document properties. The value is either taken from a field of the Notes doc
XlsActivateXlsActivate (stats As staticvars) The method activates the Excel Workbook on screen. If the profile forces PDF output or the user chose to convert to PDF output then this method will convert the Word document to PDF and activate the PDF file. The method is called provided the respective option is s


     




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