You are here: Programmers Reference > Programmer's Reference > Structures > ClipAttributes Structure

ClipAttributes Structure

The ClipAttributes structure specifies the attributes of a clip including its location on the form and dimension. Many of the attributes are the same as the Clip Attributes dialog in the ScanTools Plus application definition. They are also the same as many of the properties in the ClipHelper Interface. The ClipAttributes structure also contains the ClipRegion

This structure maps to a row in the CLIPS schema rowset.

This structure is not automation compatible, so is not available to scripting.

Valid

ClipHelper.GetImageInfo.method

ClipHelper.GetClip2 method

ClipHelper.GetClipAsStream2 method

ClipHelper.WriteClipToFile2 method

ClipHelper.WriteClipToStream2 method

Format

struct ClipAttributes {

ClipCoordinateSpace ClipCoordinateSpace;

UnitOfMeasure UnitOfMeasure;

ClipRegion ClipRegion;

ClipCompressionMethod CompressionMethod;

ClipDepth ClipDepth;

VARIANT_BOOL CombineWithForm; (see NOTE below)

ClipRotation ClipRotation;

VARIANT_BOOL BitoneEdgeContrastEnhancement; (see NOTE below)

BitoneThresholdType BitoneThresholdType;

long ManualBitoneThreshold;

VARIANT_BOOL EnableBackgroundOffset; (see NOTE below)

long BackgroundOffset;

long JpegQuality;

VARIANT_BOOL Archive; (see NOTE below)

long Tag;

} ClipAttributes;

NOTE: .Net is inconsistent in the way it maps the IDL VARIANT_BOOL. In the case of ClipAttributes, which is a structure, it maps it to System.Int16.

ClipCoordinateSpace

The system for how the location and size for a region of a scannable form are interpreted for the image clip. See ClipHelper.ClipCoordinateSpace property

UnitOfMeasure

The system of measurement used when ClipHelper.ClipCoordinateSpace property is csWorld for the image clip. See ClipHelper.UnitOfMeasure property

ClipRegion

The structure that specifies the location and dimension of a physical rectangular region of a scannable form. See ClipRegion Structure

ClipCompressionMethod

The type of file compression used on the image clip. See ClipHelper.CompressionMethod property

ClipDepth

The color depth of the image clip. See ClipHelper.ClipDepth property

CombineWithForm - VARIANT_BOOL, see NOTE above.

Whether or not to include the background form image with the clip. See ClipHelper.CombineWithForm property

ClipRotation

The rotation of the image clip. See ClipHelper.ClipRotation property

BitoneEdgeContrastEnhancement - VARIANT_BOOL, see NOTE above.

Whether or not to use the Bitone Edge Contrast Enhancement feature of ScanTools Plus software for the clip. ClipHelper.BitoneEdgeContrastEnhancement property

BitoneThresholdType

For Bitone Clips Only; ClipDepth is Bitone: The data type used to control how the bitone point is determined. See ClipHelper.BitoneThresholdType property

ManualBitoneThreshold

For Bitone Clips Only; ClipDepth is Bitone and when ClipHelper.BitoneThresholdType property is dataManualBitone: The bitone threshold point value for this clip. See ClipHelper.ManualBitoneThreshold property

EnableBackgroundOffset - VARIANT_BOOL, see NOTE above.

For 256 Grayscale Clips Only; ClipDepth is 8Bit or 8BitFull: Whether or not to use the Background Offset feature of ScanTools Plus software for this clip. See ClipHelper.EnableBackgroundOffset property

BackgroundOffset

The number to be added to the Upper Grayscale Filter used by ScanTools Plus software. See ClipHelper.Background Offset property

JpegQuality

For Jpeg-encoded compressed TIFFClips Only: The amount of compression used for JPEG-encoded TIFF clips.

Archive - VARIANT_BOOL, see NOTE above.

Use as a solution-specific hint. For example, whether or not this clip should be taken for the purpose of archiving it as a separate graphic (file). See ClipHelper.Archive property

Tag

A unique numeric ID for a clip. See ClipHelper.Tag property

 

 

See Help on Help for additional information on using this help file.

See Scantron Technical Support for additional information on technical support and training options.

See the ScanTools Suite System Requirements for further details on hardware and software requirements.

ScanTools is a suite of products; the specific information you want may appear in the help for a different module. If you don't find what you're looking for here, try one of the following:

 

Scantron Corporation

Customer Service (forms, products, and services):

1-800-SCANTRON (722-6876)

www.scantron.com

Technical Support:

1-800-445-3141

support@scantron.com

Copyright © 1998-2012 Scantron Corporation. All rights reserved. Use permitted only under license. www.scantron.com. No part of the Help or user guides may be reproduced in any form, or by any means, without express permission from Scantron Corporation.

LINKS TO THIRD PARTY SITES

This help system may contain links to third party websites ("Linked Sites"). The Linked Sites are not under the control of Scantron and Scantron is not responsible for the content of any Linked Site, including without limitation any link contained in a Linked Site or any changes or modifications to a Linked Site. Scantron is not responsible for web casting or any other form of transmission received from any Linked Site. Scantron provides Users with the ability to link the Assessment System to the Linked Sites as a convenience to you, and the inclusion of any link does not imply endorsement by Scantron of the Linked Site or any association with its operators.