The DocumentTypeR Object is a model that describes the attributes of a document. This object is serializable. More...
Public Member Functions | |
| String | getTypeName () |
| Get the document type description. More... | |
| String | getDisplayName () |
| Get the human-readable document type name suitable for display in user interface controls. More... | |
| String | getVersion () |
| Get the document type version. More... | |
| List< FieldType > | getFieldTypes () |
| Get a copy of the field types array. More... | |
| float | getDocWidth () |
| Get the width of the document in inches. This value can be used to determine the size & aspect ratio of the image capture frame. More... | |
| float | getDocHeight () |
| Get the height of the document in inches. This value can be used to determine the size & aspect ratio of the image capture frame. More... | |
| ImagePerfectionProfile | getImagePerfectionProfile () |
| Get a reference to the image perfection profile that should be used with this document type. More... | |
| BasicSettingsProfile | getBasicSettingsProfile () |
| Get the basic image processing settings that the designer may choose for their document, such as bit depth and DPI. More... | |
| ImageProcessorConfiguration | getImageProcessorConfiguration () |
| Get a reference to the ImageProcessorConfiguration that should be used with this document type. More... | |
| SourceServer | getSourceServer () |
| Get the source server from which the document was obtained. More... | |
Detailed Description
The DocumentTypeR Object is a model that describes the attributes of a document. This object is serializable.
This object can only be obtained at run time from a server such as KFS or TotalAgility. Once obtained, it is read-only and its properties cannot be modified by the application.
Member Function Documentation
| BasicSettingsProfile getBasicSettingsProfile | ( | ) |
Get the basic image processing settings that the designer may choose for their document, such as bit depth and DPI.
- Deprecated:
- Deprecated in SDK 3.3.
Implemented in DocumentType.
| String getDisplayName | ( | ) |
Get the human-readable document type name suitable for display in user interface controls.
Implemented in DocumentType.
| float getDocHeight | ( | ) |
Get the height of the document in inches. This value can be used to determine the size & aspect ratio of the image capture frame.
Implemented in DocumentType.
| float getDocWidth | ( | ) |
Get the width of the document in inches. This value can be used to determine the size & aspect ratio of the image capture frame.
Implemented in DocumentType.
| List<FieldType> getFieldTypes | ( | ) |
Get a copy of the field types array.
Implemented in DocumentType.
| ImagePerfectionProfile getImagePerfectionProfile | ( | ) |
Get a reference to the image perfection profile that should be used with this document type.
- Deprecated:
- Deprecated in SDK 3.3.
Implemented in DocumentType.
| ImageProcessorConfiguration getImageProcessorConfiguration | ( | ) |
Get a reference to the ImageProcessorConfiguration that should be used with this document type.
Implemented in DocumentType.
| SourceServer getSourceServer | ( | ) |
Get the source server from which the document was obtained.
Implemented in DocumentType.
| String getTypeName | ( | ) |
Get the document type description.
Implemented in DocumentType.
| String getVersion | ( | ) |
Get the document type version.
Implemented in DocumentType.
The documentation for this interface was generated from the following file: