Jump to main content
Brainware Intelligent Capture Scripting
Brainware Intelligent Capture Scripting
 Foundation 23.1
  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption
  1. Home
  2. Working with Images (SCBCroIMGLib)
  3. Image Object SCBCroImage

    The component SCBCroImage provides methods and properties to load, modify, and save image files.

  4. SCBCroImage Properties

    This object provides the following properties.

  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
    • SCBCroIMGLib Type Definitions

      The SCBCroImage object provides the following type definitions.

    • Image Object SCBCroImage

      The component SCBCroImage provides methods and properties to load, modify, and save image files.

      • SCBCroImage Methods

        This object provides the following methods.

      • SCBCroImage Properties

        This object provides the following properties.

        • BitsPerPixel

          This read-only property returns the number of bits per pixel of the current loaded image.

        • DefaultJPGQuality

          This property sets or returns the default quality for saving JPG-images.

        • FileName

          This property returns the path used by the last LoadFile or LoadMultiImageFile operation or an empty string when no load operation was executed before.

        • Height

          This read-only property returns the height of the image in pixels.

        • ImageCount

          This read-only property returns the number of images in the file where the image was loaded from, such as the number of images in a multi-image file like a Multi-TIFF.

        • ImageIndex

          This read-only property returns the index of the currently loaded image within the multi-image file.

        • ImageType

          This read-only property returns the type of the currently loaded image.

        • JPGQuality

          This property specifies the default value for saving JPG images. This value is shared by all image objects running within the same application and is used as long as the JPGQuality parameter was not used.

        • LDFEnabled

          This read-only property returns if the Lura document format is available.

        • LDFLayer

          This property sets or returns the current Lura document layer for the image object.

        • LDFSettings

          This property sets or returns the settings object for the Lura document object.

        • Modified

          This property sets or returns the modified state of the image, which is changed by methods like Rotate or ChangePixelDepth.

        • TIFFForceSngStrip

          This property controls the saving of TIFF files.

        • TiffTagCount

          This read-only property returns the number of user defined TIFF tags in the current image.

        • TiffTagDouble

          This read-only property returns the TIFF tag value of type double of the TIFF tag list specified by the index.

        • TiffTagID

          This read-only property returns the TIFF tag id of the TIFF tag specified by index.

        • TiffTagLong

          This read-only property returns the TIFF tag value of the TIFF tag specified by the index.

        • TiffTagRatDenom

          This read-only property returns the denominator of a rational TIFF tag value of the tag specified by the index.

        • TiffTagRatNum

          This read-only property returns the numerator of a rational TIFF tag value of the tag specified by index.

        • TiffTagString

          This read-only property returns the TIFF tag string value of the TIFF tag specified by index.

        • TiffTagType

          This read-only property returns the data type of the specified tag in the Tiff file.

        • TiffTagVariant

          This read-only property returns the TIFF tag value of the TIFF tag specified by index.

        • Width

          This read-only property returns the width of the image in pixels.

        • XOffset

          This read-only property returns the X coordinate of the left top in pixel. By default, the value is 0. To change the value, use the Move method.

        • XResolution

          This read-only property returns the horizontal resolution of the image in dots per inch.

        • YOffset

          This read-only property returns the y coordinate of left top in pixels. By default, the value is 0. To change the value, use the Move method.

        • YResolution

          This read-only property returns the vertical resolution of the image in dots per inch.

      • Sample Code

        The following sample code shows the usage of some SCBCroImage features, such as LoadFile, DetectSkew, Rotate, and SaveFile. The results are displayed with SCBCroViewer.

    • Viewer Object SCBCroViewer

      The component SCBCroViewer provides methods and properties to display various objects, such as images, text documents, annotations, or OCR and scanning results.

  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption

SCBCroImage Properties

This object provides the following properties.

  • BitsPerPixel
  • DefaultJPGQuality
  • FileName
  • Height
  • ImageCount
  • ImageIndex
  • ImageType
  • JPGQuality
  • LDFEnabled
  • LDFLayer
  • LDFSettings
  • Modified
  • TIFFForceSngStrip
  • TiffTagCount
  • TiffTagDouble
  • TiffTagID
  • TiffTagLong
  • TiffTagRatDenom
  • TiffTagRatNum
  • TiffTagString
  • TiffTagType
  • TiffTagVariant
  • Width
  • XOffset
  • XResolution
  • YOffset
  • YResolution
footer © Hyland Software, Inc. and its affiliates. All rights reserved.