DocumentType object describes the attributes of a document. More...
#import <kfxKLODocumentType.h>
Instance Methods | |
| (instancetype) | - initWithFieldTypeArray: |
| initWithFieldTypeArray More... | |
Properties | |
| NSString * | typeName |
| Document Type Name. More... | |
| NSString * | displayName |
| Document Type Display Name. More... | |
| NSString * | version |
| Document Type Version. More... | |
| NSArray * | fieldTypes |
| Field type array. More... | |
| KLOdocOrientation | docOrientation |
| Document Orientation. More... | |
| float | docWidth |
| Document Width. More... | |
| float | docHeight |
| Document Height. More... | |
| kfxKEDImagePerfectionProfile *imagePerfectionProfile | DEPRECATED_ATTRIBUTE |
| Image Perfection Profile. More... | |
| kfxKEDBasicSettingsProfile *basicSettingsProfile | DEPRECATED_ATTRIBUTE |
| Basic Settings Profile. More... | |
| KFXImageProcessorConfiguration * | imageProcessorConfiguration |
| Image Processor Configuration. More... | |
| KLOsourceServer | sourceServer |
| Source Server. More... | |
Detailed Description
DocumentType object describes the attributes of a document.
The data contained in an instance of this object describes the attributes of a given Document object. It is initialized with an array of FieldType objects. A DocumentType object must be provided when initializing a Document object. It can be defined at design time or obtained at run time from a server such as KFS or TotalAgility.
Serialization**
This class adopts the NSCoding protocol so that this object may be archived and unarchived using the iOS standard [NSKeyedArchiver archiveRootObject:<object> toFile: archiveFileName]; approach. Using keyed archive files, you can save this object for later use. The library supports backward compatibility, such that as a new version of an app that uses the API in this SDK, includes a newer versions of the SDK libraries that have data model changes, the older archive can still be read by the newer version. However, it is not a design goal to archive and dearchive with forward compatibility, such as decoding an archive on a newer version of the class, using an older library.
Refer to the kfxKEDImage class description, by expanding the class description, that describes how to archive and unarchive objects in this framework that adopt the NSCoding protocol.
You can create keyed archives using NSKeyedArchiver objects and decoded by NSKeyedUnarchiver objects. The framework design uses keyed archives, which differ from sequential archives, in that every value encoded in a keyed archive is given a Kofax unique key name. When you decode an archive, the underlying implementation can use values by name, allowing the unarchive delegate to request values in any order or not at all.
Please refer to the Apple documentation for more information: https://developer.apple.com/library/ios/documentation/cocoa/reference/foundation/Classes/NSCoder_Class/Reference/NSCoder.html
Keyed Archiving** https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedArchiver_Class/Reference/Reference.html#//apple_ref/occ/cl/NSKeyedArchiver
Keyed Unarchiving** https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedUnarchiver_Class/Reference/Reference.html#//apple_ref/occ/instm/NSKeyedUnarchiver
Method Documentation
| - (instancetype) initWithFieldTypeArray: | (NSArray *) | fieldTypeArray |
initWithFieldTypeArray
This method is provided to instantiate this object with an array of field type objects. An example follows:
Property Documentation
|
readwriteatomicretain |
Image Perfection Profile.
This is a reference to the image perfection profile to be used with this document type.
- Deprecated:
- Deprecated in 3.3.
|
readwriteatomicretain |
Basic Settings Profile.
This is a reference to the basic settings profile containing the basic image processing settings (e.g. bit depth, DPI, etc.)
- Deprecated:
- Deprecated in 3.3.
|
readwriteatomicretain |
Document Type Display Name.
This string member variable contains a human-readable Document type name suitable for display in User Interface controls. The default value is nil.
|
readwriteatomicassign |
Document Height.
This member variable specifies the document height in inches. The default value is 0.
|
readwriteatomicassign |
Document Orientation.
This enum variable sets a preferred document orientation to be used when taking a picture. It indicates whether the long or short edge of the document is aligned with the long edge of the viewer. The default value indicates that the long edge is aligned with the long edge of the viewer.
|
readwriteatomicassign |
Document Width.
This member variable specifies the document width in inches. The default value is 0.
|
readatomicretain |
Field type array.
This read-only array contains the field types contained in the document. The contents of this array are used to build an array of Fields when instantiating a Document object.
|
readwriteatomicretain |
Image Processor Configuration.
This is a reference to the image processor configuration settings containing the image processing settings (e.g. bit depth, DPI, IPString, etc.)
|
readwriteatomicassign |
Source Server.
This enum contains the source server that was the source of the document.
|
readwriteatomicretain |
Document Type Name.
This string member variable names the type of document. The default value is nil.
|
readwriteatomicretain |
Document Type Version.
This string member variable identifies the version of the document type. The default value is nil.
The documentation for this class was generated from the following file: