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
Show details for Sample CodeSample Code
Hide details for UtilitiesUtilities
Hide details for FunctionFunction
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
CheckRightsCheckRights (Role As String) As Integer This function checks whether a particular user role has been assigned to the current user’s ACL entry of the current database. Parameters: Role (String) The role to be checked. Return Value: Integer. True or False.
CreateMemoCreateMemo (SendTo() As String, CopyTo() As String, Bcc() As String, Subject As String, BodyHdr As String, Filename As Variant, ConfirmDlg As Integer, AppendRtitem As NotesRichtextItem, KillFile As Integer, ShowPBar As Integer, Note As NotesDocument) As Integer This function is used by Integra’s r
DetachFileDetachFile (Note As NotesDocument, Path As String, FileName As Variant, SaveWithName As Variant, All As Integer, ShowPBar As Integer) As Integer This function will detach one or more files from the passed on Notes document. Both, the Notes back-end document as well as the rich text item has to be d
EmbedFileEmbedFile (Action As String, 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 will embed or attach one or more files to a Notes document. Both
ExecuteTextErrorLineExecuteTextErrorLine (ErrorText As String, ProcStr As String) As String When Integra is executing Lotus Script at runtime that has been stored in the Callback Script field or the Error Handler field (Integra profile), any error event caused by this script will not allow to retrieve the line number
ExtractDiskExtractDisk (Filename As String) As String This function extracts the disk-name component from a given path-file-name. Parameters: Filename (Type) Name of the file including its path. Return Value: String.
ExtractFileNameExtractFileName (Filename As String) As String This function extracts the file-name component (with extention) from a given path-file-name. Parameters: Filename (String) Name of the file including its path. Return Value: String.
ExtractPathExtractPath (Filename As String) As String This function extracts the path-name component from a given path-file-name. Parameters: Filename (String) Name of the file including its path. Return Value: String.
FileInUseFileInUse (Filename As String) As Integer This function checks if a particular file located in the file system is in use. It first calls the function IsMsOfficeRunning(Filename) which in turn makes some API calls looking for any MS Word or Excel task that may have the specified file in use (see IsM
FormatSingleValueFormatSingleValue (AnyValue As Variant) As String This function is using the Lotus Script format() function with pre-defined format pictures for the different data types: INTEGER : “0000000000000000”
LONG : “00000000000000000000000000000000”
SINGLE : “0000000000000000.0000”
DOUBLE : “0000000
GetIntegraDataDirGetIntegraDataDir () As String This function returns the path to Integra’s temporary file directory. If the directory doesn’t exist it will create the subdirectory Integra4Notes.Temp in the Notes data directory. In older versions of Integra for Notes this function was called GetNotesDataDir(). Fo
GetRandomFileNameGetRandomFileName (FilePath As String, FilePreFix As String, FileExtention As String, forceRND As Integer) As String This function will return a random and unique path-file-name. Parameters: FilePath (String) Default path (directory) in which the file will be created. FilePreFix (String) Defines a
GetUserProfileGetUserProfile () As Notesdocument This function returns an object handle (NotesDocument) to the user’s personal profile created in the Integra database. The very first time a user is running an Integra import or export a personal user profile is created in the Integra database to store temporary
GetUserProfileVarGetUserProfileVar (VarName As String, Default As Variant) As Variant This function returns the value (previously stored) in a field VarName in the user’s personal profile. The following data types are allowed: INTEGER, LONG, SINGLE, DOUBLE, DATETIME, BOOLEAN, STRING. Tip: If you need to temporaril
MessageDialogMessageDialog (Message As String, Icon As Long, Title As String) As Integer This function is calling the standard Lotus Script messagebox() function. However, it will disable the progress bar for the time the message is displayed and enable it afterwards. The progress bar will not always allow a me
MultiValueFdToArrayMultiValueFdToArray (Item As Variant, Text() As String) As Integer This function converts a multi-value form field into an array of strings. Parameters: Item (Variant) Array of type variant containing the multi-values of the Notes document field received with NoteDocument.GetItemValue(). Text (Stri
NotesVersionNumberNotesVersionNumber () This function returns the Notes version as a numeric value Return Value: Variant. Integer or floating point.
OpenFileDialogOpenFileDialog (MultiSelect As Integer, Message As String, DefaultDir As String) As String This function displays the Windows File-Open dialog. It disables the progress bar before activating the dialog and enables it afterwards. Parameters: MultiSelect (Integer) True or False. If True, the File-Ope
RemoveCRRemoveCR (Text As String) As String This function removes any Chr(10) or Chr(13) elements from the passed on text string. Parameters: Text (String) Any text string. Return Value: String.
ReplaceStrReplaceStr (SearchStr As String, FindStr As String, ReplaceStr As String) As String This function searches the SearchStr for any occurrence of FindStr and replaces it with ReplaceStr. Parameters: SearchStr (String) The string that is being searched for the occurrence of FindStr. FindStr (String) Th
ResponseDocLevelResponseDocLevel (Note As NotesDocument) As Integer This function returns the response document level of a document. A return value of 0 (zero) indicates that the document is a (top level) parent document; any value larger than zero represents the response level to the top level parent document. Pa
SaveFileDialogSaveFileDialog (Message As String, DefaultDir As String) As String This function displays the Windows File-Save dialog. It disables the progress bar before activating the dialog and enables it afterwards. Parameters: Message (String) A prompt/title displayed in the File-Open dialog. DefaultDir (Str


     




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