The DocumentType object is a model that describes the attributes of a document. This object is serializable. More...
Classes | |
| enum | SourceServer |
| An enum that identifies the source server from which the document was obtained. More... | |
Public Member Functions | |
| DocumentType | clone () |
| DocumentType (List< FieldType > fieldTypes) | |
| String | getTypeName () |
| Get the document type description. More... | |
| void | setTypeName (String typeName) |
| Set the document type description. More... | |
| String | getDisplayName () |
| Get the human-readable document type name suitable for display in user interface controls. More... | |
| void | setDisplayName (String displayName) |
| Set the human-readable document type name suitable for display in user interface controls. More... | |
| String | getVersion () |
| Get the document type version. More... | |
| void | setVersion (String version) |
| Set 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... | |
| void | setDocWidth (float docWidth) |
| Set 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... | |
| void | setDocHeight (float docHeight) |
| Set 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... | |
| void | setImagePerfectionProfile (ImagePerfectionProfile imagePerfectionProfile) |
| Set 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... | |
| void | setBasicSettingsProfile (BasicSettingsProfile basicSettingsProfile) |
| Set 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... | |
| void | setImageProcessorConfiguration (ImageProcessorConfiguration imageProcessorConfiguration) |
| Set 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... | |
| void | setSourceServer (SourceServer sourceServer) |
| Set the source server from which the document was obtained. More... | |
Detailed Description
The DocumentType object is a model that describes the attributes of a document. This object is serializable.
This object can be defined at design time or obtained at run time from a server such as KFS or TotalAgility.
DocumentType objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.
Constructor & Destructor Documentation
| DocumentType | ( | List< FieldType > | fieldTypes | ) |
This object is instantiated with an array of FieldType, which becomes the fieldTypes read-only property. Once instantiated, the fieldTypes property cannot be modified by the application.
Member Function Documentation
| DocumentType clone | ( | ) |
| 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.
Implements DocumentTypeR.
| String getDisplayName | ( | ) |
Get the human-readable document type name suitable for display in user interface controls.
Implements DocumentTypeR.
| 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.
Implements DocumentTypeR.
| 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.
Implements DocumentTypeR.
| List<FieldType> getFieldTypes | ( | ) |
Get a copy of the field types array.
Implements DocumentTypeR.
| ImagePerfectionProfile getImagePerfectionProfile | ( | ) |
Get a reference to the image perfection profile that should be used with this document type.
- Deprecated:
- Deprecated in SDK 3.3.
Implements DocumentTypeR.
| ImageProcessorConfiguration getImageProcessorConfiguration | ( | ) |
Get a reference to the imageProcessorConfiguration that should be used with this document type.
Implements DocumentTypeR.
| SourceServer getSourceServer | ( | ) |
Get the source server from which the document was obtained.
Implements DocumentTypeR.
| String getTypeName | ( | ) |
Get the document type description.
Implements DocumentTypeR.
| String getVersion | ( | ) |
Get the document type version.
Implements DocumentTypeR.
| void setBasicSettingsProfile | ( | BasicSettingsProfile | basicSettingsProfile | ) |
Set 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.
| void setDisplayName | ( | String | displayName | ) |
Set the human-readable document type name suitable for display in user interface controls.
| void setDocHeight | ( | float | docHeight | ) |
Set the height of the document in inches. This value can be used to determine the size & aspect ratio of the image capture frame.
| void setDocWidth | ( | float | docWidth | ) |
Set the width of the document in inches. This value can be used to determine the size & aspect ratio of the image capture frame.
| void setImagePerfectionProfile | ( | ImagePerfectionProfile | imagePerfectionProfile | ) |
Set a reference to the image perfection profile that should be used with this document type.
- Deprecated:
- Deprecated in SDK 3.3.
| void setImageProcessorConfiguration | ( | ImageProcessorConfiguration | imageProcessorConfiguration | ) |
Set a reference to the imageProcessorConfiguration that should be used with this document type.
| void setSourceServer | ( | SourceServer | sourceServer | ) |
Set the source server from which the document was obtained.
| void setTypeName | ( | String | typeName | ) |
Set the document type description.
| void setVersion | ( | String | version | ) |
Set the document type version.
The documentation for this class was generated from the following file: