Interface for EnumDefinitions wrapper. More...

Enumerations
enum	SeekPosition { SeekPositionBegin = 0 , SeekPositionCurrent = 1 , SeekPositionEnd = 2 }
	Position to which offset is added when performing a Seek operation on a IByteStream. More...

enum	FileStreamMode { FileStreamModeRead = 0 , FileStreamModeWrite = 1 , FileStreamModeAppend = 2 , FileStreamModeReadWrite = 3 }
	Filestream open modes. More...

enum	SeverityLevel { SeverityLevelInfo = 0 , SeverityLevelWarning = 1 , SeverityLevelError = 2 }
	The SeverityLevel defines the severity level of the events that are logged and can be received by an integrator, via registration of an implementation of the ILogger interface either on a CIDRS instance (for instance-based operations) or CIDRSSetup (for static operations). More...

enum	SerializationFormat { SerializationVersion10 = 10 , SerializationVersion11 = 11 , SerializationVersion12 = 12 , SerializationVersion13 = 13 , SerializationVersion14 = 14 , SerializationVersion15 = 15 , SerializationVersion16 = 16 , SerializationVersion17 = 17 , SerializationVersion18 = 18 , SerializationVersion19 = 19 , SerializationVersion20 = 20 , SerializationVersionLatest = 20 }
	Definition of the available versions of serialization. More...

enum	GraphicShapeType { GraphicShapeTypeLine = 0 }
	GraphicShapeType contains the types of graphic shapes handled by iDRS. More...

enum	BookmarkDisplayMode { BookmarkDisplayModePage = 0 , BookmarkDisplayModePageWidth = 1 , BookmarkDisplayModePageHeight = 2 , BookmarkDisplayModeContent = 3 , BookmarkDisplayModeContentWidth = 4 , BookmarkDisplayModeContentHeight = 5 , BookmarkDisplayModeRectangle = 6 , BookmarkDisplayModeZoom = 7 }
	Enumeration allowing to specify a bookmark's display mode. More...

enum	PdfCustomMetadataResourceType { PdfCustomMetadataResourceTypeContainer = 0 , PdfCustomMetadataResourceTypePropertyList = 1 }
	Flags for describing a Pdf Metadata Resource type. More...

enum	ZoneType { ZoneTypeText = 0 , ZoneTypeGraphic = 1 , ZoneTypeTable = 2 }
	The ZoneType data type defines the type of a zone. More...

enum	PageZoneGraphicSource { PageZoneGraphicSourceBaseImage = 0 , PageZoneGraphicSourceExternal = 1 , PageZoneGraphicSourceExternalWithMask = 2 }
	Source for graphical zones. More...

enum	TextType { TextTypePrinted = 0 , TextTypeBlockLettersHandwriting = 1 , TextTypeCursiveHandwriting = 2 }
	The TextType data type defines the type text type. More...

enum	TextDirection { TextDirectionAny = 0 , TextDirectionLeftToRight = 1 , TextDirectionTopToBottom = 2 , TextDirectionRightToLeft = 3 }
	The TextDirection data type defines the text direction of the concerned element it is applied to. More...

enum	FontFamilyType { FontFamilyTypeSansSerif = 1 , FontFamilyTypeSerif = 2 , FontFamilyTypeMonotype = 3 }
	FontFamilyType contains the types of font families available in iDRS SDK. More...

enum	HorizontalAlignment { HorizontalAlignmentLeft = 1 , HorizontalAlignmentRight = 2 , HorizontalAlignmentJustify = 3 , HorizontalAlignmentCenter = 4 , HorizontalAlignmentChar = 5 }
	HorizontalAlignment defines all possible horizontal alignments in iDRS. More...

enum	VerticalAlignment { VerticalAlignmentTop = 1 , VerticalAlignmentMiddle = 2 , VerticalAlignmentBottom = 3 , VerticalAlignmentBaseline = 4 }
	VerticalAlignment defines all possible vertical alignments in iDRS. More...

enum	TabulationLeader { TabulationLeaderTypeNone = 0 , TabulationLeaderTypeDots = 1 , TabulationLeaderTypeHyphen = 2 , TabulationLeaderTypeUnderscore = 3 }
	iDRS tabulation leader. More...

enum	ListType { ListTypeUnordered = 1 , ListTypeOrdered = 2 }
	iDRS list types. More...

enum	Hyperlink { HyperlinkTypeNone = 0 , HyperlinkTypeEmail = 1 , HyperlinkTypeUrl = 2 }
	Hyperlink contains the hyperlink states for elements in iDRS SDK. More...

enum	ParagraphType { ParagraphTypeBody = 0 , ParagraphTypeTitle = 1 , ParagraphTypeList = 2 }
	iDRS paragraph types. More...

enum	ListStyle { ListStyleNone = 0 , ListStyleDisc = 1 , ListStyleCircle = 2 , ListStyleSquare = 3 , ListStyleDecimal = 4 , ListStyleDecimalLeadingZero = 5 , ListStyleLowerRoman = 6 , ListStyleUpperRoman = 7 , ListStyleLowerGreek = 10 , ListStyleLowerLatin = 11 , ListStyleUpperLatin = 12 }
	iDRS list styles. More...

enum	FormFieldType { FormFieldTypeText = 0 , FormFieldTypeCombedText = 1 , FormFieldTypePassword = 2 , FormFieldTypeCheckbox = 3 , FormFieldTypeRadioButtonItem = 4 , FormFieldTypeRadioButton = 5 , FormFieldTypeGroup = 6 , FormFieldTypeDropdown = 7 , FormFieldTypeListBox = 8 }
	Definition of interactive form fields types. More...

enum	FormActionType { FormActionTypeJavaScript = 0 }
	Definition of actions types available in interactive forms. More...

enum	FormFieldEventType { FormFieldEventTypeOnKeyStroke = 0 , FormFieldEventTypeOnBeforeFormat = 1 , FormFieldEventTypeOnValidate = 2 , FormFieldEventTypeOnCalculate = 3 , FormFieldEventTypeOnMouseEnter = 4 , FormFieldEventTypeOnMouseLeave = 5 , FormFieldEventTypeOnMouseDown = 6 , FormFieldEventTypeOnMouseUp = 7 , FormFieldEventTypeOnFocus = 8 , FormFieldEventTypeOnBlur = 9 , FormFieldEventTypeOnPageOpen = 10 , FormFieldEventTypeOnPageClose = 11 , FormFieldEventTypeOnPageVisible = 12 , FormFieldEventTypeOnPageHide = 13 }
	Definition of events types available for an interactive form field. More...

enum	FormFieldBorderStyle { FormFieldBorderStyleInherit = 0 , FormFieldBorderStyleNone = 1 , FormFieldBorderStyleSolid = 2 , FormFieldBorderStyleDashed = 3 , FormFieldBorderStyleBeveled = 4 , FormFieldBorderStyleInset = 5 , FormFieldBorderStyleUnderline = 6 }
	Definition of border styles available for the interactive forms. More...

enum	FormFieldTextAlignment { FormFieldTextAlignmentNone = 0 , FormFieldTextAlignmentCenter = 1 , FormFieldTextAlignmentLeft = 2 , FormFieldTextAlignmentRight = 3 }
	Definition of the text alignments available for an interactive form field. More...

enum	AttachmentType { AttachmentTypeText = 0 , AttachmentTypePdf = 1 , AttachmentTypeXml = 2 , AttachmentTypeHtml = 3 , AttachmentTypeRtf = 4 , AttachmentTypeDoc = 5 , AttachmentTypeDot = 6 , AttachmentTypeDocx = 7 , AttachmentTypeDotx = 8 , AttachmentTypeXls = 9 , AttachmentTypeXlt = 10 , AttachmentTypeXla = 11 , AttachmentTypeXlsx = 12 , AttachmentTypeXltx = 13 , AttachmentTypeCsv = 14 , AttachmentTypePpt = 15 , AttachmentTypePptx = 16 , AttachmentTypePot = 17 , AttachmentTypePotx = 18 , AttachmentTypePps = 19 , AttachmentTypePpa = 20 , AttachmentTypeJpeg = 21 , AttachmentTypePng = 22 , AttachmentTypeTiff = 23 , AttachmentTypeGif = 24 , AttachmentTypeAppSpecific = 25 }
	The AttachmentType enum lists the supported Pdf attachments file types. More...

enum	ColorMode { ColorModeUnknown = 0 , ColorModeBlackAndWhite = 1 , ColorModeGreyscale = 2 , ColorModeColor = 3 }
	The image color modes handles by iDRS. More...

enum	CompressionQuality { CompressionQualityMinimalSize = 0 , CompressionQualityVerySmallSize = 1 , CompressionQualitySmallSize = 2 , CompressionQualityFavorSizeOverQuality = 3 , CompressionQualityMedium = 4 , CompressionQualityFavorQualityOverSize = 5 , CompressionQualityHighQuality = 6 , CompressionQualityVeryHighQuality = 7 , CompressionQualityMaximalQuality = 8 }
	Enumeration allowing to choose the target ratio between output size and image compression quality. More...

enum	CompressionLevel { CompressionLevelMaximumPerformance = 1 , CompressionLevelVeryHighPerformance = 2 , CompressionLevelHighPerformance = 3 , CompressionLevelFavorPerformance = 4 , CompressionLevelMedium = 5 , CompressionLevelFavorCompression = 6 , CompressionLevelHighCompression = 7 , CompressionLevelVeryHighCompression = 8 , CompressionLevelMaximumCompression = 9 }
	Enumeration allowing to choose the target ratio between compression performance and output size. More...

enum	PdfInputBlackAndWhiteDetection { PdfInputBlackAndWhiteDetectionDisabled = 0 , PdfInputBlackAndWhiteDetectionFast = 1 , PdfInputBlackAndWhiteDetectionAccurate = 2 }
	Detection mode for loading PDF black and white pages. More...

enum	ImageFormat { ImageFormatTiff = 0 , ImageFormatPng = 1 , ImageFormatJpeg = 2 , ImageFormatBmp = 3 , ImageFormatJpeg2000 = 5 , ImageFormatJbig2 = 6 , ImageFormatCustom = 10 , ImageFormatPdf = 11 }
	The image file formats handled by iDRS. More...

enum	TiffCompression { TiffCompressionGroup4 = 0 , TiffCompressionFaxGroup4 = 1 , TiffCompressionPackbits = 2 , TiffCompressionJpeg = 3 }
	Enum defining the Tiff Compression formats. More...

enum	PngTransparencyMode { PngTransparencyModeNone = 0 , PngTransparencyModeBlack = 1 }
	PngTransparencyMode defines the PNG image transparency. More...

enum	BinarizationType { BinarizationTypeFixedThreshold = 0 , BinarizationTypeAutomaticThreshold = 1 , BinarizationTypeAdaptive = 2 }
	The types of binarization available. More...

enum	DespeckleType { DespeckleTypeBlack = 0 , DespeckleTypeWhite = 1 , DespeckleTypeAll = 2 }
	The despeckling type. More...

enum	BlankImageDetectionMode { BlankImageDetectionModeFast = 0 , BlankImageDetectionModeAdvanced = 1 }

enum	BlankImageDetectionSensitivity { BlankImageDetectionSensitivityStronglyFavorBlank = 0 , BlankImageDetectionSensitivityFavorBlank = 1 , BlankImageDetectionSensitivityBalanced = 2 , BlankImageDetectionSensitivityFavorNotBlank = 3 , BlankImageDetectionSensitivityStronglyFavorNotBlank = 4 }

enum	ImageSource { ImageSourceUnknown = 0 , ImageSourceScanner = 1 , ImageSourceCamera = 2 }
	The image source types iDRS can identify. More...

enum	SkewDetection { SkewDetectionNone = 0 , SkewDetectionIfText = 1 , SkewDetectionAlways = 2 }
	Types of behaviors for skew detection & correction algorithm. More...

enum	DimensionAdjust { DimensionAdjustNone = 0 , DimensionAdjustCrop = 1 }
	Enumerable that defines the dimension adjustment options available when performing Deskew feature. More...

enum	OutputFormat { OutputFormatText = 0 , OutputFormatHtml = 1 , OutputFormatRtf = 2 , OutputFormatPdf = 3 , OutputFormatOdt = 4 , OutputFormatDocx = 5 , OutputFormatXlsx = 6 , OutputFormatEpub = 7 , OutputFormatPptx = 8 , OutputFormatXml = 9 }
	Definition of all output formats supported by the iDRS. More...

enum	PageLayout { PageLayoutNoLayout = 0 , PageLayoutFlowing = 1 , PageLayoutEditable = 2 , PageLayoutExact = 3 }
	Definition of page layouts available for word processor and HTML outputs. More...

enum	SpreadsheetLayout { SpreadsheetLayoutTablesOnly = 0 , SpreadsheetLayoutTablesAndText = 1 , SpreadsheetLayoutRecreateInput = 2 }
	Definition of spreadsheet layouts available. More...

enum	SlideSize { SlideSizeStandard = 0 , SlideSizeWideScreen = 1 , SlideSizeCustom = 2 }
	Definition of presentation slide sizes available. More...

enum	PageDisplay { PageDisplayTextAndGraphics = 0 , PageDisplayTextOverImage = 1 , PageDisplayImageOverText = 2 , PageDisplayHyperCompression = 3 }
	Definition of how a PDF page content will be displayed. More...

enum	BookmarksMode { BookmarksModeDisabled = 0 , BookmarksModeEnabled = 1 }
	Enumeration allowing to select bookmarks modes. More...

enum	PageSize { PageSizeA3 = 0 , PageSizeA4 = 1 , PageSizeA5 = 2 , PageSizeA6 = 3 , PageSizeB4 = 4 , PageSizeB5 = 5 , PageSizeLetter = 6 , PageSizeLegal = 7 , PageSizeTabloid = 8 , PageSizeExecutive = 9 }
	Definition of word processor page sizes. More...

enum	PaperOrientation { PaperOrientationPortrait = 0 , PaperOrientationLandscape = 1 }
	Definition of word processor paper orientations. More...

enum	PageOrientation { PageOrientationStraight = 0 , PageOrientationRotatedLeft = 90 , PageOrientationUpsideDown = 180 , PageOrientationRotatedRight = 270 }
	Definition of possible page orientations. More...

enum	PdfVersion { PdfVersionPdf14 = 0 , PdfVersionPdfA1b = 1 , PdfVersionPdfA1a = 2 , PdfVersionPdf15 = 3 , PdfVersionPdf16 = 4 , PdfVersionPdf17 = 5 , PdfVersionPdfA2b = 6 , PdfVersionPdfA2a = 7 , PdfVersionPdfA3b = 8 , PdfVersionPdfA3a = 9 , PdfVersionPdf17Extension3 = 10 , PdfVersionPdf17Extension5 = 11 , PdfVersionPdf17Extension8 = 12 , PdfVersionPdfA2u = 13 , PdfVersionPdfA3u = 14 }
	The PDF versions. More...

enum	CharacterEncoding { CharacterEncodingUtf8 = 0 , CharacterEncodingUtf16 = 1 }
	Definition of character encodings available for text outputs. More...

enum	PageCollectionType { PageCollectionTypeDefault = 0 , PageCollectionTypeCustom = 1 }
	Definition of the available types of IPageCollection implementations. More...

enum	XmlSchema { XmlSchemaBasic = 0 , XmlSchemaAlto = 1 }
	XML shemas. More...

enum	EncryptionAlgorithm { EncryptionAlgorithmNone = 0 , EncryptionAlgorithmAuto = 1 , EncryptionAlgorithmRc4 = 2 , EncryptionAlgorithmAes128 = 3 }
	The encryption levels. More...

enum	PrintPermission { PrintPermissionForbidden = 0 , PrintPermissionLowResolution = 1 , PrintPermissionAllowed = 2 }
	Restrictions on output document printing. More...

enum	EditPermission { EditPermissionNone = 0 , EditPermissionOrganizePages = 1 , EditPermissionFillAndSign = 2 , EditPermissionFillAndSignAndComment = 3 , EditPermissionAllViewerOptions = 4 }
	Restrictions on output document edition. More...

enum	FontInfoComputation { FontInfoComputationNone = 0 , FontInfoComputationStandard = 1 , FontInfoComputationOffice = 2 , FontInfoComputationCustom = 3 }
	Contains all sets of fonts that iDRS is able to recognize. More...

enum	RecognitionType { RecognitionTypeFullPage = 0 , RecognitionTypeZonal = 1 }
	Type recognitions. More...

enum	Workdepth { WorkdepthMaximumSpeed = 0 , WorkdepthFavorSpeedOverAccuracy = 1 , WorkdepthBalanced = 2 , WorkdepthFavorAccuracyOverSpeed = 3 , WorkdepthMaximumAccuracy = 4 }
	Enumerates the possible values for the work depth applied to the ocr engine. More...

enum	TextDetectionSensivity { TextDetectionSensivityMaximumText = 0 , TextDetectionSensivityFavorTextOverLayout = 1 , TextDetectionSensivityBalanced = 2 , TextDetectionSensivityFavorLayoutOverText = 3 , TextDetectionSensivityMaximumLayout = 4 }
	Text detection sensitivity modes. More...

enum	ThreadingMode { ThreadingModeNone = 0 , ThreadingModeLimited = 1 , ThreadingModeOptimized = 2 , ThreadingModeMaximum = 3 , ThreadingModeMemoryConservative = 4 }
	Multi-threading usage modes. More...

enum	TableDetectionMode { TableDetectionModeDisabled = 0 , TableDetectionModeAutomatic = 1 , TableDetectionModeForceSingleTable = 2 }
	Table detection modes. More...

enum	BarcodeEncoding { BarcodeEncodingUtf8 = 0 , BarcodeEncodingSjis = 1 }
	Barcode encoding modes. More...

enum	BarcodeEngineIdentifier { BarcodeEngineUIDStandard = 0 , BarcodeEngineUIDAdvanced = 1 , BarcodeEngineUIDDatamatrix = 2 , BarcodeEngineUIDExtra2D = 3 , BarcodeEngineUIDStandardDespeckle = 4 , BarcodeEngineUIDExtra2dDespeckle = 5 , BarcodeEngineUIDStandardUndither = 6 , BarcodeEngineUIDExtra2dUndither = 7 , BarcodeEngineUIDCustom = 8 }
	Barcode engines that are shipped with iDRS SDK. More...

enum	BarcodeRecognitionMode { BarcodeRecognitionModeStopOnFirstResult = 0 , BarcodeRecognitionModeReadAllBarcodes = 1 }
	recognition mode specifies how the engine will behave when performing recognition More...

enum	BarcodeCapability { BarcodeCapabilityImageBlackAndWhite = 1 , BarcodeCapabilityImageGreyscale = 2 , BarcodeCapabilityImageColor = 3 , BarcodeCapabilityCode128ControlCode = 4 }
	list with all possible capabilities for a barcode engine More...

enum	BarcodeSessionParameter { BarcodeSessionWorkdepth = 0 , BarcodeSessionMinHeight = 1 , BarcodeSessionMaxHeight = 2 , BarcodeSessionMinLength = 3 , BarcodeSessionMaxLength = 4 , BarcodeSessionRecognitionMode = 5 , BarcodeSessionTimeoutMilliseconds = 6 , BarcodeSessionCode128ControlCode = 7 , BarcodeSessionAutomaticEncodingDetectionUtf8 = 8 , BarcodeSessionAutomaticEncodingDetectionSJIS = 9 , BarcodeSessionMax = 10 }
	Enumerable containing all barcode session parameters These parameters are used to control the behavior of the barcode engines. More...

Detailed Description

Interface for EnumDefinitions wrapper.

Enumeration Type Documentation

◆ AttachmentType

enum AttachmentType

The AttachmentType enum lists the supported Pdf attachments file types.

Enumerator
AttachmentTypeText	"*.txt" file attachment
AttachmentTypePdf	"*.pdf" file attachment
AttachmentTypeXml	"*.xml" file attachment
AttachmentTypeHtml	"*.html" file attachment
AttachmentTypeRtf	"*.rtf" file attachment
AttachmentTypeDoc	"*.doc" file attachment
AttachmentTypeDot	"*.dot" file attachment
AttachmentTypeDocx	"*.docx" file attachment
AttachmentTypeDotx	"*.dotx" file attachment
AttachmentTypeXls	"*.xls" file attachment
AttachmentTypeXlt	"*.xlt" file attachment
AttachmentTypeXla	"*.xla" file attachment
AttachmentTypeXlsx	"*.xlsx" file attachment
AttachmentTypeXltx	"*.xltx" file attachment
AttachmentTypeCsv	"*.csv" file attachment
AttachmentTypePpt	"*.ppt" file attachment
AttachmentTypePptx	"*.pptx" file attachment
AttachmentTypePot	"*.pot" file attachment
AttachmentTypePotx	"*.potx" file attachment
AttachmentTypePps	"*.pps" file attachment
AttachmentTypePpa	"*.ppa" file attachment
AttachmentTypeJpeg	"*.jpg" file attachment
AttachmentTypePng	"*.png" file attachment
AttachmentTypeTiff	".tif" and ".tiff" file attachment
AttachmentTypeGif	"*.gif" file attachment
AttachmentTypeAppSpecific	Non-standard application specific attachment.

◆ BarcodeCapability

enum BarcodeCapability

list with all possible capabilities for a barcode engine

Enumerator
BarcodeCapabilityImageBlackAndWhite	The engine supports black&white images.
BarcodeCapabilityImageGreyscale	The engine supports greyscale images.
BarcodeCapabilityImageColor	The engine supports color images.
BarcodeCapabilityCode128ControlCode	The engine is able to get control codes for code128 barcode.

◆ BarcodeEncoding

enum BarcodeEncoding

Barcode encoding modes.

Enumerator
BarcodeEncodingUtf8	UTF-8 encoding.
BarcodeEncodingSjis	Shift JIS encoding.

◆ BarcodeEngineIdentifier

enum BarcodeEngineIdentifier

Barcode engines that are shipped with iDRS SDK.

Enumerator
BarcodeEngineUIDStandard	Default IRIS barcode engine. It supports the following barcode types: BarcodeType::Ean13, BarcodeType::Ean8, BarcodeType::Msi, BarcodeType::MsiPharma, BarcodeType::UpcA, BarcodeType::UpcE, BarcodeType::Codabar, BarcodeType::Interleaved2Of5, BarcodeType::Code39, BarcodeType::Code39Extended, BarcodeType::Code39Hibc, BarcodeType::Code93, BarcodeType::Code128, BarcodeType::Pdf417, BarcodeType::Postnet, BarcodeType::Patchcode, BarcodeType::Ucc128, BarcodeType::QrCode By default, the work depth range is MaximumSpeed to MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module
BarcodeEngineUIDAdvanced	Advanced barcode engine. It supports the following barcode types: BarcodeType::Ean13, BarcodeType::Ean8, BarcodeType::UpcA, BarcodeType::UpcE, BarcodeType::Codabar, BarcodeType::Interleaved2Of5, BarcodeType::Code39, BarcodeType::Code39Extended, BarcodeType::Code39Hibc, BarcodeType::Code128, BarcodeType::Pdf417, BarcodeType::Ucc128, BarcodeType::QrCode, BarcodeType::DataMatrix, BarcodeType::Patchcode By default the work depth range is FavorAccuracyOverSpeed to MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module with extension BarcodeAdvanced
BarcodeEngineUIDDatamatrix	Datamatrix barcode engine. It supports the following barcode types: BarcodeType::DataMatrix By default, the work depth range is MaximumSpeed to MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module with extension Barcode2D
BarcodeEngineUIDExtra2D	Advanced qrcode/aztec detection engine. It gets enabled automatically when setting up a license for IDRS_BARCODE_MODULE with extension IDRS_BARCODE_EXTENSION_QRCODE. It supports the following barcode types: BarcodeType::QrCode, BarcodeType::Aztec By default the work depth range is FavorAccuracyOverSpeed to MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module with extension Barcode2D
BarcodeEngineUIDStandardDespeckle	Default IRIS barcode engine with white pixels despeckle preprocessing step. Due to the fact that a preprocessing operation is performed before the barcode detection, the speed might be slightly degraded. It supports the same barcode types as the See also Standard barcode engine: BarcodeType::Ean13, BarcodeType::Ean8, BarcodeType::Msi, BarcodeType::MsiPharma, BarcodeType::UpcA, BarcodeType::UpcE, BarcodeType::Codabar, BarcodeType::Interleaved2Of5, BarcodeType::Code39, BarcodeType::Code39Extended, BarcodeType::Code39Hibc, BarcodeType::Code93, BarcodeType::Code128, BarcodeType::Pdf417, BarcodeType::Postnet, BarcodeType::Patchcode, BarcodeType::Ucc128, BarcodeType::QrCode By default the work depth range is MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module
BarcodeEngineUIDExtra2dDespeckle	Advanced qrcode/aztec detection engine with white pixels despeckle preprocessing step. Due to the fact that a preprocessing operation is performed before the barcode detection, the speed might be slightly degraded. It supports the following barcode types: BarcodeType::QrCode, BarcodeType::Aztec By default the work depth range is MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module with extension Barcode2D
BarcodeEngineUIDStandardUndither	Default IRIS barcode engine with dither removal preprocessing step. Due to the fact that a preprocessing operation is performed before the barcode detection, the speed might be slightly degraded. It supports the same barcode types as the See also Standard barcode engine: BarcodeType::Ean13, BarcodeType::Ean8, BarcodeType::Msi, BarcodeType::MsiPharma, BarcodeType::UpcA, BarcodeType::UpcE, BarcodeType::Codabar, BarcodeType::Interleaved2Of5, BarcodeType::Code39, BarcodeType::Code39Extended, BarcodeType::Code39Hibc, BarcodeType::Code93, BarcodeType::Code128, BarcodeType::Pdf417, BarcodeType::Postnet, BarcodeType::Patchcode, BarcodeType::Ucc128, BarcodeType::QrCode By default the work depth range is MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module
BarcodeEngineUIDExtra2dUndither	Advanced qrcode/aztec detection engine with dither removal preprocessing step. Due to the fact that a preprocessing operation is performed before the barcode detection, the speed might be slightly degraded. It supports the following barcode types: BarcodeType::QrCode, BarcodeType::Aztec By default the work depth range is MaximumAccuracy It gets enabled automatically when setting up a license for Barcode module with extension Barcode2D
BarcodeEngineUIDCustom	Custom barcode engine identifier. This identifier is present here to indicate any custom barcode engine that might be integrated with iDRS SDK.

