Using and customizing IMiS/Scan through COM object model

| Back | Main view | Parent doc

IMiS client COM object model

IMiSClient namespace:
Application
Profiles
Documents
UIControl

Profile

GeneralSettings

ScanSettings

ViewSettings

DocumentSettings

SendSettings

PrintSettings

AnnotationSettings

OCRSettings

RTFFormatSettings

HTMLFormatSettings

XLSFormatSettings

PDFFormatSettings

DBFFormatSettings

TXTFormatSettings

XMLFormatSettings

CVSFormatSettings

IMiSStorage

IMiSDocument

IMiSRecognizedDocument

IMiSDocumentEvents

IMiSRecognizedDocumentEvents

IMiSSession object deprecated

Description of Application object:

Main object for accessing IMiS client application. When this object is created IMiS client application is started in hidden mode.

ActiveProfile: Profile readonly : Returns current active profile
ActiveDocument: IMiSDocument readonly : Returns current active document object.
ErrorCode: Integer readonly : Returns last IMiS error code See error code explanation at the end of text.
ErrorMsg: string readonly ;
procedure AclDialog : Shows permission dialog. You can set specific user permissions on current document or annotations.
procedure Close(saveonclose: boolean): Close IMiS client application and save all opened documents if saveonclose is true.
Scanning: boolean readonly : Get a value indicating whether the IMiS client application is scanning.
Visible: boolean : Hide/Show all opened documents.
function OpenIMiSARCStorage(const Hostname: string; Port: Integer; const Profile: string): IMiSStorage :
It enables IMiS Imaging Client to operate on IMiS/ARChive HSM Storage Server. There are 3 distinct parameters which are relevant when accessing this Storage
System:
1. TCP IP/hostname of the IMiS/ARChive Storage Server
2. TCP Listening Port (initialized by default to DEFAULT_PORT). This parameter should not be modified unless modification
has been made on the Storage Server).
3. Profile name (profile to be used to store new objects)
To access objects on this Storage System in READ mode, at least IP/hostname must be set.
To store new objects at least IP/hostname and profile must be set.
Use StoreType and StoreInfo when defining IMiSDocument object
function OpenIMiSARCStorageEx(const Hostname: string; Port: Integer; const Profile: string; const Username;

var SecondaryNodes: PSafeArray; const Crypto: ICryptoContext): IMiSStorage :
Extended version of OpenIMiSARCStorage used for accessing IMiS/Arc server with crypto security enabled. Two new parameters:
1. SecondaryNodes: array of IMiS/Arc servers in cluster
2. Crypto: Interface for settings crypto contexts parameters

function OpenFileSystemStorage(const Directory: string): IMiSStorage :
It enables IMiS Imaging Client to operate on file system. To acces and strore documents on file system directory must be set.
function OpenODMAStorage(const StorageName: string): IMiSStorage;
function UIControl(Control: Control): IUIControl : Get control over user interface component. (icon, combobox,..). See Control enumerator.
Documents: Documents readonly : Returns a collection of all opened documents.
Profiles: Profiles readonly : Returns a collection of all profiles in IMiS client.
VersionInfo: string readonly : Returns text with version information of all IMiS modules.
function WaitForExit(TimeOut: Integer): Integer :Wait for IMiS/Client user interface to be closed or to be timed out. timeOut - - number of milliseconds to wait. Set -1 to wait indefinitely or until IMiS client application is closed. Set 0 to check if IMiS client application is closed.

Description of CryptoContext object:

KeyType: Integer;
KeyStrength: Integer;
AlgorithmId: Integer;
ModeId: Integer;
BlockSize: Integer;
KeyLength: Integer;
Key: string;

Description of UIControl object:

Enabled: boolean;
Visible: boolean;

Control enumerators:

FILE_NEW = $00000000;
FILE_OPEN = $00000001;
FILE_SAVE = $00000002;
FILE_SAVEANDCLOSE = $00000003;
FILE_CLOSE = $00000004;
FILE_SEND = $00000005;
FILE_PRINT = $00000006;
FILE_EXIT = $00000007;
EDIT_CUT = $00000008;
EDIT_COPY = $00000009;
EDIT_PASTE = $0000000A;
EDIT_DELETE = $0000000B;
EDIT_SELECTALL = $0000000C;
EDIT_CROP = $0000000D;
EDIT_OCR = $0000000E;
EDIT_EDITMODE = $0000000F;
SCAN_PAGE = $00000010;
SCAN_BATCH = $00000011;
SCAN_SETTINGS = $00000012;
SCAN_SELECT = $00000013;
SCAN_IPSETTINGS = $00000014;
PAGE_PREVIOUS = $00000015;
PAGE_NEXT = $00000016;
PAGE_GOTO = $00000017;
PAGE_INSERT = $00000018;
PAGE_OVERWRITE = $00000019;
PAGE_INFO = $0000001A;
VIEW_INVERT = $0000001B;
VIEW_ROTATELEFT = $0000001C;
VIEW_ROTATERIGHT = $0000001D;
VIEW_ROTATE000 = $0000001E;
VIEW_ROTATE090 = $0000001F;
VIEW_ROTATE180 = $00000020;
VIEW_ROTATE270 = $00000021;
VIEW_MIRROR = $00000022;
VIEW_ZOOMIN = $00000023;
VIEW_ZOOMOUT = $00000024;
VIEW_ACTUALSIZE = $00000025;
VIEW_WHOLEPAGE = $00000026;
VIEW_PAGEHEIGHT = $00000027;
VIEW_PAGEWIDTH = $00000028;
VIEW_SHOWGRAYS = $00000029;
VIEW_APPLYTOALL = $0000002A;
ANNOT_STICKY = $0000002B;
ANNOT_SELECT = $0000002C;
ANNOT_TEXT = $0000002D;
ANNOT_HILITE = $0000002E;
ANNOT_REDACTION = $0000002F;
ANNOT_POPUP = $00000030;
ANNOT_ARROW = $00000031;
ANNOT_FREEHAND = $00000032;
ANNOT_ELLIPSE = $00000033;
ANNOT_BOX = $00000034;
ANNOT_POLYLINE = $00000035;
ANNOT_IMAGE = $00000036;
ANNOT_STAMP = $00000037;
ANNOT_CUSTOM = $00000038;
ANNOT_PROPERTIES = $00000039;
ANNOT_MERGE = $0000003A;
TOOLS_PAN = $0000003B;
TOOLS_ZOOM = $0000003C;
TOOLS_REGION = $0000003D;
TOOLS_ANNOT = $0000003E;
TOOLS_OCR = $0000003F;
TOOLS_THUMBNAILS = $00000040;
THUMB_TINY = $00000042;
THUMB_SMALL = $00000044;
THUMB_MEDIUM = $00000045;
THUMB_LARGE = $00000046;
TOOLS_PREFERENCES = $00000047;
TOOLS_PANWINDOW = $00000048;
WINDOW_CASCADE = $00000049;
WINDOW_TITLEHORIZOTAL = $0000004A;
WINDOW_TITLEVERTICAL = $0000004B;
WINDOW_CLOSEALL = $0000004C;
HELP_HOMEPAGE = $0000004D;
HELP_MANUAL = $0000004E;
HELP_ABOUT = $0000004F;

Description of Documents object:

Count: Integer readonly : Number of currently opened documents.
First: IMiSDocument readonly;
Last: IMiSDocument readonly;
Next: IMiSDocument readonly;
function Get(const DocumentID: string): IMiSDocument : Retrieve opened document by its ID.

Description of Profiles object:

property Count: Integer;
property First: Profile;
property Last: Profile readonly;
property Next: Profile readonly;
function New(const Name: string): Profile : Create new profile with given name.
function GetProfile(const Name: string): Profile : Obtain profile by its name.

Description of Profile object:

Name: string readonly : Name of profile
Scope: Scope : Returns type of profile.
Modified: boolean readonly : True if profile has been modified.
Saved: boolean readonly : True if profile has been saved.
procedure Save : Save settings for current profile.
procedure Delete; not implemented yet
OCRSettings: OCRSettings readonly ;
ScanSettings: ScanSettings readonly ;
DocumentSettings: DocumentSettings readonly
AnnotationSettings: AnnotationSettings readonly
GeneralSettings: GeneralSettings readonly
ViewSettings: ViewSettings readonly
ScannerSettings: ScannerSettings readonly ;
SendSettings: SendSettings readonly
PrintSettings: PrintSettings readonly

Scope enumerators:

SCOPE_LOCAL = $00000000;
SCOPE_GLOBAL = $00000001;
SCOPE_TEMP = $00000002;

Description of GeneralSettings object:

AutoRun: boolean ;
AssociateTIFF: boolean ;
CloseOnEscape: boolean ;
SaveWindowPosition: boolean ;
HideMenu: boolean ;
ShowInTaskbar: boolean ;
CloseOnCOM: boolean ;
LogChanges: boolean ;
LogFilename: string ;
LogFileOnEveryday: boolean

Description of ScannerSettings object:

Name: string readonly ;
DriverName: string ;
DriverVersion: string readonly ;
PaperSize: string ;
ScannerLoaded: boolean ;
Resolution: Integer ;
Brightness: Integer ;
Contrast: Integer ;
Duplex: boolean ;
AllowTurnover: boolean
PaperSource: Integer
ScannerState: string
Mode: Integer

Description of ScanSettings object:

AutoScan: boolean ;
EnableSaveAndCloseButton: boolean ;
ShowStatusDlg: boolean ;
InsertMode: Integer ;
IPFilterState: string ;
procedure RemoveScanner;

Description of ViewSettings object:

ApplayToAll: boolean ;
ScaleToGray: boolean ;
ShowThumbnails: boolean ;
EvenThumbnails: boolean ;
ThumbnailSize: Integer ;
KeepViewPosition: boolean ;
KeepRegion: boolean ;
DefaultPageScale: Integer ;

Description of DocumentSettings object:

FileType: IMiSFileType ;
function SetCompression(ColorFormat: Integer; const CompressionType: string): boolean;
function GetCompression(ColorFormat: Integer): string;

IMiSFileType enumerators:

FILETYPE_TIFF = $00000000;
FILETYPE_PDF = $00000001;

Description of SendSettings object:

HidePreferenceOnSend: boolean ;
procedure ConfigureMergeAnnotations; ;

Description of PrintSettings object:

PrintScale: Integer ;

Description of AnnotationSettings object:

Format: AnnotationFormat ;
ToolsVisible: boolean ;
EnableStickyTool: boolean ;
EnableAnnotaionMouseMove: boolean ;
DefaultTextFont: Integer ;
DefaultHiliteColor: Integer ;
DefaultLineThickness: Integer ;
DefaultRedactionColor: Integer ;
StampLocation: string ;

AnnotationFormat enumerators:

FILETYPE_TIFF = $00000000;
FILETYPE_PDF = $00000001;

Description of OCRSettings object:

Languge: string : Language in which image will be recognized. Can be combined with more predefined languages.
OutputFormat: OCRFileFormat : Output file type.
OutputFilename: string ;
OutputDisposition: OCROutputDisposition : Result of OCR can be saved in file of clipboard.
Layout: OCRLayoutType ;
ErrorLevel: OCRErrorMarkingLevel ;
TextType: OCRTextType ;
ShowOutput: boolean : After OCR, result will be shown in a corresponding application.
DetectInverted: boolean
DetectOrientaion: boolean
DespeckleImage: boolean
TableOneLinePerCell: boolean
TableNoMergedCells: boolean
DetectBarcodes: boolean
FormatSettings: IUnknown readonly: Depend on OutputFormat. This property will contain one of this objects (RTFFormatSettings, HTMLFormatSettings, XLSFormatSettings, PDFFormatSettings, DBFFormatSettings, TXTFormatSettings, XMLFormatSettings, CVSFormatSettings)
OCRPageRange: string : Only pages in range can be OCRed.
BarcodeType: OCRBarcodeType ;
BarcodeOrientation: OCRBarcodeOrientation ;
TableBlackLinesSeparators: boolean

OCRFileFormat enumerators:

FILEFORMAT_RTF = $00000000;
FILEFORMAT_PDF = $00000001;
FILEFORMAT_HTML = $00000002;
FILEFORMAT_TEXT = $00000003;
FILEFORMAT_DBF = $00000004;
FILEFORMAT_XLS = $00000005;
FILEFORMAT_XML = $00000006;

OCRLayoutType enumerators:

LAYOUTTYPE_AUTODETECT = $00000000;
LAYOUTTYPE_SINGLE_COLUMN = $00000001;
LAYOUTTYPE_PLAIN_TEXT = $00000002;
LAYOUTTYPE_SPACEFORMATTED = $00000003;

OCROutputDisposition enumerators:

TOFILE = $00000000;
TOCLIPBOARD = $00000001;

OCRTextType enumerators:

