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 ascendingNameSorted ascendingDescription
AB_DocNote: this property is not more supported since version 3.0. Notes back-end document that contains the action buttons as selected in the Integra profile. This property is not more in use and is kept only for compatibility reasons to Integra for Notes Release 2. The Action Buttons delivered with Int
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
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.
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'.
ActionOnlyThe processing of an Integra export profile consists basically of four steps: 1) The user selects the profile and eventually determines runtime options
2) Integra is extracting the data from Notes and pushes them into Word or Excel
3) Depending on profile settings the user is presented with the out
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
AddCategoryStaticVars.AddCategory (CatFormula As String) The AddCategory is called for every exported Notes document. It will evaluate the formula as defined in the Category Formula field of the Integra profile. It converts and adds the resulting value to an array of category strings (StaticVars.Category). De
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
AftWritMacrAfter Write Macro. Name of a Word or Excel macro to be executed after each Notes document is exported to Word or Excel. The execution of the macro follows the CB_AFTERWRITECOM event. This property is exposed to the profile creator in the advanced tab of the Integra profile. However, the name of the
AgentLogEntryAgentLogEntry (EntryType As Integer, EntryText As String) This procedure creates an entry in the Integra agent log database. The procedure can be used for debugging purposes and is particular useful for scheduled or web-browser driven profiles. Parameters: EntryType (Integer) 0 (zero) indicates a s
AgentsAgent - Administration\Inplace Editing Setup To enable the Inplace-Editing feature within an existing Notes application it is required to copy and inherit this agent into the target Notes database. This agent, referred to as the Inplace Editing Setup agent, allows creation and modification of t
AllIfNoneWhen using the Integra profile option "Selected Documents In Active View" to let the user select the documents to be exported, the AllIfNone property of the global Integra runtime object stats controls whether all documents in the view are exported in case the user selects none or if the export wil
ApiExpRTNotes API driven export for Notes rich text fields. In all versions of Integra prior to 4.0, Notes rich text is exported using the Notes Client user interface. The method used is basically to open each rich text field with a special form, to select all rich text content and to copy it into the Wind
ApiImpRTNotes API driven import of Word document content into Notes rich text fields. In all versions of Integra prior to 4.1, Word document content was imported into Notes rich text fields using the Notes Client user interface. The method used is basically to copy the Word document content into the Window
ArrayFormatArrayFormat (Item As Variant) As Variant This function is calling the FormatSingleValue() function. However, ArrayFormat will accept single values as well as arrays (even of mixed data types). In case an array is passed on, it will call the FormatSingleValue() function for each array element. Param
ArrayToStringArrayToString (ItemArr As Variant, Separator As String) As String This function converts an array of items into a text string, each array element separated by the separator string. Parameters: ItemArr (Variant) Array to be converted into a string. The array’s elements can consist of the
following
AttachFileAttachFile (Note As NotesDocument, Filename As Variant, SaveWithName As Variant, Rtitem As NotesRichtextItem, ReAttach As Integer, SaveDoc As Integer, KillFile As Integer, ShowPBar As Integer) As Integer This function is being replaced by the function EmbedFile() and is kept for compatibility reaso
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
AttNameThe AttName property contains the formula string evaluated at runtime to produce a computed filename for the Word documents, Excel spreadsheets or textfiles to be attached to automated email or Notes documents (Integra profile options SendTo or Save As...). The string has to evaluate to a valid fil
AutoColWdthThe AutoColWdth property controls whether the Excel spreadsheet is auto formatted once the export is complete with regards to the column width. If set to True the Excel spreadsheet is formatted, otherwise not. This property is exposed to the profile creator for all releases prior to 4.3 in the adva
AutoOvrWritIf using the Filename field in the Integra profile to pre-determine the filename for the Word, Excel or Text filename to be created, the AutoOvrWrit property controls whether an existing file with the same filename is automatically overwritten or if the user is being prompted to confirm. If the pro
AutoRowHghtThe AutoRowHght property controls whether the Excel spreadsheet is auto formatted once the export is complete with regards to the row height. If set to True the Excel spreadsheet is formatted, otherwise not. This property is exposed to the profile creator for all releases prior to 4.3 in the advanc
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
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
ButtonsNote: this property is not more supported since version 3.0. Contains a NotesRichtextItem object storing the Action Buttons selected in the Integra profile. This property is not more in use and is kept only for compatibility reasons to Integra for Notes Release 2. The Action Buttons delivered with
C-API COMDLG32.DLL (Windows) - Function ListThe following is a list of C-API function declarations of the COMDLG32.DLL of Windows. These declarations are used by some of the Lotus Script functions documented for the WinAPIWrapper, Utilities and InplaceEditing libraries. For further documentation to these C-API calls please refer to the C-API
C-API NNOTESWS.DLL (Notes) Function ListThe following C-API calls are used in the LNProgressBar and ProgressBar class methods. For further documentation to these C-API calls please refer to the C-API documentation of Lotus Notes/Domino. Declare Function NEMProgressBegin Lib "nnotesws.dll" _ ( Byval wFlags As Integer ) As Long Declare S
C-API USER32.DLL (Windows) - Function ListThe following is a list of C-API function declarations of the USER32.DLL of Windows. These declarations are used by some of the Lotus Script functions documented for the WinAPIWrapper, Utilities and InplaceEditing libraries. For further documentation to these C-API calls please refer to the C-API d
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
CatCountWhen exporting selected documents from the currently active view, Integra will evaluate any category formula as defined in the executed Integra profile for each exported Notes document. CatCount contains the number of category elements created: stats.CatCount = ubound(stats.category) +1 Note: using


     




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