◆ BarcodeRecognitionMode

enum BarcodeRecognitionMode

recognition mode specifies how the engine will behave when performing recognition

Enumerator
BarcodeRecognitionModeStopOnFirstResult	Stop on first result.
BarcodeRecognitionModeReadAllBarcodes	Read all barcodes in the supplied image.

◆ BarcodeSessionParameter

enum BarcodeSessionParameter

Enumerable containing all barcode session parameters These parameters are used to control the behavior of the barcode engines.

Enumerator
BarcodeSessionWorkdepth	Sets the barcode engine work depth. A lower value means that the engine should return the result(s) fast, while a higher value allows the engine to spend more time searching for barcodes. Expected range of values: [0 - 100]
BarcodeSessionMinHeight	Sets the minimum height for a barcode to be taken into consideration. Values are in pixels.
BarcodeSessionMaxHeight	Sets the maximum height for a barcode to be taken into consideration. Values are in pixels.
BarcodeSessionMinLength	Sets the minimum solution length (character count) for a barcode to be taken into consideration.
BarcodeSessionMaxLength	Sets the maximum solution length (character count) for a barcode to be taken into consideration.
BarcodeSessionRecognitionMode	Sets the barcode recognition mode that needs to be used for detection. The possible values are described in. See also IDRS::IDRS_BARCODE_RECOGNITION_MODE BarcodeRecognitionMode::StopOnFirstResult BarcodeRecognitionMode::ReadAllBarcodes
BarcodeSessionTimeoutMilliseconds	Sets the timeout in milliseconds after which the engine should stop doing recognition.
BarcodeSessionCode128ControlCode	Enables barcode code128 control code mode. Possible values are: IDRS_TRUE: enables the setting IDRS_FALSE: disables the setting
BarcodeSessionAutomaticEncodingDetectionUtf8	Enables automatic utf8 encoding detection. Possible values are: IDRS_TRUE: enables the automatic detection IDRS_FALSE: disables the automatic detection
BarcodeSessionAutomaticEncodingDetectionSJIS	Enables automatic SJIS encoding detection. Possible values are: IDRS_TRUE: enables the automatic detection IDRS_FALSE: disables the automatic detection
BarcodeSessionMax	Internal value.

◆ BinarizationType

enum BinarizationType

The types of binarization available.

Enumerator

BinarizationTypeFixedThreshold

Threshold binarization using a global threshold value provided by the integrator.

BinarizationTypeAutomaticThreshold

Threshold binarization using a global threshold value automatically computed based on the processed image.

BinarizationTypeAdaptive

Adaptive binarization using varying thresholds for different regions of the image.

Remarks: iDRS adaptive binarization is specifically fine-tuned to produce images suitable for OCR afterwards, which may not be the case of other algorithms (for instance binarizations embedded in MFPs).; This binarization algorithm is slower than FixedThreshold and AutomaticThreshold, but gives the best output in most scenarios.

◆ BlankImageDetectionMode

enum BlankImageDetectionMode

The blank image detection modes.

Enumerator

BlankImageDetectionModeFast

Fast.

The blank iame detection Fast mode uses basic detection algorithm, which will result in a near-immediate answer, at the cost of possible incorrect answer for some specific border cases.

This detection mode can be used when processing speed is crucial, and image differentiation is clear ("blank" pages are full white, and "non-blank" images contains several lines of text).

This is the default mode when instantiating a CBlankImageDetection object.

BlankImageDetectionModeAdvanced

Advanced.

The blank image detection Advanced mode performs extra preprocessing and enhancement steps on the provided images, in order to get reliable results according to the provided sensitivity. This mode will take more processing time than the Fast mode, but can more successfully categorize difficult cases, like damaged blank paper or pages with very few characters.

This detection mode can be used when detection accuracy is more important than processing speed.

◆ BlankImageDetectionSensitivity

enum BlankImageDetectionSensitivity

The blank image detection sensitivity.

Enumerator
BlankImageDetectionSensitivityStronglyFavorBlank	Strongly favor blank sensitivity will try to consider as much as possible images as blank. It can be interesting in cases where it is better to not miss any blank images, even if that can lead to some misdetection of images with actual content still considered as blank.
BlankImageDetectionSensitivityFavorBlank	Favor blank sensitivity will tend to detect more blank pages when processing border cases like damaged paper.
BlankImageDetectionSensitivityBalanced	The Balanced sensitivity will neither favor blank, nor not-blank detections. It is the mode which is expected to reach the highest accuracy overall. Remarks This is the default value.
BlankImageDetectionSensitivityFavorNotBlank	Favor not-blank sensitivity will tend to detect less blank images when processing border cases like pages with very little content (for instance just a page number).
BlankImageDetectionSensitivityStronglyFavorNotBlank	Strongly favor not-blank sensitivity will try to consider as much as possible images as not-blank. It can be interesting in cases where it is crucial not to falsely detect blank images, for instance if blank pimages are discarded afterwards.

◆ BookmarkDisplayMode

enum BookmarkDisplayMode

Enumeration allowing to specify a bookmark's display mode.

See also: CPageBookmark::SetDisplayMode() for more information.

Remarks: Bookmarks display mode is taken into account only for PDF output.

Enumerator
BookmarkDisplayModePage	The whole page will be fit to the view.
BookmarkDisplayModePageWidth	The page width will be fit to the view, and the top of the view set to the destination's top.
BookmarkDisplayModePageHeight	The page height will be fit to the view, and the left of the view set to the destination's left.
BookmarkDisplayModeContent	The page's content will be fit to the view.
BookmarkDisplayModeContentWidth	The page's content width will be fit to the view, and the top of the view set to the destination's top.
BookmarkDisplayModeContentHeight	The page's content height will be fit to the view, and the left of the view set to the destination's left.
BookmarkDisplayModeRectangle	The destination's rectangle will be fit to the view.
BookmarkDisplayModeZoom	The view will be positioned according to the destination's top and left coordinates, and the magnification level set to the bookmark's ZoomFactor property.

◆ BookmarksMode

enum BookmarksMode

Enumeration allowing to select bookmarks modes.

Enumerator

BookmarksModeDisabled

Do not create bookmarks in output file, even if document metadata defines some.

BookmarksModeEnabled

Create bookmarks in output file, according to what is specified in document metadata.

Remarks: This is the default behavior.

◆ CharacterEncoding

enum CharacterEncoding

Definition of character encodings available for text outputs.

Enumerator
CharacterEncodingUtf8	Utf8 encoding.
CharacterEncodingUtf16	Utf16 encoding.

◆ ColorMode

enum ColorMode

The image color modes handles by iDRS.

The iDRS is able to process three different color modes:

black and white,
greyscale,
color.

Enumerator
ColorModeUnknown	Color mode is not known yet. This color mode is an indication that the image is not yet initialized or some error has occured. Please check the documentation of the method retrieving this value as color mode
ColorModeBlackAndWhite	Black and white images. In iDRS, black and white images are 1 bit per pixels, the lines are aligned on 32 bits. In other words, for a black and white image, the number of bytes per lines is a multiple of 4.
ColorModeGreyscale	Greyscale images. In iDRS, greyscale images are 8 bits per pixels, lines are not aligned. This means that for a greyscale image, the number of bytes per lines is equal to the width in pixels of the image.
ColorModeColor	Color images. In iDRS, color images are 24 bits per pixels, lines are not aligned. This means that for a color image, the number of bytes per lines is equal to 3 times the width in pixels of the image.

◆ CompressionLevel

enum CompressionLevel

Enumeration allowing to choose the target ratio between compression performance and output size.

Enumerator
CompressionLevelMaximumPerformance	Performs compression with maximum focus on speed. Remarks For PNG output, it corresponds to deflate level 1.
CompressionLevelVeryHighPerformance	Performs compression with very high focus on speed. Remarks For PNG output, it corresponds to deflate level 2.
CompressionLevelHighPerformance	Performs compression with high focus on speed. Remarks For PNG output, it corresponds to deflate level 3.
CompressionLevelFavorPerformance	Performs compression favoring speed. Remarks For PNG output, it corresponds to deflate level 4.
CompressionLevelMedium	Performs compression favoring size. Remarks For PNG output, it corresponds to deflate level 5.
CompressionLevelFavorCompression	Performs compression with balance between size and speed. Remarks For PNG output, it corresponds to deflate level 6. This is the default value.
CompressionLevelHighCompression	Performs compression with high focus on size. Remarks For PNG output, it corresponds to deflate level 7.
CompressionLevelVeryHighCompression	Performs compression with very high focus on size. Remarks For PNG output, it corresponds to deflate level 8.
CompressionLevelMaximumCompression	Performs compression with maximum focus on size. Remarks For PNG output, it corresponds to deflate level 9. Warning Note that compression level may have very low impact on size, for significant processing time increase.

◆ CompressionQuality

enum CompressionQuality

Enumeration allowing to choose the target ratio between output size and image compression quality.

Enumerator
CompressionQualityMinimalSize	Minimal size.
CompressionQualityVerySmallSize	Very small size.
CompressionQualitySmallSize	Small size.
CompressionQualityFavorSizeOverQuality	Favor size over quality.
CompressionQualityMedium	Medium.
CompressionQualityFavorQualityOverSize	Favor quality over size.
CompressionQualityHighQuality	High quality.
CompressionQualityVeryHighQuality	Very high quality.
CompressionQualityMaximalQuality	Maximal quality.

◆ DespeckleType

enum DespeckleType

The despeckling type.

Enumerator
DespeckleTypeBlack	Remove black speckles.
DespeckleTypeWhite	Remove white speckles.
DespeckleTypeAll	Remove both black and white speckles.

◆ DimensionAdjust

enum DimensionAdjust

Enumerable that defines the dimension adjustment options available when performing Deskew feature.

Enumerator

DimensionAdjustNone

Do not perform dimensions adjustment.

The deskewed image dimensions will be slightly bigger than the original image if a skew angle has been detected. This is the fastest mode, and ensures that all the information on the image is kept.

DimensionAdjustCrop

If a skew angle is found, crop the deskewed image so that its dimensions matches exactly the original image.

This guarantees that the created output document will have the proper dimensions when it's according to a standard (e.g. A4 paper size).

Note that if the image was containing data very close to the borders, it might be removed by the crop operation.

◆ EditPermission

enum EditPermission

Restrictions on output document edition.

Enumerator
EditPermissionNone	User will not be able to edit the document.
EditPermissionOrganizePages	User will only be able to insert, delete or rotate pages.
EditPermissionFillAndSign	User will be able to fill form fields and sign the document.
EditPermissionFillAndSignAndComment	User will be able to add annotations, fill form fields and sign the document.
EditPermissionAllViewerOptions	User will have access to all functionalities listed by other values of the enum. Extraction of the pages' content is not included by this value, and handled separately via another property of CEncryptionOptions class.

◆ EncryptionAlgorithm

enum EncryptionAlgorithm

The encryption levels.

Enumerator
EncryptionAlgorithmNone	No encryption.
EncryptionAlgorithmAuto	Autodetect encryption algorithm The best algorithm for the format will be chosen.
EncryptionAlgorithmRc4	RC4 128 bit algorithm. Important: Please note that RC4 is considered insecure, but allows to apply encryption on PDF versions 1.4 and 1.5. If possible, prefer generating PDF versions 1.6 or later with AES 128 encryption.
EncryptionAlgorithmAes128	AES 128 bit algorithm. Important: Required PDF version 1.6 or higher

◆ FileStreamMode

enum FileStreamMode

Filestream open modes.

Enumerator
FileStreamModeRead	Read mode.
FileStreamModeWrite	Write mode.
FileStreamModeAppend	Append mode.
FileStreamModeReadWrite	Read and Write mode. Allows read, write and seek.

◆ FontFamilyType

enum FontFamilyType

FontFamilyType contains the types of font families available in iDRS SDK.

Enumerator
FontFamilyTypeSansSerif	SansSerif family type.
FontFamilyTypeSerif	Serif family type.
FontFamilyTypeMonotype	Monotype family type.

◆ FontInfoComputation

enum FontInfoComputation

Contains all sets of fonts that iDRS is able to recognize.

Enumerator
FontInfoComputationNone	No formatting information computed. Please note that using this mode the OCR engine will not extract any formatting information from the input image. Information like color, fonts, etc will NOT be computed. Remarks Providing to CDocumentWriter::Save() a CPage with content generated with FontInfoComputation::None will trigger an exception, when creating any structured output format. Only OutputFormat::Text will be supported.
FontInfoComputationStandard	Represents an standard set of fonts used for OCR. In includes the following fonts: Arial Times New Roman Courier New Tahoma Verdana Georgia Trebuchet MS Batang (windows, linux) MS-PMincho (windows, linux) SimSun (windows, linux) PMingLiU (windows, linux) AppleMyungjo (osx) HiraMinPro-W3 (osx) Kai (osx) BiauKai (osx)
FontInfoComputationOffice	Contains a set of fonts usually included in Microsoft Office. This font set includes the following fonts: Arial Times New Roman Courier New Tahoma Calibri Cambria Candara Consolas Constantia Corbel Bookman Old Style Gill Sans MT Trebuchet MS Franklin Gothic Tw Cen MT Century Schoolbook Century Gothic Garamond Batang (windows, linux) MS-PMincho (windows, linux) SimSun (windows, linux) PMingLiU (windows, linux) AppleMyungjo (osx) HiraMinPro-W3 (osx) Kai (osx) BiauKai (osx)
FontInfoComputationCustom	Represents a value that is expected to be used by integrators when defining custom fonts for the results in iDRS SDK.

◆ FormActionType

enum FormActionType

Definition of actions types available in interactive forms.

Enumerator
FormActionTypeJavaScript	Action that is implemented using the JavaScript Adobe Form API.

◆ FormFieldBorderStyle

enum FormFieldBorderStyle

Definition of border styles available for the interactive forms.

Enumerator
FormFieldBorderStyleInherit	Defaults to none or inherits from the parent field if applicable.
FormFieldBorderStyleNone	no border surrounding the form field.
FormFieldBorderStyleSolid	A solid rectangle surrounding the form field.
FormFieldBorderStyleDashed	A dashed rectangle surrounding the form field.
FormFieldBorderStyleBeveled	A simulated embossed rectangle that appears to be raised above the surface of the page.
FormFieldBorderStyleInset	A simulated engraved rectangle that appears to be recessed below the surface of the page.
FormFieldBorderStyleUnderline	A single line along the bottom of the field bounding box.

◆ FormFieldEventType

enum FormFieldEventType

Definition of events types available for an interactive form field.

Enumerator
FormFieldEventTypeOnKeyStroke	Event triggered when the user type a keystroke in a form field or selects an item in a list.
FormFieldEventTypeOnBeforeFormat	Event triggered before the form field value is formatted for display.
FormFieldEventTypeOnValidate	Event triggered for validation after the form field's value is changed.
FormFieldEventTypeOnCalculate	Event triggered when the form field value re-calculation is requested.
FormFieldEventTypeOnMouseEnter	Event triggered when the cursor enters the field's active area.
FormFieldEventTypeOnMouseLeave	Event triggered when the cursor leaves the field's active area.
FormFieldEventTypeOnMouseDown	Event triggered when the mouse button is pressed inside the field's active area.
FormFieldEventTypeOnMouseUp	Event triggered when the mouse button is released inside the field's active area.
FormFieldEventTypeOnFocus	Event triggered when the field receives the input focus.
FormFieldEventTypeOnBlur	Event triggered when the field loses the input focus.
FormFieldEventTypeOnPageOpen	Event triggered when the page containing the field is opened.
FormFieldEventTypeOnPageClose	Event triggered when the page containing the field is closed.
FormFieldEventTypeOnPageVisible	Event triggered when the page containing the field becomes visible in the viewer application.
FormFieldEventTypeOnPageHide	Event triggered when the page containing the field is no longer visible in the viewer application.

◆ FormFieldTextAlignment

enum FormFieldTextAlignment

Definition of the text alignments available for an interactive form field.

Enumerator
FormFieldTextAlignmentNone	Default text alignment or inherits from the parent field if applicable.
FormFieldTextAlignmentCenter	Centered text.
FormFieldTextAlignmentLeft	Left aligned text.
FormFieldTextAlignmentRight	Right aligned text.

◆ FormFieldType

enum FormFieldType

Definition of interactive form fields types.

Enumerator
FormFieldTypeText	Input field that accepts a single or multiple lines of unformatted text.
FormFieldTypeCombedText	Input field subdivided in single letter boxes that accepts a single line of unformatted text.
FormFieldTypePassword	Input field of hidden text that accepts a password value.
FormFieldTypeCheckbox	Togglable button that holds a two states value (on/off).
FormFieldTypeRadioButtonItem	Togglable option button owned by a RadioButton.
FormFieldTypeRadioButton	RadioButton field that contains a set of RadioButtonItem elements.
FormFieldTypeGroup	Logical group of fields sharing the same parent in the interactive form hierarchy.
FormFieldTypeDropdown	List of selectable items with an optional text input field.
FormFieldTypeListBox	Scrollable list of selectable items where one or more item(s) may be selected at a given time.

◆ GraphicShapeType

enum GraphicShapeType

GraphicShapeType contains the types of graphic shapes handled by iDRS.

Enumerator
GraphicShapeTypeLine	Line shape type (i.e. segment)

◆ HorizontalAlignment

enum HorizontalAlignment

HorizontalAlignment defines all possible horizontal alignments in iDRS.

Enumerator
HorizontalAlignmentLeft	Left.
HorizontalAlignmentRight	Right.
HorizontalAlignmentJustify	Justify.
HorizontalAlignmentCenter	Center.
HorizontalAlignmentChar	Char.

◆ Hyperlink

enum Hyperlink

Hyperlink contains the hyperlink states for elements in iDRS SDK.

Enumerator
HyperlinkTypeNone	No hyperlink.
HyperlinkTypeEmail	The following words are in an hyperlink for an e-mail.
HyperlinkTypeUrl	The following words are in an hyperlink for an URL.

◆ ImageFormat

enum ImageFormat

The image file formats handled by iDRS.

Enumerator
ImageFormatTiff	Tiff.
ImageFormatPng	Png.
ImageFormatJpeg	Jpeg.
ImageFormatBmp	Bmp.
ImageFormatJpeg2000	Jpeg 2000.
ImageFormatJbig2	Jbig2.
ImageFormatCustom	Custom.
ImageFormatPdf	PDF image file.

◆ ImageSource

enum ImageSource

The image source types iDRS can identify.

Enumerator
ImageSourceUnknown	The source of the image could not be identified.
ImageSourceScanner	The image is likely to have been created by a scanner device.
ImageSourceCamera	The image is likely to have been created by a camera device.

◆ ListStyle

enum ListStyle

iDRS list styles.

Enumerator
ListStyleNone	None.
ListStyleDisc	Disc.
ListStyleCircle	Circle.
ListStyleSquare	Square.
ListStyleDecimal	Decimal.
ListStyleDecimalLeadingZero	Decimal with leading zero.
ListStyleLowerRoman	Lower roman.
ListStyleUpperRoman	Upper roman.
ListStyleLowerGreek	Lower greek.
ListStyleLowerLatin	Lower latin.
ListStyleUpperLatin	Upper latin.

◆ ListType

enum ListType

iDRS list types.

Enumerator
ListTypeUnordered	Unordered list.
ListTypeOrdered	Ordered list.

◆ OutputFormat

enum OutputFormat

Definition of all output formats supported by the iDRS.

Enumerator
OutputFormatText	Text output format.
OutputFormatHtml	HTML output format.
OutputFormatRtf	RTF output format.
OutputFormatPdf	PDF output format.
OutputFormatOdt	Open document Text output format.
OutputFormatDocx	DOCX output format.
OutputFormatXlsx	XLSX output format.
OutputFormatEpub	EPUB output format.
OutputFormatPptx	Powerpoint presentation output format.
OutputFormatXml	XML output format.

◆ PageCollectionType

enum PageCollectionType

Definition of the available types of IPageCollection implementations.

Enumerator
PageCollectionTypeDefault	Default implementation of IPageCollection.
PageCollectionTypeCustom	Custom implementation of the IPageCollection.

◆ PageDisplay

enum PageDisplay

Definition of how a PDF page content will be displayed.

Enumerator
PageDisplayTextAndGraphics	Detected zones (text, table, and graphics) will be positioned separately on the canvas of the PDF.
PageDisplayTextOverImage	For each page of the document, the detected text will be removed from the input image, and both will be added to the output page. The detected text will therefore be visible above the background image.
PageDisplayImageOverText	For each page of the document, the input image will be added entirely on the output page, without any modification, and the detected text will be added under the image. This page display is also commonly called "Searchable PDF".
PageDisplayHyperCompression	Applies IRIS Hyper Compression to the output pages. IRIS iHQC (standing for "intelligent High Quality Compression") is a proprietary implementation of mixed raster content compression method (MRC). It relies on image segmentation to fine-tune compression rate applied to input images, which are separated between foreground, mask and background images. When generating the PDF, the detected text is also added under the image, which makes PDFs generated with iHQC compression searchable (similarly to ImageOverText page display).

◆ PageLayout

enum PageLayout

Definition of page layouts available for word processor and HTML outputs.

Enumerator
PageLayoutNoLayout	Layout of the input pages is not retained, and all elements are written as body text in reading order.
PageLayoutFlowing	Layout of the input pages will be reproduced as closely as possible with body text and page columns, using frames only for elements outside of the text body.
PageLayoutEditable	Detected elements will be placed in frames to ensure reproducing exactly the input document's layout; graphic elements will also be created so that the layout of the page could be easily modified.
PageLayoutExact	Detected text will be placed in frames to ensure reproducing exactly the input document's layout, and the whole input image will be placed as page background to ensure maximum similarity to the input, at the cost of a document less easy to modify.

◆ PageOrientation

enum PageOrientation

Definition of possible page orientations.

Enumerator
PageOrientationStraight	Represents a straight page.
PageOrientationRotatedLeft	Represents a page rotated 90 degrees counterclockwise.
PageOrientationUpsideDown	Represents a page rotated at 180 degrees (upside down).
PageOrientationRotatedRight	Represents a page rotated 270 degrees counterclockwise (90 degrees clockwise).

◆ PageSize

enum PageSize

Definition of word processor page sizes.

Enumerator
PageSizeA3	A3 page size.
PageSizeA4	A4 page size.
PageSizeA5	A5 page size.
PageSizeA6	A6 page size.
PageSizeB4	B4 page size.
PageSizeB5	B5 page size.
PageSizeLetter	Letter page size.
PageSizeLegal	Legal page size.
PageSizeTabloid	Tabloid page size.
PageSizeExecutive	Executive page size.

◆ PageZoneGraphicSource

enum PageZoneGraphicSource

Source for graphical zones.

Enumerator
PageZoneGraphicSourceBaseImage	The source is the base image, usually the one used for text recognition or barcode detection.
PageZoneGraphicSourceExternal	The source is an image from an external source.
PageZoneGraphicSourceExternalWithMask	The source is an image from an external source and it has a transparency mask associated.

◆ PaperOrientation

enum PaperOrientation

Definition of word processor paper orientations.

Enumerator
PaperOrientationPortrait	Portrait orientation.
PaperOrientationLandscape	Landscape orientation.

◆ ParagraphType

enum ParagraphType

iDRS paragraph types.

Enumerator
ParagraphTypeBody	Body type.
ParagraphTypeTitle	Title.
ParagraphTypeList	List.

◆ PdfCustomMetadataResourceType

enum PdfCustomMetadataResourceType

Flags for describing a Pdf Metadata Resource type.

Enumerator
PdfCustomMetadataResourceTypeContainer	Container type.
PdfCustomMetadataResourceTypePropertyList	Property list type.

◆ PdfInputBlackAndWhiteDetection

enum PdfInputBlackAndWhiteDetection

Detection mode for loading PDF black and white pages.

When rasterizing a PDF page, black and white pages will become greyscale due to image smoothing (which improves image quality). In order to avoid this, extra computation can be performed in order to detect original black and white pages and restore original color mode.

Enumerator

PdfInputBlackAndWhiteDetectionDisabled

No detection.

Black and white pages will be loaded in greyscale; image visual aspect will be better and OCR generally better, but will generate larger output files.

PdfInputBlackAndWhiteDetectionFast

Fast detection.

The PDF page will be inspected and loaded as black and white if containing only BW images. Any other cases will generate a greyscale image.

PdfInputBlackAndWhiteDetectionAccurate

Complete detection.

The PDF page raster will be analyzed in details to detect black and white content. This mode is the slowest but the most accurate.

◆ PdfVersion

enum PdfVersion

The PDF versions.

Enumerator
PdfVersionPdf14	PDF 1.4. PDF 1.4 - 2001 - Acrobat 5.0 + JBIG2; RC4 encryption key lengths greater than 40bits (128bits); Extensible Metadata Platform (XMP); Tagged PDF
PdfVersionPdfA1b	PDF 1.4 A-1b. Part 1 of the PDF/A ISO standard [ISO 19005-1:2005] - PDF for Long-term Preservation, Use of PDF 1.4, Level B Conformance
PdfVersionPdfA1a	PDF 1.4 A-1a. Part 1 of the PDF/A ISO standard [ISO 19005-1:2005] - PDF for Long-term Preservation, Use of PDF 1.4, Level A Conformance
PdfVersionPdf15	PDF 1.5. PDF 1.5 - 2003 - Acrobat 6.0 + JPEG 2000
PdfVersionPdf16	PDF 1.6. PDF 1.6 - 2005 - Acrobat 7.0 + AES encryption
PdfVersionPdf17	PDF 1.7. PDF 1.7 - 2006 - Acrobat 8.0 -> 2008 - ISO 32000-1:2008
PdfVersionPdfA2b	PDF 1.7 A-2b. Part 2 of the PDF/A ISO standard [ISO 19005-2] - PDF for Long-term Preservation, Use of ISO 32000-1 (PDF 1.7), Level B Conformance
PdfVersionPdfA2a	PDF 1.7 A-2a. Part 2 of the PDF/A ISO standard [ISO 19005-2] - PDF for Long-term Preservation, Use of ISO 32000-1 (PDF 1.7), Level A Conformance
PdfVersionPdfA3b	PDF 1.7 A-3b. Part 3 of the PDF/A ISO standard [ISO 19005-3] - PDF for Long-term Preservation, Use of ISO 32000-1 (PDF 1.7) with support for embedded files, Level B Conformance
PdfVersionPdfA3a	PDF 1.7 A-3a. Part 3 of the PDF/A ISO standard [ISO 19005-3] - PDF for Long-term Preservation, Use of ISO 32000-1 (PDF 1.7) with support for embedded files, Level A Conformance
PdfVersionPdf17Extension3	PDF 1.7. PDF 1.7 - 2008 - Adobe Extension Level 3 / Acrobat 9.0 + 256-bit AES encryption
PdfVersionPdf17Extension5	PDF 1.7. PDF 1.7 - 2009 - Adobe Extension Level 5 / Acrobat 9.1
PdfVersionPdf17Extension8	PDF 1.7. PDF 1.7 - 2011 - Adobe Extension Level 8 / Acrobat X
PdfVersionPdfA2u	PDF 1.7 A-2u. PDF/A-2u, PDF for Long-term Preservation, ISO 32000-1 (PDF 1.7), Level U Conformance
PdfVersionPdfA3u	PDF 1.7 A-3u. PDF/A-3u, PDF for Long-term Preservation, ISO 32000-1 (PDF 1.7), Level U Conformance

◆ PngTransparencyMode

enum PngTransparencyMode

PngTransparencyMode defines the PNG image transparency.

Enumerator
PngTransparencyModeNone	No transparency applied.
PngTransparencyModeBlack	The black pixels will be converted to transparent.

◆ PrintPermission

enum PrintPermission

Restrictions on output document printing.

Enumerator
PrintPermissionForbidden	User is not allowed to print the document.
PrintPermissionLowResolution	User will be able to print the document but only at a low resolution (150 dpi).
PrintPermissionAllowed	User will be able to print the document.

◆ RecognitionType

enum RecognitionType

Type recognitions.

Enumerator
RecognitionTypeFullPage	Full page recognition.
RecognitionTypeZonal	Zonal recognition.

◆ SeekPosition

enum SeekPosition

Position to which offset is added when performing a Seek operation on a IByteStream.

Enumerator
SeekPositionBegin	Seek from the beginning. (The origin is the beginning of the stream)
SeekPositionCurrent	Seek from the current position. (The origin is the current position in the stream)
SeekPositionEnd	Seek from the end. (The origin is the end of the stream)

◆ SerializationFormat

enum SerializationFormat

Definition of the available versions of serialization.

Enumerator
SerializationVersion10	Version 10.
SerializationVersion11	Version 11.
SerializationVersion12	Version 12.
SerializationVersion13	Version 13.
SerializationVersion14	Version 14.
SerializationVersion15	Version 15.
SerializationVersion16	Version 16.
SerializationVersion17	Version 17.
SerializationVersion18	Version 18.
SerializationVersion19	Version 19.
SerializationVersion20	Version 20.
SerializationVersionLatest	Latest Version.

◆ SeverityLevel

enum SeverityLevel

The SeverityLevel defines the severity level of the events that are logged and can be received by an integrator, via registration of an implementation of the ILogger interface either on a CIDRS instance (for instance-based operations) or CIDRSSetup (for static operations).

Enumerator
SeverityLevelInfo	This level describes events that will be logged from iDRS as info messages, giving information to user about the progress and the status of an operation.
SeverityLevelWarning	This level describes events that will be logged from iDRS as warning messages, giving more information to user when a warning occurs during an operation.
SeverityLevelError	This level describes events that will be logged from iDRS as error messages, giving more information to user when an error occurs during an operation.

◆ SkewDetection

enum SkewDetection

Types of behaviors for skew detection & correction algorithm.

Enumerator

SkewDetectionNone

No skew detection & correction.

SkewDetectionIfText

Skew detection is performed, but correction is not done if the page does not contain any text.

This feature is especially useful for documents where there are pages without text

Remarks: This mode relies on a part of the language and orientation detection algorithm; therefore if neither of them are activated, processing speed will be slower than if using skew detection modes None or Always.

SkewDetectionAlways

Skew detection & correction is always performed.

◆ SlideSize

enum SlideSize

Definition of presentation slide sizes available.

Enumerator

SlideSizeStandard

Standard 4:3 presentation layout. Each slide in the presentation will have the following dimensions: 10in x 7.5in (25.4cm x 19.05cm)

SlideSizeWideScreen