TEXTTYPE_NORMAL = $00000000;
TEXTTYPE_TYPEWRITER = $00000001;
TEXTTYPE_MATRIX = $00000002;
TEXTTYPE_INDEX = $00000003;
TEXTTYPE_HANDPRINTED = $00000004;
TEXTTYPE_OCR_A = $00000005;
TEXTTYPE_OCR_B = $00000006;
TEXTTYPE_MICR_E13B = $00000007;
TEXTTYPE_MICR_CMC7 = $00000008;
TEXTTYPE_TOBEDETECTED = $00000009;

OCRErrorMarkingLevel enumerators:

ERRORMARKINGLEVEL_NONE = $00000000;
ERRORMARKINGLEVEL_SCANTY = $00000001;
ERRORMARKINGLEVEL_STANDARD = $00000002;
ERRORMARKINGLEVEL_THOROUGH = $00000003;
ERRORMARKINGLEVEL_ALLTEXT = $00000004;

OCRFileFormat enumerators:

FILEFORMAT_RTF = $00000000;
FILEFORMAT_PDF = $00000001;
FILEFORMAT_HTML = $00000002;
FILEFORMAT_TEXT = $00000003;
FILEFORMAT_DBF = $00000004;
FILEFORMAT_XLS = $00000005;
FILEFORMAT_XML = $00000006;

OCRLayoutType enumerators:

LAYOUTTYPE_AUTODETECT = $00000000;
LAYOUTTYPE_SINGLE_COLUMN = $00000001;
LAYOUTTYPE_PLAIN_TEXT = $00000002;
LAYOUTTYPE_SPACEFORMATTED = $00000003;

OCROutputDisposition enumerators:

TOFILE = $00000000;
TOCLIPBOARD = $00000001;

OCRTextType enumerators:

TEXTTYPE_NORMAL = $00000000;
TEXTTYPE_TYPEWRITER = $00000001;
TEXTTYPE_MATRIX = $00000002;
TEXTTYPE_INDEX = $00000003;
TEXTTYPE_HANDPRINTED = $00000004;
TEXTTYPE_OCR_A = $00000005;
TEXTTYPE_OCR_B = $00000006;
TEXTTYPE_MICR_E13B = $00000007;
TEXTTYPE_MICR_CMC7 = $00000008;
TEXTTYPE_TOBEDETECTED = $00000009;

OCRPageSynthesis enumerators:

PAGESYNTHESIS_PLAINTEXT = $00000000;
PAGESYNTHESIS_PARAGRAPHSANDFONTS = $00000001;
PAGESYNTHESIS_PAGELAYOUT = $00000002;

OCRErrorMarkingLevel enumerators:

ERRORMARKINGLEVEL_NONE = $00000000;
ERRORMARKINGLEVEL_SCANTY = $00000001;
ERRORMARKINGLEVEL_STANDARD = $00000002;
ERRORMARKINGLEVEL_THOROUGH = $00000003;
ERRORMARKINGLEVEL_ALLTEXT = $00000004;

OCRBarcodeType enumerators:

BARCODETYPE_UNKNOWN = $00000000;
BARCODETYPE_CODE39 = $00000001;
BARCODETYPE_CHECK_CODE39 = $00000002;
BARCODETYPE_INTERLEAVED25 = $00000003;
BARCODETYPE_CHECK_INTERLEAVED25 = $00000004;
BARCODETYPE_EAN13 = $00000005;
BARCODETYPE_CODE128 = $00000006;
BARCODETYPE_EAN8 = $00000007;
BARCODETYPE_PDF417 = $00000008;
BARCODETYPE_AUTODETECT = $00000009;

OCRBarcodeOrientation enumerators:

BARCODEORIENTATION_AUTODETECT = $00000000;
BARCODEORIENTATION_VERTICAL = $00000001;
BARCODEORIENTATION_HORIZONTAL = $00000002;

OCRBarcodeType enumerators:

BARCODETYPE_UNKNOWN = $00000000;
BARCODETYPE_CODE39 = $00000001;
BARCODETYPE_CHECK_CODE39 = $00000002;
BARCODETYPE_INTERLEAVED25 = $00000003;
BARCODETYPE_CHECK_INTERLEAVED25 = $00000004;
BARCODETYPE_EAN13 = $00000005;
BARCODETYPE_CODE128 = $00000006;
BARCODETYPE_EAN8 = $00000007;
BARCODETYPE_PDF417 = $00000008;
BARCODETYPE_AUTODETECT = $00000009;

OCRBarcodeOrientation enumerators:

BARCODEORIENTATION_AUTODETECT = $00000000;
BARCODEORIENTATION_VERTICAL = $00000001;
BARCODEORIENTATION_HORIZONTAL = $00000002;

Description of RTFFormatSettings object:

HighlightText: boolean ;
ErrorTextColor: Integer ;
HighlightBackground: boolean ;
ErrorBackgroundColor: Integer ;
KeepColor: boolean ;
KeepLineBreaks: boolean ;
KeepPageBreaks: boolean ;
KeepPictures: boolean ;
PictureResolution: Integer ;
RemoveHyphens: boolean 0;
PageSynthesis: OCRPageSynthesis

OCRPageSynthesis

enumerators:

PAGESYNTHESIS_PLAINTEXT = $00000000;
PAGESYNTHESIS_PARAGRAPHSANDFONTS = $00000001;
PAGESYNTHESIS_PAGELAYOUT = $00000002;

Description of HTMLFormatSettings object:

CodePage: Integer ;
CodePageType: Integer ;
FormatMode: Integer ;
KeepColor: boolean ;
KeepLineBreaks: boolean ;
LineAsPageBreak: boolean ;
KeepPictures: boolean ;
PictureQuality: Integer ;
PictureResolution: Integer ;
PictureScale: Integer
UseUnicode: boolean
PageSynthesis: OCRPageSynthesis

OCRPageSynthesis

enumerators:

PAGESYNTHESIS_PLAINTEXT = $00000000;
PAGESYNTHESIS_PARAGRAPHSANDFONTS = $00000001;
PAGESYNTHESIS_PAGELAYOUT = $00000002

Description of XLSFormatSettings object:

IgnoreOutTables: boolean ;
ConvertToNumber: boolean ;
KeepFormatting: boolean ;

Description of PDFFormatSettings object:

SaveMode: Integer ;
KeepColor: boolean ;
UncertainWordsAsImage: boolean ;
PictureQuality: Integer ;
PictureResolution: Integer ;

Description of PDFFormatSettings object:

CodePage: Integer ;
CodePageType: Integer ;
Append: boolean ;

Description of PDFFormatSettings object:

CodePage: Integer ;
CodePageType: Integer ;
Encoding: Integer ;
KeepLineBreaks: Integer ;
LineAsParagraphSeparator: boolean ;
BreakAsPageSeparator: boolean ;
Append: boolean ;
AppendEOF: boolean

Description of XMLFormatSettings object:

WriteCharAttributes: boolean ;
WriteExtCharAttributes: boolean ;
WriteCharFormatting: boolean ;
WriteNondeskewedCoord: boolean ;

Description of CVSFormatSettings object:

CodePage: Integer ;
CodePageType: Integer ;
Encoding: Integer ;
KeepLineBreaks: Integer ;
LineAsParagraphSeparator: boolean ;
BreakAsPageSeparator: boolean ;
Append: boolean ;
AppendEOF: boolean

Description of IMiSStorage object:

IMiSStorage is an object which defines methods and fields describing a Storage System object with which IMiS Imaging
Client can operate on. The properties on IMiSStorage objects are StoreType and StoreInfo which are used to operate on IMiSDocument object.

Store Type defines an storage system ID. Currently IMiS Imaging Client uses following known Storage Types:
STORETYPE_FILESYSTEM = Local/Remote File System Storage
STORETYPE_IMISARC = IMiS/ARChive Storage Server
STORETYPE_LNDIMSS = Lotus Notes Document Imaging Mass Storage Server (LN:DI MSS)
STORETYPE_DDOC = IBM Domino Document Manager
STORETYPE_ODMA = ODMA compliant Storage Server
STORETYPE_CM = IBM DB2 Content Manager Server

StoreType: IMiSStoreType readonly : Returns the object's store type parameter.
Document: IMiSDocument readonly : Retrieve document from storage or create new one.
StoreInfo: string readonly : Returns the object's store information.
function OpenDocument(const DocumentID: string): IMiSDocument : Open exsisting document from storage.
function CreateDocument: IMiSDocument : Create new document on storage.

IMiSStoreType

enumerators:

FILESYSTEM = $00000001;
IMISARC = $00000002;
LNDIMSS = $00000004;
ODMA = $00000008;
DDOC = $00000016;
CM = $00000032;

Description of IMiSDocument object:

IMiSDocument is main object for scanning, viewing, storing and retrieving documents.

It can only be instantiated thru

IMiSStorage object. After instantiation, set different properties and call methods to manipulate the underlying object which is stored on an IMiSStorage object.

StoreType: IMiSStoreType : Deprecated. This property is set explicitly by Application OpenXXXStorage and should not be modified. Returns type of storage system of current document.
StoreInfo: string : Deprecated. Store Type is set explicitly by Application OpenXXXStorage methods and should not be modified. Returns IMiSStorage specification string.
Id: string : Returns the Object ID of document saved on storage system.
Mime: string : Returns the MIME type for previous store/retrieve file on/for storage system
LocalFile: string : Returns file path of the local file. Every opened document has his copy saved on local file system.
FileExt: string : Returns file extension when using CopyToStorage or CopyFromStorage method.
Rights: Integer : Returns Rights bits of the current document.
Description: string : Returns the current window title.
function View: Integer : Show document in IMiS/Scan (IMiS/View)
function Scan(Modal: boolean): Integer : This method is used to acquire a new image with IMiS/Scan or IMiS/View Imaging Client.
function CopyFromStorage: Integer : Retrieves a document/file from storage system to a local file system.
function CopyToStorage: Integer : Stores a new document/file to IMiSStorage object.
function MergeAnnotations: Integer: Merge annotations on document.
function AclDialog(const Caption: string): Integer : Shows permission dialog. You can set specific user permissions on current document or annotations.
function Delete: Integer : Deletes a document from IMiSStorage.
IsNew: boolean readonly: Returns true when creating new document.
ErrorCode: Integer readonly : Returns the last IMiS/Scan or IMiS/View Imaging Client error code.
ErrorMessage: string readonly :
Preference[PrefID: IMiSPref]: Integer: Deprecated: Use settings thru Profile object. Obtain current status of desire preference.
IDType: IMiSDocumentIDType : Returns type of object ID for current document.
Overwrite: boolean : Set when overwriting existing document.
ClusterNodes: PSafeArray(string): Set secondary IMiS/Arc server nodes as array of strings.
ClusterNodesByString: string: Set secondary IMiS/Arc server nodes as strings delimited by #0 and terminated with #0#0.
function Recognize: IMiSRecognizedDocument : Start OCR on document.
PageCount: Integer readonly: Number of pages in document.
function SaveAs(const Location: IIMiSDocument): Integer: Copy existing document into new location. Location COM object must be created prior to execution.
function Save(Modal: WordBool): Integer: Save document to IMiSStorage. Reserve for future use.
Saved: WordBool: True if document is already saved.
function Print(const PageRange: string; ShowDialog: WordBool): Integer : Print whole document if PageRange is empty.
procedure SetActionMessage(const Message: string; const MsgParams: string); : Set message for audit log.
function SendByEmail(const Subject: string; const Recipients: string): Integer; : Send document by email.

IMiSStoreType

enumerators:

FILESYSTEM = $00000001;
IMISARC = $00000002;
LNDIMSS = $00000004;
ODMA = $00000008;
DDOC = $00000016;
CM = $00000032;

IMiSDocumentIDType enumerators:

LONG_BASE16 = $00000000;
LONG_BASE64 = $00000020;
LONG_BASE85 = $00000040;
SHORT_BASE16 = $00000080;
SHORT_BASE64 = $000000A0;
SHORT_BASE85 = $000000C0;
EXTERNAL = $80000000;

IMiSRights

enumerators:

RIGHTS_ALL = $03FF3FFF;
RIGHTS_ANNALL = $03FF0000;
RIGHTS_ANNHIDEDIT = $02000000;
RIGHTS_ANNHIDHIDE = $01000000;
RIGHTS_ANNHLTEDIT = $00080000;
RIGHTS_ANNHLTVIEW = $00040000;
RIGHTS_ANNIMGEDIT = $00800000;
RIGHTS_ANNIMGVIEW = $00400000;
RIGHTS_ANNPOPEDIT = $00200000;
RIGHTS_ANNPOPVIEW = $00100000;
RIGHTS_ANNTXTEDIT = $00020000;
RIGHTS_ANNTXTVIEW = $00010000;
RIGHTS_IMGALL = $00000F00;
RIGHTS_IMGPGADD = $00000400;
RIGHTS_IMGPGCOPY = $00000100;
RIGHTS_IMGPGDEL = $00000200;
RIGHTS_IMGPGMOVE = $00000800;
RIGHTS_OBJALL = $000030FF;
RIGHTS_OBJATT = $00000040;
RIGHTS_OBJCOPY = $00000008;
RIGHTS_OBJDEL = $00000004;
RIGHTS_OBJEDIT = $00000001;
RIGHTS_OBJEXPORT = $00002000;
RIGHTS_OBJIMPORT = $00001000;
RIGHTS_OBJOCR = $00000080;
RIGHTS_OBJPASTE = $00000010;
RIGHTS_OBJPRINT = $00000002;
RIGHTS_OBJSEND = $00000020;

