Function AddNoteEx

Adds another self-adhesive note to a document. Please note that there is a maximum number of self-adhesive notes for a document, more are not displayed, but not marked as faulty when saved.

Please note, that this function does not result in an update of the view on the actually displayed document.

int AddNote (int ObjId, int NoteType, AnsiString NoteText)

int AddNoteEx (int ObjId, int NoteType, AnsiString NoteText, int PageNo, int x, int y)

Parameters:

ObjId: Number of the logical document NoteType: Type of self-adhesive note NoteText: Text body of the note

Page No: Page number 1..n for Tiff-documents with a faded-in post-it note; 0: only icon X: x-position in the Tiff-document

Y: y-position in the Tiff-document Return values:

-5: Invalid note type 1..3

-4: Target object is not a document -3: Target object could not be determined -2: Error when writing the self-adhesive note -1: No work area active

>0: Saving ok, return value is internal note number

Available from:

4.00.138

Function AddPostboxFile

This function transfers one file to the postbox. For this purpose, a new entry must be prepared first of all with PrepareObject, the short name and other values must be set via the various properties and the function must then be requested. The file is then copied and stored in the postbox together with the subject data.

After requesting this function, the new entry then automatically becomes the "active postbox entry", it then is the source for some further functions.

There is another special case for this function: when the "active postbox entry" is changed and is to be saved again in the postbox, this function is requested with an empty string as parameter. This opportunity is for example used by the barcode postprocessing.

int AddPostboxFile (AnsiString SourceFile) Parameters:

SourceFile file to be copied Return values:

-3: Error when saving.

-2: No active postbox entry available -1: Error when transferring to postbox

1: Ok

Example: open first postbox document, allocate mask number 2 to it and automatically enter the short name as well as first index field. Afterwards, the document is transferred to the archive on the path prescribed:

' Target tab for the document RegisterId = "¿Cabinet¿Folder¿Tab"

MaskNo = 2

Set Elo=CreateObject("ELO.professional") ' To be sure, first update the postbox Elo.UpdatePostbox

x=Elo.PrepareObjectEx(-1, 0, MaskNo) if x>0 or x=-5 or x=-7 then

Elo.ObjShort="Test" & Time

call Elo.SetObjAttrib(0,"Index 1") call Elo.AddPostboxFile("")

x=Elo.MoveToArchive(RegisterId) else

MsgBox "No document found in postbox"

end if

Also see: MoveToArchive LookupIndex UpdateDocument InsertAttachment

Function AddSignature

This function adds an extern signature file to an existing document. The script has the responsibility to guarantee, that the signature actually belongs to the document. In case of an error an invalid signature is displayed to the user.

int AddSignature (int ObjectId, AnsiString SignatureFile) Parameters:

ObjectId Logical ELO Document-Id

SignatureFile File with the information of the signature Return values:

-2: Error while saving the signature file -1: No workspace open

1: Ok

Example:

...

Result = Elo.MoveToArchive( DestPath ) If Result > 0 then

Id = Elo.GetEntryId(-2)

MsgBox Elo.AddSignature( Id, "d:\temp\00016882.ESG" ) End if

...

Available from:

4.00.180

Function AddSw

Adds a new entry into a keyword list. Each entry contains a unique two letter level information: AA, AB, AC ..

ZZ per level. The root level starts with a dot. „.AAABAC“ starts at the base with the first entry, within this with the second subentry, within this selects the third subentry.

The group parameter is connected to the group entry in the keywording form.

AnsiString AddSw( AnsiString Group, AnsiString Parent, AnsiString NewEntry)

Parameters:

Group Selects a keyword list Parent Path of the subtree NewEntry New keyword entry Return values:

-1: no work area active -2: error when writing

-3: invalid or unknown parent path others: Position of the new entry Example

...

Set Elo=CreateObject("ELO.professional") call Elo.DeleteSwl( "THM", "." )

MsgBox Elo.AddSw( "THM", ".", "1" ) MsgBox Elo.AddSw( "THM", ".AA", "1.1" ) MsgBox Elo.AddSw( "THM", ".AA", "1.2" ) MsgBox Elo.AddSw( "THM", ".AA", "1.3" ) MsgBox Elo.AddSw( "THM", ".", "2" ) MsgBox Elo.AddSw( "THM", ".", "3" ) MsgBox Elo.ReadSwl( "THM", ".", " - " ) MsgBox Elo.ReadSwl( "THM", ".AA", " - " ) call Elo.UpdateSw( "THM", ".AB", "2a" ) MsgBox Elo.ReadSwl( "THM", ".", " - " ) ...

Available from 5.00.066

Function AddThesaurus

This function creates a Thesaurus entry in the database. Every Thesaurus group has to own an explicit group number (GroupId), if you assign a 0 to the group at the first entry, ELO acquires a new random number. The Prio parameter defines the sort order, the ListId parameter has to be set permanently to 1 at the moment (Thesaurus in the subject data dialog).

int AddThesaurus (int ListId, int GroupId, int Prio, AnsiString Value)

Parameters:

ListId Region, set to 1 for the subject data GroupId Thesaurusgroup, 0: acquire a new group

Prio Sort order

Value Text

Return values:

-2: Error while saving the file -1: No workspace open

>0: Ok, GroupId Example:

Set Elo=CreateObject("ELO.professional") Group = Elo.AddThesaurus( 1, 0, 10, "Tool" ) MsgBox Group

if Group > 0 then

MsgBox Elo.AddThesaurus( 1, Group, 20, "Hammer" ) MsgBox Elo.AddThesaurus( 1, Group, 30, "Screwdriver" ) MsgBox Elo.AddThesaurus( 1, Group, 40, "Nippers" ) end if

Available from:

4.00.214

Function AnalyzeFile

This function sends the content of a postbox file to the OCR module and enters the detected sections into predefined mask fields. The name of the postbox file can be transferred with SourceFile. Alternatively, in this parameter a line number (#0, #1, #2 ...) can be transferred. The respective file from the postlist is then used as file name. After detection, the result is saved in the keyword file for the image file.

The OcrDescriptor parameter contains the list of the rectangles to be checked and the mask fields to be filled. A detailed description of this list can be found in the barcode documentation.

Compared to the barcode module, the rectangle must be defined as follows:

"R(left,top,right,bottom)"

int AnalyzeFile (AnsiString SourceFile, AnsiString OcrDescriptor, int MaskNo) Parameters:

SourceFile File to be checked or postlist line numbers (with #number).

OcrDescriptor Rectangle list, in barcode format.

MaskNo Document type of the keyword file to be created Return values:

-6: error while writing the detected data -5: error during OCR editing

-4: faulty rectangle list -3: no rectangle list available -2: OCR subsystem not loaded -1: no workspace open

1: ok

Also see: AddPostboxFile ReadBarcodes

Property ArchiveDepth (int)

With this property you can determine the number of hierarchy levels of the current archive. For this the level of the documents is included in the count, i.e. a classic ELO archive with the file structural elements Cabinet-Folder-Tab-Document has 4 hierarchy levels.

If the archive view is not active yet, the ArchiveDepth property has the value –1.

Also see:

Function ArcListLineId

With this function the ELO ObjectId of a line from the right archive list can be detected.

int ArcListLineId (int LineNo) Parameters:

LineNo Line to be selected Return values:

-2: Invalid line number -1: No work area active

>0: ObjectId Available from:

5.00.036 Example:

Set Elo = CreateObject( "ELO.professional" ) for i = 0 to 8

res = res & Elo.ArcListLineSelected( i ) & " - " & Elo.ArcListLineId( i ) & ", "

next

for i = 0 to 3

Elo.SelectArcListLine( i ) next

for i = 4 to 7

Elo.UnselectArcListLine( i ) next

Elo.SelectArcListLine( 8 ) MsgBox res

See also: UnselectArcListLine SelectArcListLine ArcListLineSelected

Function ArcListLineSelected

With this function you can check, if a line is selected in the right archive list.

int ArcListLineSelected (int LineNo) Parameters:

LineNo Line to be selected Return values:

-2: Invalid line number -1: No work area active 0: Line not selected 1: Line selected Available from:

5.00.036 Example:

Set Elo = CreateObject( "ELO.professional" ) for i = 0 to 8

res = res & Elo.ArcListLineSelected( i ) & " - "

next

for i = 0 to 3

Elo.SelectArcListLine( i ) next

for i = 4 to 7

Elo.UnselectArcListLine( i ) next

Elo.SelectArcListLine( 8 ) MsgBox res

See also: UnselectArcListLine SelectArcListLine

Function AssignWorkflowUser (int)

With the aid of this function workflow nodes which are addressed to a user group can be assigned to a single user. By that the function “accept workflow” of the client can be cloned.

int AssignWorkflowUser (int iLine, int iUserID, int iFlags)

Parameters:

iLine Line number of the entry inside the task list (0-indexed) -1 = use currently selected line

iUserID ID of the user, who shall receive and edit the node,

the currently logged-in ELO-user can be entered by the ActiveUserID property iFlags reserved

Return values:

-7 Error while assigning the new user

-6 Line contains no workflow entry with group node -5 Line contains no workflow entry

-4 Invalid line number (at iLine<>-1) -3 No line selected (at iLine=-1) -2 Task view not active

-1 No work area active Available from:

4.00.220

Property AttId (int)

The AttId property defines the working version of the file appendix of a document. This entry has to be extracted of the list of the existing attachments, a foreign entry can lead to serious disfunctions here.

Available from:

5.00.042 Example:

Set ELO = CreateObject( „ELO.professional“ ) MsgBox Elo.AttId

See also: MaskKey DocKey DocKind DocPath

Property AutoDlgResult (AnsiString)

Available from: Ver 3.00.228

This property transfers the result for all objects of the AutoDialog. The individual values are separated by a return.

Example:

Transfers the content of the Edit field.

Elo.CreateAutoDlg ("New dialog") Elo.AddAutoDlgControl (4,1,"Name","") Elo.ShowAutoDialog

MsgBox Elo.AutoDlgResult

Also see: CreateAutoDlg AddAutoDlgControl ShowAutoDlg GetAutoDlgValue

Function Backup (int, int, int)

The Backup and BackupPath functions aren’t supported by current clients anymore and are only listed in the OLE interface for compatibility reasons.

Since version 3.0 the Backup-functions are executed by the backup server and not by the client anymore.

Property BackupPath (AnsiString)

The Backup and BackupPath functions aren’t supported by current clients anymore and are only listed in the OLE interface for compatibility reasons.

Since version 3.0 the Backup-functions are executed by the backup server and not by the client anymore.

Function BringToFront

With the BringToFront function you can bring ELO into the foreground on the desktop and thus make it visible for the user if ELO has previously been hidden by other remotely controlled applications.

void BringToFront ()

Parameters:

none Return values:

none

Also see: EloWindow

Function ChangeObjAcl (int ObjId, AnsiString Acl, int Option)

Available from: 3.00.???

With this function, the access rights for the objects can be allocated and/or changed.

AnsiString ChangeObjAcl (int ObjId, AnsiString Acl, int Option) ObjId: Internal ELO ID

Acl : Rights to be allocated. Multiple rights are to be separated with a comma.

Format : XYZ

XY: RW – Write and read authorization RD – Read authorization

WT – Write authorization

KY – Key

Z :

User number / Group number/ Key number Option : 32 Bit integer mask 1 – Overwrite rights

01 0 – Forward non-subordinated objects

1 – Forward to subordinated objects (not implemented) 02 0 – Forward identical rights (not implemented)

1 – Only forward changes (not implemented) 03 0 – Warning dialog for own rights removal on

1 – Warning dialog for own rights removal off

04 0 –

1 – Accept predecessor rights (not implemented) x At present unused (reserved for extensions) Return value:

-1 - No work area active

-2 - insufficient rights to carry out changes

-3 - User abortion in case of own rights removal (dialog) Otherwise new object rights

Example:

Displays the current rights of object with ID 45.

Rights = Elo.ChangeObjAcl (45,"",0)

Sets the system key for object 30 and removes all others Elo.ChangeObjAcl (30,"KY0",1)

Also see:

Function CheckFile

With the CheckFile function you can request various file properties.

Int CheckFile (int OptionNo, AnsiString File name) Parameters:

OptionNo: 0: Check exclusive access to file File name: Name of file to be checked Return values:

-2: Exclusive access not possible -1: Invalid number under OptionNo

1: Ok

Available from:

3.00.288

Also see:

Function CheckFileHash

With the function CheckFileHash you can check a file, whether it is already filed in ELO. A dialog is submitted to the user in which the user can decide, if the document shall be filed anyway, a reference shall be entered instead or the storage is to be cancelled completely.

Int CheckFileHash (AnsiString HeaderMessage, AnsiString FileName, int ModeMask) Parameters:

HeaderMessage: Additional annotation in the dialog title (e.g. file name or description) FileName: Name and path of the file to be checked

ModeFlag: Reserved, has to be set to 128 Return values:

-2: Document available, no storage

-1: No work area active, no control possible 0: Document is not yet available in the archive 1: Document available, file anyway

>1: Document available, set reference to this DocId Example:

Set Elo=CreateObject("ELO.professional")

MsgBox Elo.CheckFileHash( "Testdatei", "d:\temp\Scandatei.tif", 128 )

Available from:

4.00.034