You are here: Data Services > Oledb Component > Schema Rowsets > CLIPS Rowset

CLIPS Rowset

Scantron OLE DB Provider Specific. The CLIPS rowset provides information about the clips defined in the ScanTools Plus application definition. The CLIPS rowset reports whole sheet clips, sparse clips, and all potential phantom clips for grids defined using cell and timing mark position. Currently grids defined using other Units of Measure (inches, millimeters, or hybrid) are not included in the CLIPS rowset. However, all clips, including those using other Units of Measure (inches, millimeters, or hybrid) are included in the Clips Table.

It is not an error for this rowset to return empty; this happens if the ScanTools Plus application has no image clips defined for the document(s). The .Net grid control will display an empty rowset as a single row of NULLs. Turn on the Read-only property for the grid to make this go away.

The clips actually taken during scanning are accessed through the Clips table or ClipServer interface. See Clips Table Overview, Clips Table Definition, ClipServer Interface, and SessionInfo.TakePhantomClips property.

GUID: DBSCHEMA_CLIPS

Number of restriction columns: 8

Restriction columns: TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME, COLUMN_NAME, ORDINAL_POSITION, CLIP_NAME, SHEET_NUMBER, ARCHIVE

See Using Restrictions on Schema Rowsets for information about Filtering rows of CLIPS Rowset.

Default sort order: ORDINAL_POSITION

Column name Type indicator Description

TABLE_CATALOG

DBTYPE_WSTR

NULL

TABLE_SCHEMA

DBTYPE_WSTR

NULL

TABLE_NAME

DBTYPE_WSTR

Table name. This cannot be NULL.

COLUMN_NAME

DBTYPE_WSTR

The name of the associated column. This cannot be NULL.

CLIP_NAME

DBTYPE_WSTR

The name of the clip; if present, this must be unique. May be NULL.

CLIP_ID

DBTYPE_UI4

Uniquely identifies clip within document

CHILD_ID

DBTYPE_UI4

ID of a child (phantom) clip associated with the CLIP ID in the above column. If CHILD_ID is non-zero then the clip is a phantom and does not actually contain data but is instead used during online edit correction. If the CHILD_ID is zero then the clip is a regular (non-phantom) clip.

ORDINAL_POSITION

DBTYPE_UI4

One-based ordinal of the clip.

DATA_OFFSET

DBTYPE_UI4

Applies within the column specified by COLUMN_NAME

DATA_LENGTH

DBTYPE_UI4

Applies within the column specified by COLUMN_NAME

SHEET_NUMBER

DBTYPE_UI4

The ordinal of the sheet in the document; starts from 1.

SIDE_OF_SHEET

DBTYPE_UI4

See SideOfSheet enumeration.

ARCHIVE

DBTYPE_BOOL

VARIANT_TRUE—The clip is flagged for archive.
VARIANT_FALSE—The clip is for edit.

COMBINE_WITH_FORM

DBTYPE_BOOL

VARIANT_TRUE—The clip may be combined with the form.
VARIANT_FALSE—The clip may not be combined with the form.

COMPRESSION

DBTYPE_UI4

See ClipCompressionMethod enumeration.

ROTATION

DBTYPE_UI4

See ClipRotation enumeration.

BITDEPTH

DBTYPE_UI4

See ClipDepth enumeration.

DESCRIPTION

DBTYPE_WSTR

Human-readable description of the clip. May be Null.

CELL

DBTYPE_I4

Starting cell - this is 1-based.

TIMING_MARK

DBTYPE_I4

Starting timing mark - this is 1-based.

CELL_SPAN

DBTYPE_I4

Number of cells spanned by clip

TIMING_MARK_SPAN

DBTYPE_I4

Number of timing marks spanned by clip

COMPRESSION_DISPLAY

DBTYPE_WSTR

Human readable form of the compression method

JPEG_QUALITY

DBTYPE_I4

For JPEG clips, the quality setting used

BITONE_THRESHOLD_TYPE

DBTYPE_I4

Bitone method used

See BitoneThresholdType enumeration.

MANUAL_BITONE_THRESHOLD

DBTYPE_I4

If the bitone method is manual, the threshold used.

BITONE_EDGE_CONTRAST_ENHANCEMENT

DBTYPE_BOOL

If true, bitone edge enhancement is used

ENABLE_BACKGROUND_OFFSET

DBTYPE_BOOL

If true, BACKGROUND_OFFSET value is used

BACKGROUND_OFFSET

DBTYPE_I4

Amount to add to the white point when displaying a grayscale clip

ROTATION_DISPLAY

DBTYPE_WSTR

Human readable description of the rotation value

BITDEPTH_DISPLAY

DBTYPE_WSTR

Human readable description of the bit depth value

BITONETHRESHOLD_DISPLAY

DBTYPE_WSTR

Human readable description of the bitone method

 

 

 

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.