IMiSPref enumerators:

SCAN_AUTO = $00000000;
SCAN_SAVE_BTN = $00000001;
GEN_DEFAULT_SCALE = $00000002;
ACTIVE_PAGE = $00000003;
SCAN_SHOW_DLG_FB = $00000004;
TIFF_COMP1 = $00000005;
TIFF_COMP4 = $00000006;
TIFF_COMP8 = $00000007;
TIFF_COMP24 = $00000008;
SCAN_PACKAGING = $00000009;
ESC_CLOSE = $0000000A;
DO_LOG = $0000000B;
DATE_LOG = $0000000C;
PRINT_SCALE = $0000000D;
ODMA_CO = $0000000E;
ANN_STICKY = $0000000F;
ANN_FORMAT = $00000010;
ANN_TOOLBAR = $00000011;
THUMBS_VIEW = $00000012;
HIDE_MENU = $00000013;
SAVE_WND_POS = $00000014;
VIEW_APPLYALL = $00000015;
VIEW_SCALE2GRAY = $00000016;
THUMBS_SIZE = $00000017;
THUMBS_EVEN = $00000018;
SEND_HIDE_DLG_M = $00000019;
SEND_MERGE_FLAG = $0000001A;
SHOW_IN_TASKBAR = $0000001B;
KEEP_REG = $0000001C;
KEEP_VIEW = $0000001D;
ANN_CUST_MOUSE = $0000001E;
IMISDOC_CLOSE = $0000001F;
INSERT_MODE = $00000020;
PDF_COMP1 = $00000021;
PDF_COMP4 = $00000022;
PDF_COMP8 = $00000023;
PDF_COMP24 = $00000024;

Description of IMiSRecognizedDocument object:

ItemSchema: string ;
function Result(Kind: Integer): string; not implemented yet.
Filename: string readonly : File path of OCRed document.
Statistic: OCRStatistic readonly ;

OCRStatistic record

TotalCharCount: Integer;
SuspiciousCharCount: Integer;

Description of IMiSDocumentEvents:

BeforeCreatePage(AfterPage: Integer; var Continue: WordBool);
AfterCreatePage(Index: Integer);
BeforeMovePages(Range: PSafeArray; AfterPage: Integer; var Continue: WordBool);
AfterMovePages(Range: PSafeArray; Index: Integer);
BeforeDeletePages(Range: PSafeArray; var Continue: WordBool);
AfterDeletePages(Range: PSafeArray);
BeforeModeChange(PreviousMode: Integer; NewMode: Integer; var Continue: WordBool);
AfterModeChange(Mode: Integer);
BeforeMailPages(Range: PSafeArray; var Continue: WordBool);
AfterMailPages(Range: PSafeArray);
BeforePrintPages(Range: PSafeArray; var Continue: WordBool);
AfterPrintPages(Range: PSafeArray);
BeforeCopyToClipboard(Range: PSafeArray; var Continue: WordBool);
AfterCopyToClipboard(Range: PSafeArray);
BeforeCreateAnnotation(Kind: Integer; Page: Integer; var Continue: WordBool);
AfterCreateAnnotation(Kind: Integer; Page: Integer);
BeforeMoveAnnotations(Kinds: PSafeArray; Page: Integer; var Continue: WordBool);
AfterMoveAnnotations(Kinds: PSafeArray; Page: Integer);
BeforeDeleteAnnotations(Kinds: PSafeArray; Page: Integer; var Continue: WordBool);
AfterDeleteAnnotations(Kinds: PSafeArray; Page: Integer);
BeforeMergeAnnotations(Kinds: PSafeArray; Page: Integer; var Continue: WordBool);
AfterMergeAnnotations(Kinds: PSafeArray; Page: Integer);
BeforeSave(var Continue: WordBool);
AfterSave;
BeforeCloseWindow(var Continue: WordBool);
BeforeOCR(Range: PSafeArray; var Continue: WordBool);
AfterOCR(Range: PSafeArray);
AfterCloseWindow;
BeforeOpenWindow(var Continue: WordBool);
AfterOpenWindow;
BeforePageRotation(Range: PSafeArray; CurrentStates: PSafeArray;
NewStates: PSafeArray; var Continue: WordBool);
AfterPageRotation(Range: PSafeArray; OldStates: PSafeArray; NewStates: PSafeArray);
BeforePageMirror(Range: PSafeArray; CurrentStates: PSafeArray; NewStates: PSafeArray;
var Continue: WordBool);
AfterPageMirror(Range: PSafeArray; OldStates: PSafeArray; NewStates: PSafeArray);
BeforeCropPage(Page: Integer; var Continue: WordBool);
AfterCropPage(Page: Integer);

