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
Show details for Runtime Object ClassesRuntime Object Classes
Hide details for Sample CodeSample Code
Hide details for GeneralGeneral
Add fields to documents created with the Save As... optionsConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
Advanced error handler script explainedThe default advanced error handler script provides a means to control what happens if a runtime error exception occurs either in Integra's runtime script libraries or any advanced formulae or script. Unlike the advanced callback formula or callback script, the error handling script requires no defa
Blank CodeConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
Calling Word macros at specific eventsThe most common use of the Word application object is to run Word macros included in the Word template attached to the Integra profile. A typical situation to use macros is to automate the task of final document formatting. This developer documentation, for instance, is written in hundreds of Notes
Changing the order of Excel Workbook sheetsWhen Integra for Notes exports data to a Microsoft Excel spreadsheet, it allways pushes the data into the first sheet within the Excel template attached to the Integra profile. A need may arise to export data for further processing, for instance, the creation of table of totals and in addition a co
Coded filter condition & time-stamp for exported documentsNote: in this sample the exported Notes documents are modified on file. This process might create Save & Replication Conflicts if users and / or other processes modify the same documents at the same time and / or in a different database replica. Const CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Cons
Common time-stamp for imported documentsConst CB_INITIALISE = 3
Const CB_BFORIMPORT = 11
Const CB_BFORREADCOM = 7
Const CB_BFORWRITENOTES = 2
Const CB_TERMINATE = 4 select case stats.cbstatus
case CB_INITIALISE
case CB_BFORIMPORT
case CB_BFORREADCOM
case CB_BFORWRITENOTES stats.ImpDoc.ImportDateTime = stats.TimeStamp case CB_TERMINATE
en
Default structure of advanced callback formula explainedThe default advanced callback formula basically provides an @if(...) construct for the different Integra events. The developer can insert custom formula coding beneeth each event condition. The occurance of events depends on various settings of the Integra profile. The following 2 table show the av
Default structure of advanced callback script explainedThe default advanced callback script basically provides a select construct for the different Integra events. The developer can insert custom script coding beneeth each event case. The occurance of events depends on various settings of the Integra profile. The following 2 table show the availability
Disable Integra's sorting for selected documentsThis sample shows a simple use of the stats.DoSort property in disabling the sorting of selected documents (Selected Documents in Active View option). Setting the property to False will increase performance. Const CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID
Dynamically changing the attachment name prefix for Save As / Send ToConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
FileStructure & FileRecord Classes - Field Names and ValuesConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
Forcing a specific unicode character setNote: Text import profiles do currently not support unicode character set. Const CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_
Import new Notes documents or update existing onesConst CB_INITIALISE = 3
Const CB_BFORIMPORT = 11
Const CB_BFORREADCOM = 7
Const CB_BFORWRITENOTES = 2
Const CB_TERMINATE = 4 select case stats.cbstatus
case CB_INITIALISE
case CB_BFORIMPORT
case CB_BFORREADCOM
case CB_BFORWRITENOTES ' The following code will search for an eventual existing
' docum
Insert Excel row on value change of Category FormulaNote: since version 4.3 this can be achieved using the CB_CATEGORY event or by looking at the stats.CurCatValue and stats.CurCatLevel property. However, the CB_CATEGORY event as well as the two StaticVars properties are not available for all export scenarios, hence this sample is still very much va
Insert Excel row on value change of category value in stats.CatStr[]Note: since version 4.3 this can be achieved using the CB_CATEGORY event or by looking at the stats.CurCatValue and stats.CurCatLevel property. However, the CB_CATEGORY event as well as the two StaticVars properties are not available for all export scenarios, hence this sample is still very much va
Notify user of the total number of documents exportedThis sample shows a simple use of the stats.DocCnt property in displaying its value to the user at the end of the export. stats.DocCnt represents the total number of actually exported documents (excluding any selected documents that might have been filtered out due to filter condition settings in t
Present custom dialog to set full text filter condition at runtimeConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
Removing Excel template comments before Save As... or Send To...In a scenario where an Excel template attached to the Integra profile contains comments to indicate to the user the places where the exported Excel spreadsheet needs to be completed prior to sending it as a mail attachment or prior to save it back into a Notes database, these comments do not need t
Removing Word template comments before Save As... or Send To...In a scenario where a Word template attached to the Integra profile contains comments to indicate to the user the places where the exported Word document needs to be completed prior to sending it as a mail attachment or prior to save it back into a Notes database, these comments do not need to be i
UI driven rich text exportConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
UI driven rich text importConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
Use of Inputbox() to change stats.DateTextConst CB_INITIALISE = 3
Const CB_ACTIONONLY = 16
Const CB_BFOREXPORT = 10
Const CB_INVALID = 12
Const CB_CATEGORY = 13
Const CB_TOTAL = 14
Const CB_CONFLICT = 15
Const CB_BFORREADNOTES = 6
Const CB_BFORWRITECOM = 1
Const CB_AFTERWRITECOM = 9
Const CB_BFORCOMACTION = 5
Const CB_BFORNOTESACTION = 2
C
Show details for UtilitiesUtilities
Show details for WinAPIWrapperWinAPIWrapper


     




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