Widescreen 16:9 presentation layout. Each slide in the presentation will have the following dimensions: 10in x 5.625in (25.4cm x 14.2875cm)

SlideSizeCustom

Custom slide size. The presentation slides dimension will be computed based on the size of the images added to the document. The following restrictions apply:

Minimum presentation dimension: 1in (2.54cm)
Maximum presentation dimension: 56in (142.24cm)

Remarks: Please note that the above restrictions will be applied even if larger or smaller images are provided. That means that, providing an image 32000px x 1000px at 300 dpi will still output a vaild pptx file.

◆ SpreadsheetLayout

enum SpreadsheetLayout

Definition of spreadsheet layouts available.

Enumerator
SpreadsheetLayoutTablesOnly	Create one worksheet for each table detected and link them in a summary sheet. Text outside tables and graphics will not be written.
SpreadsheetLayoutTablesAndText	Write detected tables and text outside tables in reading order, without trying to keep the original image's layout.
SpreadsheetLayoutRecreateInput	Reproduce the input document's layout as faithfully as possible, using frames for graphics and text outside tables, to ensure exact positioning.

◆ TableDetectionMode

enum TableDetectionMode

Table detection modes.

Enumerator

TableDetectionModeDisabled

Table detection is disabled.

In this mode, no table will be detected during page recognition

TableDetectionModeAutomatic

Automatic table detection.

TableDetectionModeForceSingleTable

Forces one table on the whole page.

In this mode the ocr engine treats the whole input page as a table.

If the ocr engine cannot treat the entire page as a table, it will automatically switch to automatic mode.

◆ TabulationLeader

enum TabulationLeader

iDRS tabulation leader.

Enumerator
TabulationLeaderTypeNone	None.
TabulationLeaderTypeDots	Dots.
TabulationLeaderTypeHyphen	Hyphen.
TabulationLeaderTypeUnderscore	Underscore.

◆ TextDetectionSensivity

enum TextDetectionSensivity

Text detection sensitivity modes.

Enumerator
TextDetectionSensivityMaximumText	Maximize the text output. The OCR engine will search for as much text as possible, including in zones which could be seen as graphics.
TextDetectionSensivityFavorTextOverLayout	Prioritize the detection of text over graphics.
TextDetectionSensivityBalanced	Balanced text/graphics detection sensitivity.
TextDetectionSensivityFavorLayoutOverText	Prioritize the detection of graphics elements over text.
TextDetectionSensivityMaximumLayout	Maximize the graphics output. Using this mode, some text parts might be recognized as graphics.

◆ TextDirection

enum TextDirection

The TextDirection data type defines the text direction of the concerned element it is applied to.

The text direction indicates (in OCR results), or restricts (as OCR parameters), the natural reading order of the concerned text.

Enumerator
TextDirectionAny	The text can be read in any direction. Remarks This value will never be provided as output (i.e. in OCR results), but is the default value for COcrContext.TextDirection.
TextDirectionLeftToRight	The text runs from left to right.
TextDirectionTopToBottom	Text goes top to bottom.
TextDirectionRightToLeft	Text goes right to left.

◆ TextType

enum TextType

The TextType data type defines the type text type.

Enumerator
TextTypePrinted	Normal text.
TextTypeBlockLettersHandwriting	Spaced handprinting.
TextTypeCursiveHandwriting	Handprint text that may be near one another or even touching (Contiguous handprinting)

◆ ThreadingMode

enum ThreadingMode

Multi-threading usage modes.

Enumerator
ThreadingModeNone	Disable multi-threading. All processing operations will be executed sequentially.
ThreadingModeLimited	Multi-threading enabled. Processing operations will be executed in parallel, but using a maximum of half the number of logical cores of the device.
ThreadingModeOptimized	Multi-threading enabled. Processing operations will be executed in parallel, using up to the number of logical cores of the device.
ThreadingModeMaximum	Multi-threading enabled. Processing operations will be executed in parallel, using up to the number of logical cores of the device; and for zonal OCR, OCR instances will be run simultaneously for each OCR context. Important: This mode uses a lot of memory in case of zonal OCR with several contexts.
ThreadingModeMemoryConservative	Multi-threading enabled. Processing operations will be executed in parallel, using up to the number of logical cores of the device, but only for operations which would not significantly increase memory consumption.

◆ TiffCompression

enum TiffCompression

Enum defining the Tiff Compression formats.

Enumerator
TiffCompressionGroup4	Group4 compression (a.k.a. CCITT Group 4)
TiffCompressionFaxGroup4	Specialized version of Group4 compression, required by some formats/softwares. Remarks This compression should be used only in specific and known contexts. For general purpose, prefer standard Group4 compression.
TiffCompressionPackbits	Packbits compression.
TiffCompressionJpeg	Jpeg compression.

◆ VerticalAlignment

enum VerticalAlignment

VerticalAlignment defines all possible vertical alignments in iDRS.

Enumerator
VerticalAlignmentTop	Top.
VerticalAlignmentMiddle	Middle.
VerticalAlignmentBottom	Bottom.
VerticalAlignmentBaseline	Baseline.

◆ Workdepth

enum Workdepth

Enumerates the possible values for the work depth applied to the ocr engine.

Enumerator
WorkdepthMaximumSpeed	Favor speed over accuracy.
WorkdepthFavorSpeedOverAccuracy	Slightly favor speed over accuracy.
WorkdepthBalanced	Balanced speed/accuracy.
WorkdepthFavorAccuracyOverSpeed	Slightly favor accuracy over speed.
WorkdepthMaximumAccuracy	Favor accuracy over speed.

◆ XmlSchema

enum XmlSchema

XML shemas.

Enumerator

XmlSchemaBasic

Basic XML schema.

This format will describe the recognized zones and their content with a simple representation (for instance text lines entries for text zones).

Important:: Please note that this format doesn't allow multipage outputs yet, and CDocumentWriter will throw an exception if the case occurs. This possibility will be added in a future release.

XmlSchemaAlto

XML schema for ALTO export.

By using this format for export, the output xml file will contain information about the recognized data, including the page layout properties conform to ALTO specification

◆ ZoneType

enum ZoneType

The ZoneType data type defines the type of a zone.

The iDRS manages different types of zone:

text,
graphic,
table,

Enumerator
ZoneTypeText	Text: The zone contains some text.
ZoneTypeGraphic	Graphic: The zone contains an illustration, a photo, etc.
ZoneTypeTable	Table: The zone contains a table.

Enumerations

Detailed Description

Enumeration Type Documentation

◆ AttachmentType

◆ BarcodeCapability

◆ BarcodeEncoding

◆ BarcodeEngineIdentifier

◆ BarcodeRecognitionMode

◆ BarcodeSessionParameter

◆ BinarizationType

◆ BlankImageDetectionMode

◆ BlankImageDetectionSensitivity

◆ BookmarkDisplayMode

◆ BookmarksMode

◆ CharacterEncoding

◆ ColorMode

◆ CompressionLevel

◆ CompressionQuality

◆ DespeckleType

◆ DimensionAdjust

◆ EditPermission

◆ EncryptionAlgorithm

◆ FileStreamMode

◆ FontFamilyType

◆ FontInfoComputation

◆ FormActionType

◆ FormFieldBorderStyle

◆ FormFieldEventType

◆ FormFieldTextAlignment

◆ FormFieldType

◆ GraphicShapeType

◆ HorizontalAlignment

◆ Hyperlink

◆ ImageFormat

◆ ImageSource

◆ ListStyle

◆ ListType

◆ OutputFormat

◆ PageCollectionType

◆ PageDisplay

◆ PageLayout

◆ PageOrientation

◆ PageSize

◆ PageZoneGraphicSource

◆ PaperOrientation

◆ ParagraphType

◆ PdfCustomMetadataResourceType

◆ PdfInputBlackAndWhiteDetection

◆ PdfVersion

◆ PngTransparencyMode

◆ PrintPermission

◆ RecognitionType

◆ SeekPosition

◆ SerializationFormat

◆ SeverityLevel

◆ SkewDetection

◆ SlideSize

◆ SpreadsheetLayout

◆ TableDetectionMode

◆ TabulationLeader

◆ TextDetectionSensivity

◆ TextDirection

◆ TextType

◆ ThreadingMode

◆ TiffCompression

◆ VerticalAlignment

◆ Workdepth

◆ XmlSchema

◆ ZoneType