IMiSPageRotation

enumerators:

PORTRAIT = $00000001;
LANDSCAPE = $00000002;
DEGREES180 = $00000003;
DEGREES270 = $00000004;

IMiSPageMirror

enumerators:

MIRRORED = $00000001;
NOTMIRRORED = $00000000;

IMiSAnnotType

enumerators:

PAI_TYPE_NONE = $00000005;
PAI_TYPE_TEXT = $00000002;
PAI_TYPE_FREEHAND = $00000003;
PAI_TYPE_HILITE = $00000004;
PAI_TYPE_POPUP = $00000006;
PAI_TYPE_REDACT = $00000007;
PAI_TYPE_ARROW = $0000000A;
PAI_TYPE_BOX = $0000000B;
PAI_TYPE_IMAGE = $0000000C;
PAI_TYPE_ELLIPSE = $0000000D;
PAI_TYPE_POLYLINE = $0000000E;

Description of IMiSRecognizedDocumentEvents:

ItemValueSet(const ItemName: string; Value: OleVariant; var IsValueSet: WordBool; var Continue: WordBool);
ItemValueReset(const Name: string; var Continue: WordBool);
ItemValueResetAll(var Continue: WordBool);
BeforeClose(var Continue: WordBool);
AfterRecognize;
BeforeRecognize(var Continue: WordBool);

Description of IMiSErrorCodes:

Returns the IMiS Imaging Client COM Error Code. Each Code represents a different error state. The following table should be used to further determine the cause of the error:

Code	Error	Description
-1	Unknown error	Unexpected error / Error for which cause is not determined. See "imis.log" file for more info.
-2	Invalid parameter for storage	One of the parameters for accessing storage is not valid. Probably incorrect values for input parameters. (usually points to programming error)
-3	Unsupported	Document image format is unsupported by PixTools. / COM: User wants to use unsupported method in IMiSClient. (Trying to scanning with IMiS/View)
1	User cancel	The user has gracefully canceled the operation (e.g.: Did not save the object in IMiS/Scan Imaging Client when called with scan() method).
2	Inconsistent	Document is partly saved. During work document was saved, changed and not saved on close.
3	Time-out	WaitForExit method in Application COM object has time-outed.
10	Storage engine init	Storage subsystem initialization error. Common causes of this error are: a) ODMA subsystem is requested but not available. b) IMiS/ARChive Client Library is required but not available. (iarcli.dll/libiarcli.so)
11	Object not found	Requested object does not exists or is unavailable. Common causes for this error are: a) Object has been deleted. b) Storage Server Volume where this object resides is unmounted. c) User requested an object with invalid ID.
12	Out of memory	The system has run out of memory for the requested operation.
13	Read error	System has reported a read error on the requested object. This object will not be available to the user.
14	Write error	System has reported a write error for the object which is being saved. This object should be considered UNSAVED! Common causes for this error are: a) Storage System has run Out Of Space an all mounted volumes. b) Storage System was unable to complete the save operation due to a system error.
15	Invalid access	The user has insufficient right to complete the requested operation on this object. Common causes for this error are: a) When using IMiSODMAStorage object: The user has insufficient rights to read/write/create/modify an object. b) When using IMiSFileSystemStorage object: The user has insufficient rights on the set storage space.
17	Log message write error	Error while writing message to action log.
18	Log entry write error	Error while writing entry to action log.
19	Log query error	Error while sending log query to action log.
-201	Invalid storage	This error is a special case of "Invalid parameter". Common causes for this error are: a) When using IMiSARCStorage object: Invalid Profile or Object MIME type used. Storage System reported that the requested Profile for storage and/or objects MIME type are unregistered.
-101	Invalid TIFF page	Requested page from tiff image does not exist.
61523	Network problem	No connection to storage provider or storage provider is not running.

| Back | Main view | Parent doc