Classes
class	Blobs
	An array of blobs. More...

class	DefaultSignDocCaptureListener
	Implementation of SignDocCaptureListener providing default implementations of gotSample(), gotEvent(), and gotError(). More...

class	Point
	A point (document coordinates or canvas coordinates depending on context). More...

class	Rect
	A rectangle (document coordinates). More...

class	SignDocAnnotation
	An annotation. More...

class	SignDocAttachment
	Output of SignDocDocument.getAttachment(). More...

class	SignDocCapture
	Capture signatures. More...

interface	SignDocCaptureDevice
	Interface for a capture device. More...

interface	SignDocCaptureDisplay
	Interface for displaying a background image and painting strokes while capturing. More...

class	SignDocCaptureDisplayControl
	A Windows Forms SignDocCaptureDisplay. More...

interface	SignDocCaptureDisplayEventListener
	Interface reporting resize and move events for GUI elements. More...

class	SignDocCaptureFilters

interface	SignDocCaptureListener
	Interface for receiving captured samples and other events. More...

class	SignDocCaptureOutput
	Output of SignDocCapture.waitCapture(). More...

class	SignDocCaptureParameters
	Parameters for SignDocCapture.startCapture(). More...

class	SignDocCaptureResult
	Result of SignDocCapture.waitCapture2(). More...

class	SignDocCaptureTransformation
	Return value of SignDocCaptureDevice.getTransformation(). More...

class	SignDocCaptureVirtualButton
	A button. More...

class	SignDocChange
	A single change made to a PDF document after a signature. More...

class	SignDocCheckSignatureParameters
	Parameters for SignDocSignatureData.checkReference() and SignDocSignatureData.checkSignature(). More...

class	SignDocCleanParameters
	Actions and parameters for SignDocImage.clean(). More...

class	SignDocColor
	A color. More...

class	SignDocDocument
	An interface for SignDoc documents. More...

class	SignDocDocumentLoader
	Create SignDocDocument objects. More...

class	SignDocField
	One field of a document. More...

class	SignDocFindTextOccurrence
	Position of a hit returned by SignDocDocument.findText(). More...

class	SignDocImage
	A bitmap image. More...

class	SignDocImageParameters
	Parameters for saving images, converting images to bi-level images, and rendering biometric signatures as images. More...

class	SignDocImagePoint
	Coordinates of a point for use with SignDocImage and other classes that use integer coordinates. More...

class	SignDocImageRect
	A rectangle for use with SignDocImage. More...

class	SignDocMatchParameters
	Parameters for SignDocSignatureData.matchSignature(), SignDocSignatureData.matchReference(), SignDocImage.matchSignature(), and SignDocImage.matchReference(). More...

class	SignDocMatchResult
	Result of SignDocSignatureData.matchSignature(), SignDocSignatureData.matchReference(), SignDocImage.matchSignature(), and SignDocImage.matchReference(). More...

class	SignDocOutputStream
	SignDoc Output Stream. More...

class	SignDocProperty
	One property, without value. More...

class	SignDocRenderOutput
	Output of SignDocDocument.renderPageAsImage(), SignDocDocument.renderPageAsSignDocImage(), and SignDocSignatureData.renderAsImage(). More...

class	SignDocRenderParameters
	Parameters for SignDocDocument.renderPageAsImage() and SignDocDocument.renderPageAsSignDocImage(). More...

class	SignDocSignature
	Information about a signature field returned by SignDocDocument.getSignature(). More...

class	SignDocSignatureData
	Biometric data of handwritten signatures. More...

class	SignDocSignatureParameters
	Parameters for signing a document. More...

class	SignDocSignatureSample
	A single sample of the biometric data of a handwritten signature. More...

class	SignDocTextCluster
	A cluster of Unicode code points and glyphs. More...

class	SignDocTextFieldAttributes
	Attributes of a text field, list box field or combo box field used for the construction of the appearance (PDF documents only). More...

class	SignDocTextIterator
	An iterator for the text of a document. More...

class	SignDocVerificationParameters
	Parameters for verifying a certificate chain. More...

class	SignDocVerificationResult
	Information about a signature field returned by SignDocDocument.verifySignature() or SignDocDocument.verifySignature2(). More...

class	SignDocWatermark
	Parameters for a watermark. More...

class	SignDocWeightedFrame
	A frame and its weight. More...

interface	SignECDSA
	Interface for creating an ECDSA signature. More...

interface	SignPKCS7
	Interface for creating a PKCS #7 or CAdES signature. More...

interface	SignRSA
	Interface for creating an RSA signature. More...

interface	Source
	Data source. More...

class	TimeStamper
	Interface for creating an RFC 3161 timestamp (HTTP client). More...

interface	UserTimeStamper
	Interface for user-provided timestamping. More...

Enumerations
enum	ReturnCode { OK, InvalidArgument, FieldNotFound, InvalidProfile, InvalidImage, TypeMismatch, FontNotFound, NotSupported, IoError, NotVerified, PropertyNotFound, PageNotFound, WrongCollection, FieldExists, LicenseError, UnexpectedError, Cancelled, NoBiometricData, FieldNotSigned, InvalidSignature, AnnotationNotFound, AttachmentNotFound, AttachmentExists, NoCertificate, AmbiguousCertificate, NotAllowed, InvalidStructure, UnknownParameter, InvalidValue, NotAvailable, NoCaptureDevice, WrongState }
	Return code. More...

enum	ColorType { Gray, RGB }
	Type of color. More...

enum	AnnotationType { Unknown, Line, Scribble, FreeText }
	Annotation types. More...

enum	LineEnding { Unknown, None, Arrow }
	Line ending styles. More...

enum	AnnotationHAlignment { Left, Center, Right }
	Horizontal alignment of text in an annotation. More...

enum	AnnotationFlags { Zero = 0, AutoAlignment, LTR, RTL, DefaultLTR, DefaultRTL }
	Flags for SignDocAnnotation.setFlags(). More...

enum	FieldType { Unknown, Pushbutton, CheckBox, RadioButton, Text, ListBox, SignatureDigSig, SignatureSignDoc, ComboBox }
	Field types. More...

enum	FieldFlags { Zero = 0, ReadOnly, Required, NoExport, NoToggleToOff, Radio, Pushbutton, RadiosInUnison, MultiLine, Password, FileSelect, DoNotSpellCheck, DoNotScroll, Comb, RichText, Combo, Edit, Sort, MultiSelect, CommitOnSelChange, SinglePage, EnableAddAfterSigning, Invisible }
	Field flags. More...

enum	WidgetFlags { Zero = 0, Invisible, Hidden, Print, NoZoom, NoRotate, NoView, ReadOnly, Locked, ToggleNoView, LockedContents }
	Annotation flags of a widget. More...

enum	FieldJustification { None, Left, Center, Right }
	Justification of text fields and list boxes. More...

enum	FieldBorderStyle { Other, Solid, Dashed, Beveled, Inset, Underline }
	Border style. More...

enum	FieldButtonStyle { Default, Other, CheckMark, Cross, Star, Circle, Square, Diamond }
	Style used for check boxes and radio buttons. More...

enum	LockType { NA, None, All, Include, Exclude }
	Fields to be locked when signing this signature field. More...

enum	SignatureType { NotASignatureField, NotSigned, Approval, Certification, DocumentTimeStamp }
	Signature type. More...

enum	CertSeedValueFlags { Zero = 0, SubjectCert, IssuerCert, Policy, SubjectIDN, KeyUsage, URL }
	Bit masks for SignDocField.getCertSeedValueFlags() and SignDocField.setCertSeedValueFlags(). More...

enum	WatermarkJustification { Left, Center, Right }
	Justification of multi-line text of a watermark. More...

enum	WatermarkLocation { Overlay, Underlay }
	Location of watermark. More...

enum	WatermarkHAlignment { Left, Center, Right }
	Horizontal alignment of a watermark. More...

enum	WatermarkVAlignment { Top, Center, Bottom }
	Vertical alignment of a watermark. More...

enum	WatermarkFlags { Zero = 0, LTR, RTL, DefaultLTR, DefaultRTL }
	Flags for SignDocWatermark.setFlags(). More...

enum	PropertyType { String, Integer, Boolean }
	Property types. More...

enum	RenderParameterType { Undefined, Boolean, Integer, Number, String, String2 }
	Return values of SignDocRenderParameters.getType(). More...

enum	GetChangeFlags { Zero = 0, All, DSS }
	Flags for SignDocSignature.getChangeCount2(). More...

enum	ChangeType { Other, FieldAdded, FieldRemoved, FieldModified, FieldFilledIn, AnnotationAdded, AnnotationRemoved, AnnotationModified, AttachmentAdded, AttachmentRemoved, AttachmentModified, PageAdded, PageRemoved, PageModified, SignatureAdded, DTSAdded, DSSModified }
	Type of change. More...

enum	CheckSignatureParameterType { Undefined, Boolean, Integer }
	Return values of SignDocCheckSignatureParameters.getType(). More...

enum	CleanParameterType { Undefined, Boolean, Integer, Number, Void }
	Return values of SignDocCleanParameters.getType() and SignDocCleanParameters.getTypeAt(). More...

enum	ImageParameterType { Undefined, Boolean, Integer, Number, String, Color }
	Return values of SignDocImageParameters.getType(). More...

enum	MatchParameterType { Undefined, Boolean, Integer }
	Return values of SignDocMatchParameters.getType(). More...

enum	SignatureParameterType { Undefined, Integer, String, Color, Blob, Length }
	Return values of SignDocSignatureParameters.getType(). More...

enum	SigningMethod { Default, DigSigPKCS1, DigSigPKCS7Detached, DigSigPKCS7SHA1, Hash, DigSigCadesDetached, DigSigCadesRFC3161 }
	Signing methods. More...

enum	SigningMethodFlags { Zero = 0, DigSigPKCS1 = (1 << static_cast<int>(SigningMethod.DigSigPKCS1)), DigSigPKCS7Detached = (1 << static_cast<int>(SigningMethod.DigSigPKCS7Detached)), DigSigPKCS7SHA1 = (1 << static_cast<int>(SigningMethod.DigSigPKCS7SHA1)), Hash = (1 << static_cast<int>(SigningMethod.Hash)), DigSigCadesDetached = (1 << static_cast<int>(SigningMethod.DigSigCadesDetached)), DigSigCadesRFC3161 = (1 << static_cast<int>(SigningMethod.DigSigCadesRFC3161)) }
	Bit masks for SignDocSignatureParameters.getAvailableMethods(). More...

enum	AddCertificates { All, None, Trusted }
	Values for integer parameter "AddCertificates" of SignDocSignatureParameters. More...

enum	AddRevocationInfo { Add }
	Flags for integer parameter "AddRevocationInfo" of SignDocSignatureParameters. More...

enum	RemoveXFA { Always, IfAllowed, Never }
	Values for integer parameter "RemoveXFA" of SignDocSignatureParameters. More...

enum	Optimize { Yes, No, IfPossible }
	Optimization of document before signing. More...

enum	PDFAButtons { Freeze, DontFreeze, Auto }
	Fix appearance streams of check boxes and radio buttons for PDF/A-1 without Technical Corrigendum 2. More...

enum	BiometricEncryption { RSA, Fixed, Binary, Passphrase, DontStore }
	Select how to encrypt the biometric data. More...

enum	BiometricHashLocation { Attr, Contents }
	Select where to store the message digest computed over the document hash and the unencrypted biometric data. More...

enum	SignatureParametersHAlignment { Left, Center, Right, Justify, Auto, Default }
	Horizontal alignment. More...

enum	SignatureParametersVAlignment { Top, Center, Bottom }
	Vertical alignment. More...

enum	TextPosition { Overlay, Below, Underlay, RightOf, Above, LeftOf }

enum	LengthType { Abs, FieldHeight, FieldWidth }
	Indicate how measurements are specified. More...

enum	TextGroup { Primary, Secondary, Master = Primary, Slave = Secondary }
	Text groups. More...

enum	TextItemDirection { LTR, RTL, DefaultLTR, DefaultRTL }
	Paragraph direction of a text item. More...

enum	IgnoreSeedValues { Zero = 0, SubFilter, DigestMethod }
	Flags for ignoring mandatory requirements specified by the signature seed value dictionary. More...

enum	CertificateSelectionFlags { Zero = 0, Software, Hardware, UseCertificateSeedValues, AskIfAmbiguous, NeverAsk, CreateSelfSigned }
	Flags for selecting certificates. More...

enum	RenderSignatureFlags { Zero = 0, BW, Gray, Antialias, LimitSize }
	Flags for rendering the signature. More...

enum	ImageTransparency { Opaque, Brightest }
	Transparency of signature image. More...

enum	VerificationParameterType { Undefined, Integer, String, Blob }
	Return values of SignDocVerificationParameters.getType(). More...

enum	CertificateChainVerificationPolicy { DontVerify, AcceptSelfSigned, AcceptSelfSignedWithBio, AcceptSelfSignedWithRSABio, RequireTrustedRoot }
	Values for integer parameter "CertificateChainVerificationPolicy" of SignDocVerificationParameters. More...

enum	CertificateRevocationVerificationPolicy { DontCheck, Offline, Online }
	Values for integer parameter "CertificateRevocationVerificationPolicy" of SignDocVerificationParameters. More...

enum	VerificationFlags { Zero = 0, CheckRevocation, UseCRLOnly, UseOCSPOnly, Offline, EnforceNextUpdate, EnforceOCSPSigner, Online, NoOCSPNonce, CRLFirst, IgnoreNoRevocation, OCSPUseCurrentTime }
	Flags for certificate verification. More...

enum	VerificationModel { Minimal, Chain, ModifiedShell, Shell }
	Values for integer parameter "VerificationModel" of SignDocVerificationParameters. More...

enum	SignatureState { Unmodified, DocumentExtended, DocumentModified, UnsupportedSignature, InvalidCertificate, Empty }
	State of a signature. More...

enum	ModificationState { Unmodified, Allowed, Prohibited }
	Modification state of the document for a certain signature. More...

enum	TimeStampState { Valid, Missing, Invalid }
	State of the RFC 3161 time stamp. More...

enum	CertificateChainState { OK, BrokenChain, UntrustedRoot, CriticalExtension, NotTimeValid, PathLength, Invalid, Error }
	Certificate chain state for SignDocVerificationResult.verifyCertificateChain() and SignDocVerificationResult.verifyTimeStampCertificateChain(). More...

enum	CertificateRevocationState { OK, NotChecked, Offline, Revoked, Error }
	Certificate revocation state for SignDocVerificationResult.getCertificateRevocationState() and SignDocVerificationResult.getTimeStampCertificateRevocationState(). More...

enum	GetBoundingBoxesFlags { Zero = 0, Single, Individual, Logical }
	Flag for FindTextOccurrence.getBoundingBoxes(). More...

enum	DocumentType { Unknown, PDF, TIFF, Other, FDF }
	Supported document types. More...

enum	SaveFlags { Zero = 0, Incremental, RemoveUnused, Linearized, PDF_1_4, PDFAButtons, AutoIncremental }
	Flags modifying the behavior of SignDocDocument.saveToFile(), SignDocDocument.saveToMemory(), and SignDocDocument.saveToStream(). More...

enum	CopyToStreamFlags { Zero = 0, Unsaved }
	Flags modifying the behavior of SignDocDocument.copyToStream() and SignDocDocument.copyToMemory(). More...

enum	SetFieldFlags { Zero = 0, FontFail, Move, KeepAP, UpdateAP, FitHeightOnly, ForceBorderWidth, DontBreakLines, AutoAlignment, LTR, RTL, DefaultLTR, DefaultRTL }
	Flags modifying the behavior of SignDocDocument.setField(), SignDocDocument.addField(), and SignDocDocument.applyFdf(). More...

enum	FlattenFieldsFlags { Zero = 0, IncludeSignatureUnsigned, IncludeSignatureSigned, IncludeHidden, KeepStructure }
	Flags modifying the behavior of SignDocDocument.flattenFields(). More...

enum	FlattenAnnotationsFlags { Zero = 0, IncludeHidden, KeepStructure }
	Flags modifying the behavior of SignDocDocument.flattenAnnotations(). More...

enum	FindTextFlags { Zero = 0, IgnoreHSpace, IgnoreHyphenation, IgnoreSequence }
	Flags modifying the behavior of SignDocDocument.findText(). More...

enum	CreateTextIteratorFlags { Zero = 0 }
	Flags modifying the behavior of SignDocDocument.createTextIterator(). More...

enum	ExportFlags { Zero = 0, Top }
	Flags modifying the behavior of SignDocDocument.exportFields(), SignDocDocument.exportFieldsToMemory(), SignDocDocument.exportProperties(), and SignDocDocument.exportPropertiesToMemory(). More...

enum	ImportFlags { Zero = 0, Atomic }
	Flags modifying the behavior of SignDocDocument.importProperties() and SignDocDocument.importPropertiesFromMemory(). More...

enum	ImportPagesFlags { Zero = 0 }
	Flags modifying the behavior of SignDocDocument.importPages(). More...

enum	AddAttachmentFlags { Zero = 0 }
	Flags modifying the behavior of SignDocDocument.addAttachmentBlob() and SignDocDocument.addAttachmentFile(). More...

enum	ImportImageFlags { Zero = 0, KeepAspectRatio, BrightestTransparent }
	Flags modifying the behavior of SignDocDocument.addImageFromFile(), SignDocDocument.addImageFromFile2(), SignDocDocument.addImageFromMemory(), SignDocDocument.addImageFromMemory2(), SignDocDocument.importPageFromImageBlob(), SignDocDocument.importPageFromImageBlob2(), SignDocDocument.importPageFromImageFile(), and SignDocDocument.importPageFromImageFile2(). More...

enum	KeepOrRemove { Keep, Remove }
	Tell SignDocDocument.removePages() to keep or to remove the specified pages. More...

enum	CheckAttachmentResult { Match, NoChecksum, Mismatch }
	Result of SignDocDocument.checkAttachment(). More...

enum	DocumentHAlignment { Left, Center, Right, Auto }
	Horizontal alignment for SignDocDocument.addTextRect() and SignDocDocument.addTextRect2(). More...

enum	DocumentVAlignment { Top, Center, Bottom }
	Vertical alignment for SignDocDocument.addTextRect() and SignDocDocument.addTextRect2(). More...

enum	AddTextFlags { Zero = 0 }
	Flags for SignDocDocument.addText() and SignDocDocument.addText2(). More...

enum	AddTextRectFlags { Zero = 0, Compat, LTR, RTL, DefaultLTR, DefaultRTL }
	Flags for SignDocDocument.addTextRect() and SignDocDocument.addTextRect2(). More...

enum	CreateAppearancesFlags { Zero = 0 }
	Flags for SignDocDocument.createAppearances(). More...

enum	RemoveFlags { Zero = 0 }
	Flags for SignDocDocument.removeLogicalStructure(), SignDocDocument.removePDFA(), SignDocDocument.removePDFUA(), SignDocDocument.removePermissions(), and SignDocDocument.removeXFA(). More...

enum	PrepareForSigningFlags { Zero = 0 }
	Flags for SignDocDocument.prepareForSigning(). More...

enum	DocumentFlags { Zero = 0, RelaxByteRange, AmbiguousButtonValueEmpty, UseDSSOnly, NoKerningForStandardFonts, KeepEscapeSequences, RequireAlternateFieldName, RequireLang, InsertAtEnd, UseEscapeSequences, FailForBrokenTargetStructure, NoActualText, DontAddDADR, AutoRemovePermissions }
	Flags for SignDocDocument.setFlags(). More...

enum	ShootInFootFlags { Zero = 0, AllowBreakingSignatures, AllowBreakingPermissions, AllowInvalidCertificate, AllowNonStandardExternalFonts, AssumeAPNotShared, AssumeAPShared, DontVerifyAfterSigning, AllowAllCurves, AllowBreakingTaggedPDF }
	Flags for SignDocDocument.setShootInFoot(). More...

enum	UpdateDSSFlags { Zero = 0, Simulate, VRI }
	Flags for SignDocDocument.updateDSS() and SignDocDocument.updateDSS2(). More...

enum	FieldTypeFlags { Zero = 0, Pushbutton = (1 << static_cast<int>(FieldType.Pushbutton)), CheckBox = (1 << static_cast<int>(FieldType.CheckBox)), RadioButton = (1 << static_cast<int>(FieldType.RadioButton)), Text = (1 << static_cast<int>(FieldType.Text)), ListBox = (1 << static_cast<int>(FieldType.ListBox)), SignatureDigSig = (1 << static_cast<int>(FieldType.SignatureDigSig)), SignatureSignDoc = (1 << static_cast<int>(FieldType.SignatureSignDoc)), ComboBox = (1 << static_cast<int>(FieldType.ComboBox)) }
	Bitmasks for SignDocDocument.getFields() and SignDocDocument.getFieldsOfPage(). More...

enum	DocumentLoaderFlags { Zero = 0, MapIntoMemory, DontCreateAppearances, SpeedUp, KeepNeedAppearances }
	Flags for SignDocDocumentLoader.setFlags(). More...

enum	RemainingDays { Product, Signing }
	Specify which expiry date shall be used by SignDocDocumentLoader.getRemainingDays(). More...

enum	MatchParametersFlags { Zero = 0, EngineAuto, EngineStatic, EngineDynamic, EngineDStat, NormalizeSampleRates, Mirror, KeepResolution }
	Flags for integer parameter "%Flags" of SignDocMatchParameters. More...

enum	SignatureDataType { Empty, Signature, Reference }
	Type of handwritten signatures stored in a SignDocSignatureData object. More...

enum	SignatureDataFormat { Zero = 0, iso_mask_single, iso_mask_wrapper, iso_mask_bdb, iso_mask_data, iso_mask_flags, softpro, iso_19785_3_none, iso_19785_3_format2, iso_19785_3_format3, iso_19785_3_format6, iso_19794_7_2007tc1, iso_19794_7_2014, iso_19794_7_2021, iso_19794_7_full, iso_flag_meters, iso_flag_no_fix, iso_flag_compat1, iso_flag_no_ext_data }
	Blob format flags for SignDocSignatureData. More...

enum	CaptureDevice { Unknown = 0, Intuos = 1, MobiNetix = 2, Graphire = 3, BSHesy = 4, PL400 = 5, EPOS = 6, ESig = 7, EInk = 8, PenPartner = 9, TabletPC = 10, StepOver = 11, EID = 12, MTLCD = 13, MTLPD = 14, EPAD2 = 15, BlueM = 16, BlueMLCD = 17, TzSE = 18, EPadLS = 19, EInk2 = 20, EID2 = 21, SignPad = 22, Bamboo = 23, VerifoneMX = 24, IngenicoSC350 = 25, DTU = 26, IPad = 501, IPhone = 502, IPod = 503, OlivettiZPadB8001 = 510, SamsungGTN7000 = 511, HTCP510e = 512, AndroidTouch = 513, HTML5Capture = 514, OlivettiGraphosA10 = 515, ENSign10 = 1000, VPSign = 1001, UserFirst = 10000, UserLast = 10999 }
	Capture device identifiers. More...

enum	TimeStamperStampResult { OK, InvalidInput, Timeout, Stopped, TCPError, SSLError, HTTPError, ServerError, InvalidResponse }
	Return value of TimeStamper.stamp(). More...

enum	TimeStamperStampFlags { Zero = 0, DontCheckRevocation, DontHash }
	Flags for TimeStamper.stamp(). More...

enum	UserTimeStamperFlags { Zero = 0, GetSize }
	Flags for UserTimeStamper.stamp(). More...

enum	UserTimeStamperResult { OK, InvalidArgument, Timeout, Stopped, Error }
	Return value of UserTimeStamper.stamp(). More...

enum	CaptureParameterType { Undefined, Boolean, Integer, Number, String, Color, Blob }
	Return values of SignDocCaptureParameters.getType(). More...

enum	CaptureDeviceState { Idle, Connected, Capturing }
	Capture device state for "State" of SignDocCaptureDevice.getDeviceInteger(). More...

enum	SerialNumberType { Zero = 0, UID, UID2, ESerial, PNPId, Legacy, Unknown, GenericBinary, GenericASCII }
	Type of serial number for SignDocSignatureData.getDeviceSerialNumber(), SignDocSignatureData.getDeviceSerialNumberTypes(), SignDocSignatureData.setDeviceSerialNumber(), SignDocCaptureDevice.getSerialNumber(), and "SerialNumberTypes" of SignDocCaptureDevice.getDeviceInteger(). More...

enum	CaptureDisplayType { None, Dedicated, Managed }
	Type of a capture device's display, returned by SignDocCaptureDevice.getDeviceInteger("DisplayType"). More...

enum	CaptureCoordinateSystem { Digitizer, Capture, Window, Image, Per1000 }
	Coordinate system for buttons and the clipping area. More...

enum	CaptureListenerReturnValue { NotImplemented = -1, Continue, End, Ignore }
	Return values of SignDocCaptureListener.gotSample(). More...

enum	CaptureEvent { Error, Timeout, VirtualButton, HardwareButton, Callback, UiButton, Closed }
	Events that terminate capture. More...

Enumeration Type Documentation

enum AddAttachmentFlags

strong

Flags modifying the behavior of SignDocDocument.addAttachmentBlob() and SignDocDocument.addAttachmentFile().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.

enum AddCertificates

strong

Values for integer parameter "AddCertificates" of SignDocSignatureParameters.

See also: SignDocSignatureParameters.setInteger()

Enumerator

All

Include all intermediate certificates and the root certificate.

This requires building at signing time the complete certificate chain up to a self-signed certificate. It does not matter whether that self-signed certificate is a trusted root CA certificate or not.

None

Do not include any certificates.

It is assumes that the signing certificate is a self-signed certificate or all intermediate certificates are available at verification time.

Trusted

Include all intermediate certificates and the root certificate, require the root certificate to be trusted.

This requires building at signing time the complete certificate chain up to a self-signed certificate. That self-signed certificate must be trusted, otherwise signing will fail.

enum AddRevocationInfo

strong

Flags for integer parameter "AddRevocationInfo" of SignDocSignatureParameters.

See also: SignDocSignatureParameters.setInteger()

Enumerator
Add	Add revocation data. This requires building at signing time the complete certificate chain up to a self-signed certificate. It does not matter whether that self-signed certificate is a trusted root CA certificate or not.

enum AddTextFlags

strong

Flags for SignDocDocument.addText() and SignDocDocument.addText2().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.

enum AddTextRectFlags

strong

Flags for SignDocDocument.addTextRect() and SignDocDocument.addTextRect2().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
Compat	Behave like addTextRect() of SignDoc SDK 4.2.0.8 and earlier. If this flag is set, any sequence of CR and LF characters in the text starts a new paragraph (ie, text following such a sequence will be placed at the beginning of the next output line). In consequence, empty lines in the input do not produce empty lines in the output. To get an empty line in the output, you have to add a paragraph containing a non-breaking space (U+00A0) only: "Line before empty line\n\xa0\nLine after empty line" Moreover, lines can be broken only at a space character (U+0020). If this flag is not set, the rules of UAX #14 will be used. In particular, CR, LF, and CR LF start a new paragraph and lines can be broken after punctuation.
LTR	Paragraph direction: LTR. If none of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL is set, AddTextRectFlags.LTR will be used. At most one of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL can be set.
RTL	Paragraph direction: RTL. If none of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL is set, AddTextRectFlags.LTR will be used. At most one of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL can be set. This flag will be ignored if AddTextRectFlags.Compat is set.
DefaultLTR	Choose direction automatically, default to LTR. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 0 (LTR) for paragraphs having no strong directional character. If none of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL is set, AddTextRectFlags.LTR will be used. At most one of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL can be set. This flag will be ignored if AddTextRectFlags.Compat is set.
DefaultRTL	Choose direction automatically, default to RTL. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 1 (RTL) for paragraphs having no strong directional character. If none of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL is set, AddTextRectFlags.LTR will be used. At most one of AddTextRectFlags.LTR, AddTextRectFlags.RTL, AddTextRectFlags.DefaultLTR, and AddTextRectFlags.DefaultRTL can be set. This flag will be ignored if AddTextRectFlags.Compat is set.

enum AnnotationFlags

strong

Flags for SignDocAnnotation.setFlags().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
AutoAlignment	Align left if the text begins with an LTR run, align right if the text begins with an RTL run. This flag overrides for creating the appearance stream AnnotationHAlignment.Left and AnnotationHAlignment.Right passed to aHAlignment of SignDocAnnotation.setPlainText(). This flag is ignored for AnnotationHAlignment.Center.
LTR	Paragraph direction: LTR. If none of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL is set, AnnotationFlags.LTR will be used. At most one of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL can be set. See also AnnotationFlags.AutoAlignment
RTL	Paragraph direction: RTL. If none of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL is set, AnnotationFlags.LTR will be used. At most one of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL can be set. Usage of AnnotationFlags.RTL is not recommended as the visual representation of the text of the annotation may not match the plain text of the annotation (as interpreted by software which does not know that the paragraph direction is supposed to be RTL). Use AnnotationFlags.RTL only as last resort if you cannot modify the text received from an RTL input field appropriately for paragraph direction LTR used in PDF annotations. See also AnnotationFlags.AutoAlignment
DefaultLTR	Choose direction automatically, default to LTR. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 0 (LTR) for paragraphs having no strong directional character. If none of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL is set, AnnotationFlags.LTR will be used. At most one of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL can be set. Usage of AnnotationFlags.DefaultLTR is not recommended as the visual representation of the text of the annotation may not match the plain text of the annotation (as interpreted by software which does not know that the paragraph direction is supposed to be default-LTR). Use AnnotationFlags.DefaultLTR only as last resort if you cannot modify the text received from a default-LTR input field appropriately for paragraph direction LTR used in PDF annotations. See also AnnotationFlags.AutoAlignment
DefaultRTL	Choose direction automatically, default to RTL. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 1 (RTL) for paragraphs having no strong directional character. If none of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL is set, AnnotationFlags.LTR will be used. At most one of AnnotationFlags.LTR, AnnotationFlags.RTL, AnnotationFlags.DefaultLTR, and AnnotationFlags.DefaultRTL can be set. Usage of AnnotationFlags.DefaultRTL is not recommended as the visual representation of the text of the annotation may not match the plain text of the annotation (as interpreted by software which does not know that the paragraph direction is supposed to be default-RTL). Use AnnotationFlags.DefaultRTL only as last resort if you cannot modify the text received from a default-RTL input field appropriately for paragraph direction LTR used in PDF annotations. See also AnnotationFlags.AutoAlignment

enum AnnotationHAlignment

strong

Horizontal alignment of text in an annotation.

Enumerator
Left	Align left.
Center	Center.
Right	Align right.

enum AnnotationType

strong

Annotation types.

Most annotation types are supported for PDF documents only.

Enumerator
Unknown	Unknown annotation type.
Line	Line annotation.
Scribble	Scribble annotation (freehand scribble).
FreeText	FreeText annotation.

enum BiometricEncryption

strong

Select how to encrypt the biometric data.

Used for integer parameter "BiometricEncryption" of SignDocSignatureParameters. The biometric data to be encrypted is specified by blob parameter "BiometricData".

See also: SignDocSignatureParameters.setInteger(), SignDocSignatureParameters.setBlob()

Enumerator
RSA	Random session key encrypted with public RSA key. Either blob parameter "BiometricKey" (see SignDocSignatureParameters.setBlob()) or string parameter "BiometricKeyPath" (see SignDocSignatureParameters.setString()) must be set. See also signdocshared_biometric_encryption
Fixed	Fixed key (no security).
Binary	Binary 256-bit key. Blob parameter "BiometricKey" (see SignDocSignatureParameters.setBlob()) must be set.
Passphrase	Passphrase that will be hashed to a 256-bit key. String parameter "BiometricPassphrase" (see SignDocSignatureParameters.setString()) must be set.
DontStore	The biometric data won't be stored in the document. Use this value if you want to use the biometric data for generating the signature image only. Note that using an automatically generated self-signed certificate is secure only if biometric data is stored in the document using asymmetric encryption.

enum BiometricHashLocation

strong

Select where to store the message digest computed over the document hash and the unencrypted biometric data.

Used for integer parameter "BiometricHashLocation" of SignDocSignatureParameters.

See also: SignDocSignatureParameters.setInteger()

Enumerator

Attr

If possible, store the biometric hash as unauthenticated attribute in the PKCS #7 (or CMS) message.

For method SigningMethod.DigSigPKCS1, the biometric hash will stored in the Contents entry of the signature dictionary (see BiometricHashLocation.Contents).

For all other methods, the biometric hash will stored as unauthenticated attribute in the PKCS #7 (or CMS) message.

Contents

Store the message digest in the Contents entry of the signature dictionary.

This is what SignDoc SDK 4.1 and older did; it violates a constraint of most PDF specifications.

enum CaptureCoordinateSystem

strong

Coordinate system for buttons and the clipping area.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Digitizer	Digitizer coordinates (full area). The origin is in the upper left corner of the digitizer. The resolution of the digitizer is used.
Capture	Digitizer coordinates (capture area). On a Tablet PC and similar devices (where SignDocCaptureDevice.getDeviceInteger("DisplayType") returns CaptureDisplayType.Managed), this coordinate system has its origin in the upper left corner of the client area of the capture window but uses the resolution of the digitizer. For other capture devices (where SignDocCaptureDevice.getDeviceInteger("DisplayType") returns CaptureDisplayType.Dedicated)), this coordinate system is identical to CaptureCoordinateSystem.Digitizer.
Window	Window coordinates (capture area). This coordinate system has its origin in the upper left corner of the client area of the capture window and uses window coordinates. This coordinate system is available only if a window is displayed on a display managed by the operating system.
Image	Image coordinates. This coordinate system has its origin in the upper left corner of the background image and uses image coordinates. Note that there will be borders on two sides of the image if the aspect ratio of the image does not equal the aspect ratio of the capture device's display (or of the capture window). This coordinate system is available only if a background image is used. The image displayed while capturing will be used.
Per1000	Coordinates are in parts of 1000. Add this value with the bitwise-or operator to use per mille coordinates (0 through 1000) rather than the range implied by the coordinate system selected CaptureCoordinateSystem.Digitizer, CaptureCoordinateSystem.Capture, CaptureCoordinateSystem.Window, or CaptureCoordinateSystem.Image.

enum CaptureDevice

strong

Capture device identifiers.

Most of these are obsolete.

Enumerator
Unknown	Unknown capture device.
Intuos	Wacom Intuos.
MobiNetix	MobiNetix.
Graphire	Wacom Graphire.
BSHesy	BS Hesy.
PL400	Wacom PL400.
EPOS	Interlink ePAD Point of Sales.
ESig	Interlink ePad E-Signature.
EInk	Interlink ePad-Ink E-Signature.
PenPartner	Wacom PenPartner.
TabletPC	Tablet PC. Integrated Tablet PC capture device. This identifier was also used for Wacom pen displays (DTU). See also DTU
StepOver	StepOver.
EID	Interlink Epad-ID.
MTLCD	MotionTouch LegaPad LCD.
MTLPD	MotionTouch LegaPad. MotionTouch LegaPad tablet without LDC.
EPAD2	Interlink ePad II.
BlueM	Stepover blueM II. Stepover blueM II tablet without LCD.
BlueMLCD	Stepover blueM II with LCD.
TzSE	Topaz tablet with LCD (and pressure). Topaz LCD SE.
EPadLS	Interlink EPad-LS.
EInk2	Interlink EPad-Ink Pro.
EID2	Interlink EPad-ID Pro.
SignPad	Wacom SignPad. STU-300, STU-500, etc.
Bamboo	Wacom Bamboo.
VerifoneMX	Verifone MX 800 series.
IngenicoSC350	Ingenico iSC350.
DTU	Capture device identifier: Wacom pen display (DTU). DTU-1141 etc. Older software used cd_tabletpc for Wacom pen displays. See also TabletPC
IPad	Apple iPad.
IPhone	Apple iPhone.
IPod	Apple iPod.
OlivettiZPadB8001	Olivetti Graphos zPad-B8001.
SamsungGTN7000	Samsung GT-N7000.
HTCP510e	HTC Flyer P510e.
AndroidTouch	mobilephone touch. Android touch device.
HTML5Capture	HTML5 capture client.
OlivettiGraphosA10	Olivetti Graphos A10.
ENSign10	Euronovate ENSign10.
VPSign	VPSign.
UserFirst	First user-defined device identifier.
UserLast	Last user-defined device identifier.

enum CaptureDeviceState

strong

Capture device state for "State" of SignDocCaptureDevice.getDeviceInteger().

Enumerator
Idle	The capture device is idle (not connected).
Connected	The capture device is connected (but not capturing).
Capturing	The capture device is connected and capturing.

enum CaptureDisplayType

strong

Type of a capture device's display, returned by SignDocCaptureDevice.getDeviceInteger("DisplayType").

Enumerator

None

The capture device does not have a display.

Dedicated

The capture device has a dedicated display that is not available to the operating system.

Examples of this type of display are STU-500 and STU-530.

If you want to display something on a dedicated display of a capture device, you need to use SignDocCaptureDevice.showImage() on the object returned by SignDocCaptureDevice.createDisplay() or the "Image" blob parameter of SignDocCaptureParameters.

Managed

The capture device has a display which is managed by the operating system.

Examples of this type of display are Tablet PC and DTU-1141.

enum CaptureEvent

strong

Events that terminate capture.

Enumerator
Error	Capture terminated due to an error. You can get the error message with SignDocCaptureResult.getCaptureError() or SignDocCapture.getCaptureError().
Timeout	Capture timed out.
VirtualButton	Capture terminated by the operator clicking a button. SignDocCaptureResult.getButtonId() or SignDocCaptureOutput.getButtonId() will return the identifier of the button.
HardwareButton	Capture terminated by the operator clicking a hardware button on the capture device. SignDocCaptureResult.getButton() or SignDocCaptureOutput.getButton() will return the identifier of the button.
Callback	A callback returned CaptureListenerReturnValue.End.
UiButton	Capture terminated by the user clicking (or otherwise triggering) a button in the user interface on the computer screen. SignDocCaptureResult.getButtonId() or SignDocCaptureOutput.getButtonId() will return the identifier of the button.
Closed	Capture terminated by capture window being closed.

enum CaptureListenerReturnValue

strong

Return values of SignDocCaptureListener.gotSample().

Enumerator
NotImplemented	Do not call the method again. Return this value if you don't want to implement a callback method.
Continue	Continue capturing, letting the samples participate in button detection and biometric data collection.
End	Let SignDocCapture.waitCapture2() or SignDocCapture.waitCapture() return now.
Ignore	Ignore the samples (or the event). The samples won't participate in button detection and won't be added to the SigndocSignatureData object.

enum CaptureParameterType

strong

Return values of SignDocCaptureParameters.getType().

Enumerator
Undefined	The specified parameter is not defined.
Boolean	Boolean. See also SignDocCaptureParameters.getBoolean(), SignDocCaptureParameters.setBoolean()
Integer	Integer. See also SignDocCaptureParameters.getInteger(), SignDocCaptureParameters.setInteger()
Number	Floating-point number. See also SignDocCaptureParameters.getNumber(), SignDocCaptureParameters.setNumber()
String	String. See also SignDocCaptureParameters.getString(), SignDocCaptureParameters.setString()
Color	Color. See also SignDocCaptureParameters.getColor(), SignDocCaptureParameters.setColor()
Blob	Blob. See also SignDocCaptureParameters.getBlob(), SignDocCaptureParameters.setBlob()

enum CertificateChainState

strong

Certificate chain state for SignDocVerificationResult.verifyCertificateChain() and SignDocVerificationResult.verifyTimeStampCertificateChain().

Enumerator
OK	Chain OK.
BrokenChain	Chain broken.
UntrustedRoot	Untrusted root certificate.
CriticalExtension	A certificate has an unknown critical extension.
NotTimeValid	A certificate is not yet valid or is expired.
PathLength	Path length constraint not satisfied.
Invalid	Invalid certificate or chain.
Error	Other error.

enum CertificateChainVerificationPolicy

strong

Values for integer parameter "CertificateChainVerificationPolicy" of SignDocVerificationParameters.

See also: SignDocVerificationParameters.setInteger()

Enumerator
DontVerify	Don't verify the certificate chain. Always pretend that the certificate chain is OK.
AcceptSelfSigned	Accept self-signed certificates. If the signing certificate is not self-signed, it must chain up to a trusted root certificate.
AcceptSelfSignedWithBio	Accept self-signed certificates if biometric data is present. If the signing certificate is not self-signed or if there is no biometric data, the certificate must chain up to a trusted root certificate.
AcceptSelfSignedWithRSABio	Accept self-signed certificates if asymmetrically encrypted biometric data is present. If the signing certificate is not self-signed or if there is no biometric data or if the biometric data is not encrypted with RSA, the certificate must chain up to a trusted root certificate. This value is equivalent to CertificateChainVerificationPolicy.RequireTrustedRoot when verifying the certificate chain of a time stamp.
RequireTrustedRoot	Require a trusted root certificate. The signing certificate must chain up to a trusted root certificate.

enum CertificateRevocationState

strong

Certificate revocation state for SignDocVerificationResult.getCertificateRevocationState() and SignDocVerificationResult.getTimeStampCertificateRevocationState().

Enumerator
OK	No certificate revoked.
NotChecked	Revocation not checked.
Offline	Revocation server is offline.
Revoked	At least one certificate has been revoked.
Error	Error.

enum CertificateRevocationVerificationPolicy

strong

Values for integer parameter "CertificateRevocationVerificationPolicy" of SignDocVerificationParameters.

See also: SignDocVerificationParameters.setInteger()

Enumerator

DontCheck

Don't verify revocation of certificates.

Always pretend that certificates have not been revoked.

Offline

Check revocation, assume that certificates are not revoked if the revocation server is offline.

Online

Check revocation, assume that certificates are revoked if the revocation server is offline.

enum CertificateSelectionFlags

strong

Flags for selecting certificates.

Used for integer parameter "SelectCertificate" of SignDocSignatureParameters.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

See also: SignDocSignatureParameters.setInteger()

Enumerator
Zero	No flags set.
Software	Include certificates with software-based private keys. As software-based private keys and hardware-based private keys cannot be reliably distinguished, you should always set both CertificateSelectionFlags.Software and CertificateSelectionFlags.Hardware. If neither CertificateSelectionFlags.AskIfAmbiguous nor CertificateSelectionFlags.NeverAsk is included, the certificate selection dialog will be displayed.
Hardware	Include certificates with hardware-based private keys. As software-based private keys and hardware-based private keys cannot be reliably distinguished, you should always set both CertificateSelectionFlags.Software and CertificateSelectionFlags.Hardware. If neither CertificateSelectionFlags.AskIfAmbiguous nor CertificateSelectionFlags.NeverAsk is included, the certificate selection dialog will be displayed.
UseCertificateSeedValues	Include only certificates allowed by the PDF document's certificate seed value dictionary.
AskIfAmbiguous	Ask the user to select a certificate if there is more than one matching certificate.
NeverAsk	Never ask the user to select a certificate; exactly one certificate must match.
CreateSelfSigned	Offer to create a self-signed certificate (cannot be used with CertificateSelectionFlags.NeverAsk and CertificateSelectionFlags.AskIfAmbiguous).

enum CertSeedValueFlags

strong

Bit masks for SignDocField.getCertSeedValueFlags() and SignDocField.setCertSeedValueFlags().

Please see the PDF specification (ISO 32000-1:2008) for details.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
SubjectCert	Adobe bit 1.
IssuerCert	Adobe bit 2.
Policy	Adobe bit 3.
SubjectIDN	Adobe bit 4.
KeyUsage	Adobe bit 6.
URL	Adobe bit 7.

enum ChangeType

strong

Type of change.

See also: SignDocChange.getType()

Enumerator
Other	Other change. There will be one change of this type if there are any changes to the document which do not fit into the other categories described by enum ChangeType.
FieldAdded	A field has been added. getName() returns the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.
FieldRemoved	A field has been removed. getName() returns the name of the field, getPage() returns the first page which had a widget of the field, getFieldType() returns the type of the field.
FieldModified	Properties of a field have been modified. getName() returns the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.
FieldFilledIn	The value of a field has been changed. getName() returns the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns the type of the field.
AnnotationAdded	An annotation has been added. This does not include widget annotations. getName() returns the name of the annotation. getPage() returns the page having the annotation, getAnnotationType() returns the type of the annotation.
AnnotationRemoved	An annotation has been removed. This does not include widget annotations. getName() returns the name of the annotation. getPage() returns the page which had the annotation, getAnnotationType() returns the type of the annotation.
AnnotationModified	An annotation has been modified. This does not include widget annotations. getName() returns the name of the annotation. getPage() returns the page having the annotation, getAnnotationType() returns the type of the annotation.
AttachmentAdded	An annotation has been added. getName() returns the name of the attachment.
AttachmentRemoved	An annotation has been removed. getName() returns the name of the attachment.
AttachmentModified	An annotation has been modified. getName() returns the name of the attachment.
PageAdded	A page has been added. getPage() returns the number of the page in the newer version of the document.
PageRemoved	A page has been removed. getPage() returns the number of the page in the older version of the document.
PageModified	A page has been modified. getPage() returns the number of the page.
SignatureAdded	A certification signature or approval signature has been added. Changes of this type are reported only if GetChangeFlags.All has been passed to SignDocSignature.getChangeCount2(). getName() returns the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns FieldType.SignatureDigSig. See also DTSAdded
DTSAdded	A document time stamp (DTS) has been added. Changes of this type are reported only if GetChangeFlags.All has been passed to SignDocSignature.getChangeCount2(). getName() returns the name of the field, getPage() returns the first page having a widget of the field, getFieldType() returns FieldType.SignatureDigSig. See also DSSModified, SignatureAdded
DSSModified	The Document Secure Store (DTS) has been added or updated. Changes of this type are reported only if GetChangeFlags.DSS has been passed to SignDocSignature.getChangeCount2(). See also getType(), DTSAdded

enum CheckAttachmentResult

strong

Result of SignDocDocument.checkAttachment().

Enumerator
Match	The attachment matches its checksum.
NoChecksum	The attachment does not have a checksum.
Mismatch	The attachment does not match its checksum.

enum CheckSignatureParameterType

strong

Return values of SignDocCheckSignatureParameters.getType().

Enumerator

Undefined

The specified parameter is not defined.

Boolean

Boolean.

See also: SignDocCheckSignatureParameters.getBoolean(), SignDocCheckSignatureParameters.setBoolean()

Integer

Integer.

See also: SignDocCheckSignatureParameters.getInteger(), SignDocCheckSignatureParameters.setInteger()

enum CleanParameterType

strong

Return values of SignDocCleanParameters.getType() and SignDocCleanParameters.getTypeAt().

Enumerator
Undefined	The specified action is not defined.
Boolean	Boolean. See also SignDocCleanParameters.addBoolean()
Integer	Integer. See also SignDocCleanParameters.addInteger()
Number	Floating-point number. See also SignDocCleanParameters.addNumber()
Void	No value. See also SignDocCleanParameters.add()

enum ColorType

strong

Type of color.

See also: SignDocColor.getType()

Enumerator
Gray	Gray scale.
RGB	RGB color.

enum CopyToStreamFlags

strong

Flags modifying the behavior of SignDocDocument.copyToStream() and SignDocDocument.copyToMemory().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator

Zero

No flags set.

Unsaved

Include unsaved changes.

See copyToStream() and copyToMemory() for details.

enum CreateAppearancesFlags

strong

Flags for SignDocDocument.createAppearances().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.

enum CreateTextIteratorFlags

strong

Flags modifying the behavior of SignDocDocument.createTextIterator().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.

enum DocumentFlags

strong

Flags for SignDocDocument.setFlags().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

See also: SignDocDocument.getFlags(), SignDocDocument.setFlags()

Enumerator
Zero	No flags set.
RelaxByteRange	Relax checking of ByteRange. If this flag is set, ByteRange may have any values allowed by ISO 32000-1:2008. If this flag is not set, verifySignature() and verifySignature2() behave like Adobe Reader: ByteRange must have two ranges, sorted by offset, and covering the complete document. (Covering the complete document is required for PAdES, the other two criterions are not.) This flag is used for PDF documents only, it is ignored for TIFF documents. See also verifySignature(), verifySignature2()
AmbiguousButtonValueEmpty	Make exportFields(), exportFieldsToMemory(), getField(), getFields(), and getFieldsOfPage() return an empty button value if there are multiple non-Off values for a check box field. An empty button value will make setField() fail. Set this flag if you want to detect check box fields with ambiguous button values or if you want to keep the behavior of SignDoc SDK 4.0 and earlier. If this flag is not set, the first non-Off value of a check box field will be used as button value. The ordering used for determining the first non-Off value is unspecified and may change with different versions of SignDoc SDK. This flag is used for PDF documents only, it is ignored for TIFF documents.
UseDSSOnly	Use only the Document Security Store for building the certificate chain and for checking the revocation state of the certificates, ignore any certificates, CRLs, and OCSP responses from the signature proper. This flag is used for testing of verifySignature() and verifySignature2().
NoKerningForStandardFonts	Disable kerning for standard fonts. This flag is used for testing.
KeepEscapeSequences	Do not remove escape sequences specifying the natural language from text strings. In PDF, text strings can contain escape sequences which specify the natural language (and optionally, the country) of the text. By default, those escape sequences are removed by functions like SignDocField.getAlternateName(). If this flag is set, those escape sequences are not removed. If you serialize and deserialize a SignDocField object and this flag is not set, the escape sequences will get lost. See also withoutEscapeSequences(), DocumentFlags.UseEscapeSequences
RequireAlternateFieldName	Require alternate field names. If this flag is set and the document claims PDF/UA conformance, addField() will require an alternate field name to be set and setField() won't allow removal of the alternate field name (by setting it to an empty string). If a PDF/UA document does not specify a natural language, the alternate field name must start with an escape sequence specifying the language (see DocumentFlags.UseEscapeSequences). If this flag is not set and the document claims PDF/UA conformance, addField() will use the fully qualified field name as alternate field name. If the document does not provide a natural language, "en" (or the language set with setDefaultDocumentLanguage()) will be used. setField() behaves likewise if the alternate field name is removed (by setting it to an empty string). If a PDF/UA document does not specify a natural language and the alternate field name does not start with an escape sequence specifying the language, language identifier "en" (or the language set with setDefaultDocumentLanguage()) will be used (see DocumentFlags.UseEscapeSequences). See also getDocumentLanguage(), setDefaultDocumentLanguage(), setDocumentLanguage(), withEscapeSequence(), DocumentFlags.UseEscapeSequences, SignDocField.setAlternateName()
RequireLang	Require language identifier for text. If this flag is set and the document claims PDF/UA conformance and does not provide a natural language, addText2() will fail unless a language identifier is passed in aLang and addText() will always fail. If this flag is not set and the document claims PDF/UA conformance and does not provide a natural language, addText() and addText2() will use language identifier "en" (or the language set with setDefaultDocumentLanguage()) unless a language identifier is passed in aLang of addText2() or addTextRect2(). See also getDocumentLanguage(), setDefaultDocumentLanguage(), setDocumentLanguage()
InsertAtEnd	Do not attempt to insert new objects into the logical structure in reading order. If inserting in reading order fails or if this flag is set, new objects will be inserted at the end of the page's logical structure.
UseEscapeSequences	Use escape sequences to encode the natural language in alternate field names. If a natural language for an alternate field name is provided by the caller (by using an escape sequence) or if SignDoc SDK provides a default natural language for an alternate name, this flag controls how the natural language will be encoded in the document: If this flag is set, the natural language will be encoded in the string, enabling different languages for the alternate field names of different fields. However, this is quite useless, as currently existing assistive technologies do not support escape sequences. If this flag is not set and the document does provide a natural language, any escape sequences will be removed from the alternate field name. If this flag is not set and the document does not provide a natural language, the document's natural language will be set to the natural language of the alternate name. See also DocumentFlags.KeepEscapeSequences, DocumentFlags.RequireAlternateFieldName
FailForBrokenTargetStructure	Fail if a new object cannot be inserted into the logical structure of the target document due to that logical structure being broken. If this flag is not set and insertion into the logical structure fails due to that logical structure being broken, the logical structure will not be modified. See also addAnnotation(), addField(), addImageFromFile(), addImageFromFile2(), addImageFromMemory(), addImageFromMemory2(), addText(), addText2(), addTextRect(), addTextRect2(), importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile(), importPageFromImageFile2(), importPages(), setField(), ShootInFootFlags.AllowBreakingTaggedPDF
NoActualText	Do not add Actualtext property to marked-content sequences. This flag is used for testing. If this flag is not set, ActualText is added when needed, ie, when the original text cannot be reconstructed by using ToUnicode.
DontAddDADR	Do not add DA and DR to AcroForm. This flag is used for testing. If this flag is not set, DA and DR will be added to AcroForm of a PDF document when adding or signing a field.
AutoRemovePermissions	Automatically call removePermissions() if an operation would fail due to permissions. The operation may still fail due to removePermissions() not being allowed due to the presence of a certification signature with P=1.

enum DocumentHAlignment

strong

Horizontal alignment for SignDocDocument.addTextRect() and SignDocDocument.addTextRect2().

Enumerator
Left	Align left.
Center	Center.
Right	Align right.
Auto	Align left if the text begins with an LTR run, align right if the text begins with an RTL run.

enum DocumentLoaderFlags

strong

Flags for SignDocDocumentLoader.setFlags().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
MapIntoMemory	Map input files into memory. If this flag is set, loadFromFile() and other functions will try to map their input file into memory. Doing that may improve performance (on Android, in particular) but read errors and truncating the file will crash the process. This flag is just a hint and may be ignored.
DontCreateAppearances	Do not create appearance streams for widget annotations at load time for PDF documents having a NeedAppearances entry that is true. If this flag is set, SignDocDocument.createAppearances() won't be called automatically after loading PDF documents. You may want to call SignDocDocument.createAppearances() yourself after loading a PDF document. If this flag is not set, loadFromFile() and loadFromMemory() will automatically call SignDocDocument.createAppearances() for PDF documents. Loading may fail due to missing fonts. If the document does not have a NeedAppearances entry or if its value is false, this flag won't have any effect. See also SignDocDocument.createAppearances()
SpeedUp	Tune SignDoc SDK to favor speed over memory consumption. Setting this flag may speed up SignDoc SDK, but will cause more memory to be used.
KeepNeedAppearances	Used for testing only.

enum DocumentType

strong

Supported document types.

Enumerator
Unknown	Unknown, for SignDocDocumentLoader.ping() and SignDocDocumentLoader.pingMemory().
PDF	PDF document.
TIFF	TIFF document.
Other	Other document.
FDF	FDF document.

enum DocumentVAlignment

strong

Vertical alignment for SignDocDocument.addTextRect() and SignDocDocument.addTextRect2().

Enumerator
Top	Align top.
Center	Center.
Bottom	Align bottom.

enum ExportFlags

strong

Flags modifying the behavior of SignDocDocument.exportFields(), SignDocDocument.exportFieldsToMemory(), SignDocDocument.exportProperties(), and SignDocDocument.exportPropertiesToMemory().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
Top	Include XML declaration and schema for top-level element.

enum FieldBorderStyle

strong

Border style.

See also: SignDocField.getBorderStyle(), SignDocField.setBorderStyle()

Enumerator
Other	Unknown/unsupported border style.
Solid	Solid rectangle.
Dashed	Dashed rectangle.
Beveled	Rectangle looking embossed.
Inset	Rectangle looking engraved.
Underline	Single line at bottom.

enum FieldButtonStyle

strong

Style used for check boxes and radio buttons.

See also: SignDocField.getButtonStyle(), SignDocField.setButtonStyle()

Enumerator
Default	Default button style.
Other	Unknown/unsupported style.
CheckMark	Check mark.
Cross	Cross.
Star	Star.
Circle	Circle (default for radio buttons).
Square	Square.
Diamond	Diamond.

enum FieldFlags

strong

Field flags.

See the PDF Reference for the meaning of these flags. Most field flags are supported for PDF documents only.

The FieldFlags.NoToggleToOff flag should be set for all radio button groups. Adobe products seem to ignore this flag being not set.

The FieldFlags.Invisible, FieldFlags.EnableAddAfterSigning, and FieldFlags.SinglePage flags cannot be modified.

Invisible signature fields (FieldFlags.Invisible) are invisible (ie, they look as if not inserted) until signed. Warning: signing an invisible signature field in a TIFF file may increase the size of the file substantially.

By default, no fields can be inserted into a TIFF document after a signature field has been signed. The FieldFlags.EnableAddAfterSigning flag changes this behavior. (FieldFlags.EnableAddAfterSigning is ignored for PDF documents.)

If the FieldFlags.EnableAddAfterSigning flag is set, document size increases more during signing this field than when this flaq is not set. Each signature will increase the document size by the initial size of the document (before the first signature was applied), approximately. That is, the first signature will approximately double the size of the document.

Inserting a signature field fails if there already are any signed signature fields that don't have this flag set.

By default, signing a signature field signs the complete document, that is, modifications to any page are detected. For TIFF documents, this behavior can be changed for signature fields that have the FieldFlags.EnableAddAfterSigning flag set: If the FieldFlags.SinglePage flag is set, the signature applies only to the page containing the signature field, modifications to other pages won't be detected. This flag can be used for speeding up verification of signatures.

A signature field for which FieldFlags.EnableAddAfterSigning is not set (in a TIFF document) can only be cleared if no other signature fields that don't have FieldFlags.EnableAddAfterSigning have been signed after the signature field to be cleared. Signature fields having FieldFlags.EnableAddAfterSigning set can always be cleared.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

See also: SignDocField.getFlags(), SignDocField.setFlags(), SignDocDocument.clearSignature()

Enumerator
Zero	No flags set.
ReadOnly	ReadOnly.
Required	Required.
NoExport	NoExport.
NoToggleToOff	NoToggleToOff.
Radio	Radio.
Pushbutton	Pushbutton.
RadiosInUnison	RadiosInUnison.
MultiLine	Multiline (for text fields). The value of a text field that has this flag set may contain hard line breaks encoded as "\r", "\n", or "\r\n". The contents of the text field are top-aligned if this flag is set and vertically centered if this flag is not set.
Password	Password.
FileSelect	FileSelect.
DoNotSpellCheck	DoNotSpellCheck.
DoNotScroll	DoNotScroll.
Comb	Comb.
RichText	RichText.
Combo	Combo (always set for combo boxes).
Edit	Edit (for combo boxes). If this flag is set, the user can enter an arbitrary value.
Sort	Sort (for list boxes and combo boxes).
MultiSelect	MultiSelect (for list boxes).
CommitOnSelChange	CommitOnSelChange (for list boxes and combo boxes).
SinglePage	Signature applies to the containing page only (TIFF only).
EnableAddAfterSigning	Signature fields can be inserted after signing this field (TIFF only).
Invisible	Invisible (TIFF only).

enum FieldJustification

strong

Justification of text fields and list boxes.

See also: SignDocField.getJustification(), SignDocField.setJustification()

Enumerator
None	Justification does not apply (not a text field or a list box).
Left	Left-justified.
Center	Centered.
Right	Right-justified.

enum FieldType

strong

Field types.

Most field types are supported for PDF documents only.

Enumerator
Unknown	Unknown type.
Pushbutton	Pushbutton (PDF).
CheckBox	Check box field (PDF).
RadioButton	Radio button (radio button group) (PDF).
Text	Text field (PDF).
ListBox	List box (PDF).
SignatureDigSig	Digital signature field (Adobe DigSig in PDF, SOFTPRO signature in TIFF).
SignatureSignDoc	Digital signature field (traditional SignDoc, no longer supported) (PDF).
ComboBox	Combo box (drop-down box) (PDF).

enum FieldTypeFlags

strong

Bitmasks for SignDocDocument.getFields() and SignDocDocument.getFieldsOfPage().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
Pushbutton	Bit mask for FieldType.Pushbutton.
CheckBox	Bit mask for FieldType.CheckBox.
RadioButton	Bit mask for FieldType.RadioButton.
Text	Bit mask for FieldType.Text.
ListBox	Bit mask for FieldType.ListBox.
SignatureDigSig	Bit mask for FieldType.SignatureDigSig.
SignatureSignDoc	Bit mask for FieldType.SignatureSignDoc.
ComboBox	Bit mask for FieldType.ComboBox.

enum FindTextFlags

strong

Flags modifying the behavior of SignDocDocument.findText().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
IgnoreHSpace	Ignore horizontal whitespace (may be required). If this flag is set, horizontal whitespace will be removed from the stream of characters read from the document (but not from the text being sought). The following characters will be ignored: U+0009 (CHARACTER TABULATION) U+0020 (SPACE) U+00A0 (NO-BREAK SPACE) U+1361 (ETHIOPIC WORDSPACE) U+1680 (OGHAM SPACE MARK) U+2000 (EN QUAD) U+2001 (EM QUAD) U+2002 (EN SPACE) U+2003 (EM SPACE) U+2004 (THREE-PER-EM SPACE) U+2005 (FOUR-PER-EM SPACE) U+2006 (SIX-PER-EM SPACE) U+2007 (FIGURE SPACE) U+200B (PUNCTUATION SPACE) U+2009 (THIN SPACE) U+200A (HAIR SPACE) U+200B (ZERO WIDTH SPACE) U+200C (ZERO WIDTH NON-JOINER) U+200D (ZERO WIDTH JOINER) U+202F (NARROW NO-BREAK SPACE) U+205F (MEDIUM MATHEMATICAL SPACE) U+2060 (WORD JOINER) U+3000 (IDEAGRAPHIC SPACE) U+303F (IDEOGRAPHIC HALF FILL SPACE) U+FEFF (ZERO WIDTH NO-BREAK SPACE)
IgnoreHyphenation	Ignore hyphenation. If this flag is set, hyphen characters will be removed from the stream of characters read from the document (but not from the text being sought). The following characters will be ignored: U+002D (HYPHEN-MINUS) U+00AD (SOFT HYPHEN) U+058A (ARMENIAN HYPHEN) U+1400 (CANADIAN SYLLABICS HYPHEN) U+1806 (MONGOLIAN TODO SOFT HYPHEN) U+1860 (BALINESE PAMENENG) U+2010 (HYPHEN) U+2011 (NON-BREAKING HYPHEN) U+2012 (FIGURE-DASH) U+2013 (EN-DASH) U+2014 (EM-DASH) U+2015 (HORIZONTAL BAR) U+2027 (HYPHENATION POINT) U+2043 (HYPHEN BULLET) U+2212 (MINUS SIGN) U+2796 (HEAVY MINUS SIGN) U+2E17 (DOUBLE OBLIQUE HYPHEN) U+2E40 (DOUBLE HYPHEN) U+30A0 (KATAKANA-HIRAGANA DOUBLE HYPHEN) U+FE63 (SMALL HYPHEN-MINUS) U+FF0D (FULLWIDTH HYPHEN-MINUS) U+10191 (ROMAN UNICA SIGN)
IgnoreSequence	Use character positions instead of searching the characters in the document in the sequence they are encountered. This can be expensive. This flag is not yet implemented.

enum FlattenAnnotationsFlags

strong

Flags modifying the behavior of SignDocDocument.flattenAnnotations().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator

Zero

No flags set.

IncludeHidden

Include hidden and invisible annotations.

KeepStructure

Do not modify logical structure.

Set this flag only if you don't care about the logical structure of the document and fear problems due to errors in the logical structure. For instance, you might want to use this flag if flattening annotations just for printing with a PDF component that does not support annotations and then throw away the document with the flattened annotations.

enum FlattenFieldsFlags

strong

Flags modifying the behavior of SignDocDocument.flattenFields().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
IncludeSignatureUnsigned	Include uint signature fields.
IncludeSignatureSigned	Include signed signature fields.
IncludeHidden	Include hidden and invisible widgets.
KeepStructure	Do not modify logical structure. Set this flag only if you don't care about the logical structure of the document and fear problems due to errors in the logical structure. For instance, you might want to use this flag if flattening fields just for printing with a PDF component that does not support annotations and then throw away the document with the flattened fields.

enum GetBoundingBoxesFlags

strong

Flag for FindTextOccurrence.getBoundingBoxes().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
Single	Compute a single bounding box, viz, the smallest rectangle containing all the glyph bounding boxes.
Individual	Return one bounding box per glyph.
Logical	Compute logical bounding boxes. If this flag is set, a heuristic will be used for computing bounding boxes that reflect the logical flow of the text. For instance, line breaks will start a new bounding box. RTL text is not yet supported.

enum GetChangeFlags

strong

Flags for SignDocSignature.getChangeCount2().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator

Zero

No flags set.

All

Get all changes following the signature represented by the SignDocSignature object.

If this flag is set, all changes after the signature represented by the SignDocSignature object will be reported. This is useful when evaluating a signature that does not allow further signatures (such as a certification signature with DocMDP P 1).

Setting this flag enables reporting of additional types of changes:

If this flag is not set (which is the default), only changes between the signature represented by the SignDocSignature object and the next signature (or after the last signature if this is the last signature) will be reported.

Note: PDF 2.0 allows adding document time stamps to documents with DocMDP P 1, but Adobe Acrobat does not (yet). For now, SignDoc SDK follows Adobe Acrobat.

DSS

Enable reporting of changes to the DSS (Document Security Store).

By default, changes to the DSS are not reported.

Setting this flag enables reporting of additional types of changes:

ChangeType.DSSModified

enum IgnoreSeedValues

strong

Flags for ignoring mandatory requirements specified by the signature seed value dictionary.

Used for integer parameter "IgnoreSeedValues" of SignDocSignatureParameters.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

See also: SignDocSignatureParameters.setInteger()

Enumerator

Zero

No flags set.

SubFilter

Ignore SubFilter (signing method).

If this flag is not set signing will fail if the signing method specified by integer parameter "Method" is neither SigningMethod.Default nor listed in the SubFilter entry of the signature field seed value dictionary.

If this flag is set, you can override the SubFilter entry of the signature field seed value dictionary with integer parameter "Method" without risking failure of signing due to a conflict between "Method" and SubFilter.

DigestMethod

Ignore DigestMethod (hash algorithm).

If this flag is not set, signing will fail if a hash algorithm is requested that is not listed in the DigestMethod entry of the signature field seed value dictionary. The hash algorithnm is specified by string parameter "DetachedHashAlgorithm" (if the value of that parameter is not "default"). It can also be implied by integer parameter "Method".

If this flag is set, you can override the DigestMethod entry of the signature field seed value dictionary with string parameter "DetachedHashAlgorithm" and/or integer parameter "Method" without risking failure of signing due to a conflict with DigestMethod.

enum ImageParameterType

strong

Return values of SignDocImageParameters.getType().

Enumerator
Undefined	The specified parameter is not defined.
Boolean	Boolean. See also SignDocImageParameters.getBoolean(), SignDocImageParameters.setBoolean()
Integer	Integer. See also SignDocImageParameters.getInteger(), SignDocImageParameters.setInteger()
Number	Floating-point number. See also SignDocImageParameters.getNumber(), SignDocImageParameters.setNumber()
String	String. See also SignDocImageParameters.getString(), SignDocImageParameters.setString()
Color	Color. See also SignDocImageParameters.getColor(), SignDocImageParameters.setColor()

enum ImageTransparency

strong

Transparency of signature image.

Used for integer parameter "ImageTransparency" of SignDocSignatureParameters.

If the image has an alpha channel (or if its palette contains a transparent color), the image's transparency will be used no matter what value is set for "ImageTransparency".

Transparency is not supported for JPEG images and JPEG-compressed TIFF images. Signature images created from biometric data (according to the "RenderSignature" integer parameter) don't have an alpha channel.

See also: SignDocSignatureParameters.setInteger()

Enumerator

Opaque

Make signature image opaque.

The signature image will be opaque unless the image has an alpha channel or transparent colors in its palette.

Brightest

Make the brightest color transparent.

If the image has an alpha channel (or if its palette contains a transparent color), the image's transparency will be used. Otherwise, white will be made transparent for truecolor images and the brightest color in the palette will be made transparent for indexed images (including grayscale images).

enum ImportFlags

strong

Flags modifying the behavior of SignDocDocument.importProperties() and SignDocDocument.importPropertiesFromMemory().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
Atomic	Modify all properties from XML or none (on error).

enum ImportImageFlags

strong

Flags modifying the behavior of SignDocDocument.addImageFromFile(), SignDocDocument.addImageFromFile2(), SignDocDocument.addImageFromMemory(), SignDocDocument.addImageFromMemory2(), SignDocDocument.importPageFromImageBlob(), SignDocDocument.importPageFromImageBlob2(), SignDocDocument.importPageFromImageFile(), and SignDocDocument.importPageFromImageFile2().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator

Zero

No flags set.

KeepAspectRatio

Keep aspect ratio of image, center image on white background.

BrightestTransparent

Make the brightest color transparent.

This flag may be specified for addImageFromFile(), addImageFromFile2(), addImageFromMemory(), and addImageFromMemory2() only. importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile(), and importPageFromImageFile2() always make the image opaque.

The rest of this description applies to addImageFromFile(), addImageFromFile2(), addImageFromMemory(), addImageFromMemory2() only.

If the image has an alpha channel (or if its palette contains a transparent color), this flag will be ignored and the image's transparency will be used.

Transparency is not supported for JPEG images and JPEG-compressed TIFF images.

If this flag is not set, the image will be opaque unless the image has an alpha channel or transparent colors in its palette.

If this flag is set (and the image doesn't have an alpha channel and doesn't have transparent colors in its palette), white will be made transparent for truecolor images and the brightest color in the palette will be made transparent for indexed images (including grayscale images).

enum ImportPagesFlags

strong

Flags modifying the behavior of SignDocDocument.importPages().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.

enum KeepOrRemove

strong

Tell SignDocDocument.removePages() to keep or to remove the specified pages.

Enumerator
Keep	Keep the specified pages, remove all other pages.
Remove	Remove the specified pages, keep all other pages.

enum LengthType

strong

Indicate how measurements are specified.

See also: SignDocSignatureParameters.setLength()

Enumerator

Abs

aValue is the value to be used (units of document coordinates).

See Coordinate Systems.

FieldHeight

Multiply aValue by the field height.

FieldWidth

Multiply aValue by the field width.

enum LineEnding

strong

Line ending styles.

Enumerator
Unknown	Unknown line ending style.
None	No line ending.
Arrow	Two short lines forming an arrowhead.

enum LockType

strong

Fields to be locked when signing this signature field.

See also: SignDocField.getLockType(), SignDocField.setLockType()

Enumerator
NA	Not a signature field.
None	Don't lock any fields.
All	Lock all fields in the document.
Include	Lock all lock fields specified by SignDocField.addLockField() etc.
Exclude	Lock all fields except the lock fields specified by SignDocField.addLockField() etc.

enum MatchParametersFlags

strong

Flags for integer parameter "%Flags" of SignDocMatchParameters.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
EngineAuto	Use all matching engines suitable for the data at hand. The static matching engine will always be used, the DStat matching engine and the dynamic matching engine will be used when matching a signature against a reference with at least 3 signatures. This flag is equivalent to boolean parameter "EngineAuto".
EngineStatic	Enable static matching (SIVAL engine). This flag is equivalent to boolean parameter "EngineStatic".
EngineDynamic	Enable dynamic matching (ADSV engine). This flag is equivalent to boolean parameter "EngineDynamic".
EngineDStat	Enable statistic matching (DStat engine). This flag is equivalent to boolean parameter "EngineDStat".
NormalizeSampleRates	Normalize the sample rates of signatures and references for dynamic matching. This flag is ignored unless the dynamic matching engine is used. This flag is equivalent to boolean parameter "NormalizeSampleRates".
Mirror	Mirror rendered signature and reference images for static matching. Set this flag when matching signatures that have been written in RTL scripts. This flag is ignored unless the static matching engine is used. This flag is equivalent to boolean parameter "Mirror".
KeepResolution	Flag for integer parameter "Flags": do not scale signatures. If this flag is set, signatures, references, and signature images will be matched without adjusting their resolutions, even if those resolutions are different. If this flag is not set, a common resolution will be computed as the smallest resolution encountered in the involved signatures, references, and signature images, and integer parameter "MaxResolution" (that parameter will be ignored if its value is 0). Then, the sample coordinates in signatures and references will be scaled to the computed resolutions and signature images will be resized to that resolution. (The SignDocSignatureData and SignDocImage objects won't be modified.) See also integer parameter "MaxResolution". This flag is equivalent to boolean parameter "KeepResolution".

enum MatchParameterType

strong

Return values of SignDocMatchParameters.getType().

Enumerator

Undefined

The specified parameter is not defined.

Boolean

Boolean.

See also: SignDocMatchParameters.getBoolean(), SignDocMatchParameters.setBoolean()

Integer

Integer.

See also: SignDocMatchParameters.getInteger(), SignDocMatchParameters.setInteger()

enum ModificationState

strong

Modification state of the document for a certain signature.

Enumerator
Unmodified	The document has not been modified since the signature was added.
Allowed	All the modifications are allowed by the signature.
Prohibited	There are modifications that are not allowed by the signature.

enum Optimize

strong

Optimization of document before signing.

Used for integer parameter "Optimize" of SignDocSignatureParameters.

See also: SignDocSignatureParameters.setInteger()

Enumerator

Yes

Optimize document before signing for the first time.

No

Don't optimize document.

IfPossible

Optimize the document if possible.

Optimization is possible if there is not yet any signature.

enum PDFAButtons

strong

Fix appearance streams of check boxes and radio buttons for PDF/A-1 without Technical Corrigendum 2.

Used for integer parameter "PDFAButtons" of SignDocSignatureParameters.

Using PDFAButtons.Freeze (or PDFAButtons.Auto, if the document claims to conform with PDF/A-1 and has no signed signature fields) is equivalent to saving the document with SaveFlags.PDFAButtons before signing.

See also: SignDocSignatureParameters.setInteger()

Enumerator

Freeze

Freeze (fix) appearances.

This value should be used only if you need conformance with ISO 19005-1:2005 before Technical Corrigendum 2 (TC2), that is, if you need conformance with a standard that is no longer in force.

Note that TC2 is in force and using this value breaks conformance with TC2.

DontFreeze

Don't freeze (fix) appearances.

This value should be used unless you need conformance with a standard (ISO 19005-1:2005 without Technical Corrigendum 2) that is no longer in force.

Auto

Freeze (fix) appearances if appropriate.

Freeze (fix) appearances if the document claims PDF/A-1 conformance and if there are no signed signature fields.

This value should be used only if you need conformance with ISO 19005-1:2005 without Technical Corrigendum 2 (TC2), that is, if you need conformance with a standard that is no longer in force.

Note that TC2 is in force and using this value breaks conformance with TC2.

enum PrepareForSigningFlags

strong

Flags for SignDocDocument.prepareForSigning().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.

enum PropertyType

strong

Property types.

Enumerator
String	String.
Integer	Integer.
Boolean	Boolean.

enum RemainingDays

strong

Specify which expiry date shall be used by SignDocDocumentLoader.getRemainingDays().

Enumerator
Product	Use the expiry date for the product.
Signing	Use the expiry date for signing documents.

enum RemoveFlags

strong

Flags for SignDocDocument.removeLogicalStructure(), SignDocDocument.removePDFA(), SignDocDocument.removePDFUA(), SignDocDocument.removePermissions(), and SignDocDocument.removeXFA().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.

enum RemoveXFA

strong

Values for integer parameter "RemoveXFA" of SignDocSignatureParameters.

See also: SignDocSignatureParameters.setInteger()

Enumerator

Always

Always remove XFA.

Use this value if you intend to call setField() or addField() after signing. Adding the signature will fail if the document prohibits removal of XFA.

IfAllowed

Remove XFA if possible.

XFA will be removed unless the document prohibits removal of XFA. addField() and setField() will fail if XFA is still present after signing.

Never

Do not remove XFA.

SignDocDocument.addField() and SignDocDocument.setField() will fail if XFA is still present after signing.

enum RenderParameterType

strong

Return values of SignDocRenderParameters.getType().

Enumerator
Undefined	The specified parameter is not defined.
Boolean	Boolean. See also SignDocRenderParameters.getBoolean(), SignDocRenderParameters.setBoolean()
Integer	Integer. See also SignDocRenderParameters.getInteger(), SignDocRenderParameters.setInteger()
Number	Floating-point number. See also SignDocRenderParameters.getNumber(), SignDocRenderParameters.setNumber()
String	String. See also SignDocRenderParameters.getString(), SignDocRenderParameters.setString()
String2	String (with two parameter names). See also SignDocRenderParameters.getString2(), SignDocRenderParameters.setString2()

enum RenderSignatureFlags

strong

Flags for rendering the signature.

Used for integer parameter "RenderSignature" of SignDocSignatureParameters.

RenderSignatureFlags.BW, RenderSignatureFlags.Gray, and RenderSignatureFlags.Antialias are mutually exclusive.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

See also: SignDocSignatureParameters.setInteger()

Enumerator
Zero	No flags set.
BW	Black and white.
Gray	Use gray levels computed from pressure.
Antialias	Use gray levels for antialiasing.
LimitSize	Limit the size of the rendered signature to the size of the captured signature. If this flag is set, the rendered signature won't be magnified. However, it may be shrunk to fit the signature field. Set this flag only if you are sure that the capture resolution stored in the blob passed to blob parameter "BiometricData" is accurate.

enum ReturnCode

strong

Return code.

Enumerator
OK	No error (0). The operation completed successfully.
InvalidArgument	Invalid argument (1). An invalid value was passed for at least one parameter. This return code can also be returned for invalid documents.
FieldNotFound	Field not found (2). The specified field does not exist or (if a signature field is expected) is not a signature field.
InvalidProfile	Invalid profile (3). The specified profile is unknown or not applicable.
InvalidImage	Invalid image (4). The specified image cannot be used. This can happen if the image's format is unsupported or if the image is broken.
TypeMismatch	Type mismatch (5). The type (e.g., string) implied by the function does not match the type of the named property.
FontNotFound	Font not found (6). The requested font could not be found or does not contain all required characters. See also SignDocDocument.setShootInFoot(), SignDocDocumentLoader.loadFontConfigBlob(), SignDocDocumentLoader.loadFontConfigEnvironment(), SignDocDocumentLoader.loadFontConfigFile(), SignDocDocumentLoader.loadFontConfigStream()
NotSupported	Operation not supported (8). In most cases, this return code indicates invalid data (such as broken or unsupported biometric data).
IoError	I/O error (9). An error occurred while trying to open, read, or write a file.
NotVerified	Signature not verified (10). This code is returned by member functions of SignDocVerificationResult if SignDocDocument.verifySignature() has not been called.
PropertyNotFound	Property not found (11). The specified property does not exist.
PageNotFound	Page not found (12). The specified page number is not a valid page number.
WrongCollection	Wrong collection (13). The specified property exists, but not in the specified collection.
FieldExists	Field already exists (14). Field names must be unique.
LicenseError	License error (15) License initialization failed (missing or invalid license key or license file) or license check failed (you don't have a license for the requested operation).
UnexpectedError	Unexpected error (16). Something failed in an unexpected way or there's no return code that fits the failure.
Cancelled	Operation cancalled (17). Certificate selection dialog cancelled by user.
NoBiometricData	No biometric data (18). This code is returned by member functions of SignDocVerificationResult if there is no biometric data or no biometric hash.
FieldNotSigned	Field not signed (20). Returned by SignDocDocument.copyAsSignedToStream() and SignDocDocument.copyAsSignedToMemory() if the field is not signed.
InvalidSignature	Signature is not valid (21). Returned by SignDocDocument.addSignature(), SignDocDocument.copyAsSignedToMemory(), SignDocDocument.copyAsSignedToStream(), SignDocDocument.updateDSS(), and SignDocDocument.updateDSS2().
AnnotationNotFound	Annotation not found (22). Returned by SignDocDocument.getAnnotation().
AttachmentNotFound	Attachment not found (23).
AttachmentExists	Attachment already exists (24).
NoCertificate	No certificate found (25). No (matching) certificate found and CertificateSelectionFlags.CreateSelfSigned is not specified.
AmbiguousCertificate	Ambiguous certificate (26). More than one matching certificate found and CertificateSelectionFlags.NeverAsk is specified.
NotAllowed	Operation not allowed (27). Operation not allowed due to document being signed or conforming to PDF/A or PDF/UA or having logical structure. See also SignDocDocument.removePDFA(), SignDocDocument.removePDFUA(), SignDocDocument.setShootInFoot()
InvalidStructure	Invalid logical structure (28). The document has invalid logical structure. See also DocumentFlags.FailForBrokenTargetStructure
UnknownParameter	Unknown parameter (29). The specified parameter (aName) is unknown. For SignDocCaptureParameters, SignDocCheckSignatureParameters, SignDocCleanParameters, SignDocImageParameters, SignDocMatchParameters, SignDocRenderParameters, SignDocSignatureParameters, and SignDocVerificationParameters.
InvalidValue	Invalid value (30). The specified value (aValue) is invalid. For SignDocCheckSignatureParameters, SignDocCleanParameters, SignDocImageParameters, SignDocMatchParameters, SignDocRenderParameters, SignDocSignatureParameters, and SignDocVerificationParameters.
NotAvailable	Not available (31). The requested value is not available. This code is returned by some member functions of SignDocAnnotation for objects returned by getAnnotation().
NoCaptureDevice	No capture device found (32). No capture device matching the specified filters has been found. See also SignDocCapture.createDefaultDevice()
WrongState	Wrong state (33). The current state of the SignDocCaptureDevice object does not allow the requested operation.

enum SaveFlags

strong

Flags modifying the behavior of SignDocDocument.saveToFile(), SignDocDocument.saveToMemory(), and SignDocDocument.saveToStream().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
Incremental	Save incrementally (PDF). See also SaveFlags.AutoIncremental
RemoveUnused	Remove unused objects (PDF). This flag is ignored, unused objects are always removed.
Linearized	Linearize the document (PDF). This flag cannot be used with SaveFlags.Incremental. Note This flag is currently ignored, it will be supported again in a future version of SignDoc SDK.
PDF_1_4	Do not use features introduced after PDF 1.4 for saving the document. This flag is assumed to be set for PDF 1.4 (and older) documents (PDF).
PDFAButtons	Fix appearance streams of check boxes and radio buttons for conformance with PDF/A-1 without Technical Corrigendum 2. The appearance streams of a check box or radio button field added by addField() or modified by setField() or applyFdf() do not conform to ISO 19005-1:2005 before Technical Corrigendum 2 (TC2). The relevant wording was fixed in TC2. To make the appearance streams of check boxes and radio buttons conform to ISO 19005-1:2005 before TC2, save the document with this flag set. The document will be modified in memory and then saved. The document will not conform to TC2 and later versions of ISO 19005. This flag is observed even if the document does not claim PDF/A-1 conformance. Note After "fixing" appearance streams, check boxes and radio buttons can no longer be modified or operated as the button values (ie, the set of possible values) is lost. See also PDFAButtons.Auto, PDFAButtons.Freeze
AutoIncremental	Automatically set SaveFlags.Incremental if needed, automatically reset SaveFlags.Incremental if not allowed. If this flag is set, SignDoc SDK will save the document incrementally or non-incrementally as needed; if you prefer saving incrementally, also set the SaveFlags.Incremental flag. If you prefer saving non-incrementally, do not set the SaveFlags.Incremental flag.

enum SerialNumberType

strong

Type of serial number for SignDocSignatureData.getDeviceSerialNumber(), SignDocSignatureData.getDeviceSerialNumberTypes(), SignDocSignatureData.setDeviceSerialNumber(), SignDocCaptureDevice.getSerialNumber(), and "SerialNumberTypes" of SignDocCaptureDevice.getDeviceInteger().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No bit set in the bitset.
UID	UID. All Wacom SignPad models (STU) support this type of serial number. Such a serial number consists of 4 octets (binary).
UID2	UID2. The following Wacom SignPad models support this type of serial number: STU-430 STU-530 STU-540 STU-541 Such a serial number consists of 9 or 10 ASCII characters. For the STU-540 and STU-541, the UID2 is a non-contiguous substring of the E-serial number (see SerialNumberType.ESerial).
ESerial	E-serial number. The following Wacom SignPad models support this type of serial number: STU-540 STU-541 Such a serial number consists of 13 ASCII characters.
PNPId	E-serial number. Wacom DTU tablets support this type of serial number. Such a serial number consists of ASCII characters.
Legacy	Legacy serial number. Serial number set by old software. It is unknown whether the serial number is binary or ASCII or whatever.
Unknown	Unknown type. It is unknown whether the serial number is binary or ASCII or whatever. Please avoid using this type.
GenericBinary	Generic binary serial number. A binary serial number for which UID and UID2 do not apply.
GenericASCII	Generic ASCII serial number. An ASCII serial number for which ESerial and PNPId do not apply.

enum SetFieldFlags

strong

Flags modifying the behavior of SignDocDocument.setField(), SignDocDocument.addField(), and SignDocDocument.applyFdf().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
FontFail	Fail if no suitable font is found. setField(), addField(), and applyFdf() won't modify/add the field and will fail with ReturnCode.FontNotFound if no font covering all required characters is found. This flag is provided for compatibility with existing code; setField(), addField(), and applyFdf() now always assume this flag is set.
Move	Move or resize field. setField() does not update the coordinates of the field unless this flag is set as moving a field may require recomputing the appearance which can have unexpected results (for instance, Adobe Acrobat and SignDoc SDK use different designs for check marks). If this flag is not set, setField() ignores the coordinates set with SignDocField.setLeft(), SignDocField.setBottom(), SignDocField.setRight(), and SignDocField.setTop(). addField() ignores this flag, it always uses the coordinates. applyFdf() ignores this flag, it never moves or resizes fields. In documents using Tagged PDF, widgets can be moved only within the page, they cannot be moved to a different page.
KeepAP	Keep appearance streams. If this flag is set, setField() and applyFdf() won't touch the existing (or non-existing) appearance streams, addField() won't add any appearance streams. Recomputing the appearance can have unexpected results (for instance, Adobe Acrobat and SignDoc SDK use different designs for chedck marks), therefore you might want to set this flag if you make changes that shall not affect the appearance such as setting the FieldFlags.ReadOnly flag. At most one of SetFieldFlags.KeepAP and SetFieldFlags.UpdateAP can be set. See also SetFieldFlags.UpdateAP
UpdateAP	Update appearance streams. If this flag is set, setField() and applyFdf() will always recompute the appearance streams of the field. (addField() always computes the appearance stream unless SetFieldFlags.KeepAP is set). You might want to use this flag after changing the document's default text field attributes. At most one of SetFieldFlags.KeepAP and SetFieldFlags.UpdateAP can be set. If neither SetFieldFlags.KeepAP and SetFieldFlags.UpdateAP is set, setField() and applyFdf() try to update the appearance streams only if necessary; the exact behavior depends on the version of SignDoc SDK. See also SetFieldFlags.KeepAP, setTextFieldAttributes()
FitHeightOnly	Compute the default font size such that the field contents fit the height of the field. If the font size for a text field, list box field, or combo box field is zero (see SignDocTextFieldAttributes.setFontSize()), the default font size will be used. This flag controls how the default font size is computed. If this flag is set, the font size will be computed such that the field contents fit the height of the field. This is the behavior required by the PDF specification. If the field contents are too long, they will be truncated. If this flag is not set, the font size will be computed such that the field contents fit both the height and the width of the field. This is the behavior implemented in, for instance, Adobe Acrobat. This flag is assumed to be not set if line breaking is enabled.
ForceBorderWidth	Use the border width specified by the field even if that will obliterate the field contents. If this flag is set, the behavior matches that of Adobe Acrobat. If this flag is not set, the border width will be reduced to 1/16 of the field height or field width (whichever is smaller) if the border width specified by the field wouldn't leave enough space for the field contents.
DontBreakLines	Do not break lines in multiline text fields. You can use this flag to simulate the behavior of SignDoc SDK 4.0 and earlier.
AutoAlignment	Align left if the text begins with an LTR run, align right if the text begins with an RTL run. This flag overrides for creating the appearance stream FieldJustification.Left and FieldJustification.Right set by SignDocField.setJustification(). This flag is ignored for FieldJustification.Center.
LTR	Paragraph direction: LTR. If none of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL is set, SetFieldFlags.LTR will be used. At most one of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL can be set. See also SetFieldFlags.AutoAlignment
RTL	Paragraph direction: RTL. If none of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL is set, SetFieldFlags.LTR will be used. At most one of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL can be set. Usage of SetFieldFlags.RTL is not recommended as the visual representation of the value of the field may not match the value of the field (as interpreted by software which does not know that the paragraph direction is supposed to be RTL). Use SetFieldFlags.RTL only as last resort if you cannot modify the text received from an RTL input field appropriately for paragraph direction LTR used in PDF fields. See also SetFieldFlags.AutoAlignment
DefaultLTR	Choose direction automatically, default to LTR. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 0 (LTR) for paragraphs having no strong directional character. If none of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL is set, SetFieldFlags.LTR will be used. At most one of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL can be set. Usage of SetFieldFlags.DefaultLTR is not recommended as the visual representation of the value of the field may not match the value of the field (as interpreted by software which does not know that the paragraph direction is supposed to be default-LTR). Use SetFieldFlags.DefaultLTR only as last resort if you cannot modify the text received from a default-LTR input field appropriately for paragraph direction LTR used in PDF fields. See also SetFieldFlags.AutoAlignment
DefaultRTL	Choose direction automatically, default to RTL. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 1 (RTL) for paragraphs having no strong directional character. If none of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL is set, SetFieldFlags.LTR will be used. At most one of SetFieldFlags.LTR, SetFieldFlags.RTL, SetFieldFlags.DefaultLTR, and SetFieldFlags.DefaultRTL can be set. Usage of SetFieldFlags.DefaultRTL is not recommended as the visual representation of the value of the field may not match the value of the field (as interpreted by software which does not know that the paragraph direction is supposed to be default-RTL). Use SetFieldFlags.DefaultRTL only as last resort if you cannot modify the text received from a default-RTL input field appropriately for paragraph direction LTR used in PDF fields. See also SetFieldFlags.AutoAlignment

enum ShootInFootFlags

strong

Flags for SignDocDocument.setShootInFoot().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
AllowBreakingSignatures	Allow operations to break existing signatures in signature fields. This flag is available for PDF documents only.
AllowBreakingPermissions	Allow operations to break signatures which grant permissions. This flag is available for PDF documents only.
AllowInvalidCertificate	Allow signing with a certificate that is not yet valid or no longer valid or which is not qualified for digital signatures.
AllowNonStandardExternalFonts	Allow non-standard usage of external (non-embedded) TrueType and CFF fonts. If this flag is not set, TrueType and CFF fonts must be embedded; when trying to use a TrueType or CFF font that is not embededded, ReturnCode.FontNotFound will be returned. If this flag is set, external TrueType and CFF fonts are allowed. However, the document will violate Table 117, section 9.7.4.2 and section 9.7.5.2 of ISO 32000-1:2008.
AssumeAPNotShared	Assume that appearance dictionaries and appearance streams are not shared. If this flag is set and that assumption doesn't hold, changing one field may change the appearances of other fields. At most one of ShootInFootFlags.AssumeAPNotShared and ShootInFootFlags.AssumeAPShared can be set. If neither flag is set, setField() and addSignature() look for shared objects. This can be expensive in terms of time and memory.
AssumeAPShared	Always assume that appearance dictionaries and appearance streams are shared. Setting this flag partially simulates the behavior of SignDoc SDK 3.x and older and causes a minor violation of section 12.7.3.3 of ISO 32000-1:2008 by setField(). At most one of ShootInFootFlags.AssumeAPNotShared and ShootInFootFlags.AssumeAPShared can be set. If neither flag is set, setField() and addSignature() look for shared objects. This can be expensive in terms of time and memory.
DontVerifyAfterSigning	Disable verification of signature after signing by addSignature(). You might want to set this flag if you always perform a complete verification with verifySignature() after calling addSignature().
AllowAllCurves	Allow elliptic curves for signing which are not supported by Adobe products for Windows. As of August 2016, Adobe Acrobat XI and 2015 for Windows support these curves: secp192r1 (prime192v1, P-192), secp256r1 (prime256v1, P-256), secp224r1, secp384r1, and secp521r1. Setting this flag enables additional curves: prime192v2, prime192v3, prime239v1, prime239v2, prime239v3, secp112r1, secp112r2, secp160r1, secp160k1, secp256k1, secp128r1, secp128r2, secp160r2, secp192k1, secp224k1, brainpoolp160r1, brainpoolp192r1, brainpoolp224r1, brainpoolp256r1, brainpoolp320r1, brainpoolp384r1, and brainpoolp512r1. However, most of these are not supported (for signing and verifying) by SignDoc SDK for iOS, OS X, and Windows Store apps due to limitations of those operating systems. This flag is ignored (and assumed to be set) for TIFF documents. This flag is ignored if SignDocSignatureParameters.setPKCS7() is used.
AllowBreakingTaggedPDF	Allow operations to break Tagged PDF (and PDF/UA). If this flag is not set, operations that would break Tagged PDF will report an error. If this flag is set, all operations may break Tagged PDF without reporting an error. The target document's logical structure may be broken or incomplete (and thus violating PDF/UA) after such an operation. This flag is available for PDF documents only. See also isTaggedPDF(), DocumentFlags.FailForBrokenTargetStructure

enum SignatureDataFormat

strong

Blob format flags for SignDocSignatureData.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
iso_mask_single	Mask for blob format: formats specified by a single value.
iso_mask_wrapper	Mask for blob format: CBEFF wrapper.
iso_mask_bdb	Mask for blob format: BDB format.
iso_mask_data	Mask for blob format: data format.
iso_mask_flags	Mask for blob format: flags.
softpro	Blob format: SOFTPRO Flatfile format for dynamic signatures and references. This format does not store the capture device name and any serial number types other than SerialNumberType.Legacy. See also saveToFile(), saveToMemory()
iso_19785_3_none	Blob format: No ISO/IEC 19785-3:2015 (CBEFF) wrapper. This should be used with SignatureDataFormat.iso_19794_7_2014 or SignatureDataFormat.iso_19794_7_2021 (version 2) only as ISO/IEC 19794-7:2007 (version 1) requires a CBEFF wrapper. However, some products accept only unwrapped version 1 BDBs. Note This is the default value for the CBEFF wrapper as the value of this constant is zero. Compact format (not yet implemented) requires a CBEFF wrapper.
iso_19785_3_format2	Blob format: Use ISO/IEC 19785-3:2015 patron format type 2 ("minimum simple byte-oriented patron format") CBEFF wrapper. This can be used with SignatureDataFormat.iso_19794_7_2007tc1, SignatureDataFormat.iso_19794_7_2014 or SignatureDataFormat.iso_19794_7_2021. With SignatureDataFormat.iso_19794_7_2007tc1, this patron format cannot be used for saving references. Deprecated: Patron format type 2 has been deprecated in ISO/IEC 19785-3:2015, please use SignatureDataFormat.iso_19785_3_none with SignatureDataFormat.iso_19794_7_2014 or SignatureDataFormat.iso_19794_7_2021.
iso_19785_3_format3	Blob format: Use ISO/IEC 19785-3:2015 patron format type 3 ("maximum simple patron format (byte oriented) using presence bitmap") CBEFF wrapper. This can be used with SignatureDataFormat.iso_19794_7_2007tc1, SignatureDataFormat.iso_19794_7_2014 or SignatureDataFormat.iso_19794_7_2021. With SignatureDataFormat.iso_19794_7_2007tc1, this patron format cannot be used for saving references. Deprecated: Patron format type 3 has been deprecated in ISO/IEC 19785-3:2015, please use SignatureDataFormat.iso_19785_3_none with SignatureDataFormat.iso_19794_7_2014 or SignatureDataFormat.iso_19794_7_2021.
iso_19785_3_format6	Blob format: Use ISO/IEC 19785-3:2015 patron format type 6 ("complex patron format") CBEFF wrapper. This can be used with SignatureDataFormat.iso_19794_7_2007tc1, SignatureDataFormat.iso_19794_7_2014 or SignatureDataFormat.iso_19794_7_2021. Both signatures and references can be saved with this patron format. Deprecated: Patron format type 6 has been deprecated in ISO/IEC 19785-3:2015, please use SignatureDataFormat.iso_19785_3_none with SignatureDataFormat.iso_19794_7_2014 or SignatureDataFormat.iso_19794_7_2021.
iso_19794_7_2007tc1	Blob format: ISO/IEC 19794-7:2007 (with Technical Corrigendum 1) Biometric Data Block (version 1). Please also use SignatureDataFormat.iso_19785_3_format2, SignatureDataFormat.iso_19785_3_format3, or SignatureDataFormat.iso_19785_3_format6 to specify the ISO/IEC 19785-3 wrapper. Alternateively, use SignatureDataFormat.iso_19785_3_none (signature) to omit the CBEFF wrapper; the CBEFF wrapper is mandatory in ISO/IEC 19794-7:2007, but some products accept only unwrapped BDBs. SignatureDataFormat.iso_19785_3_format6 is required for saving references, signatures can be saved with any of these constants. Please also use SignatureDataFormat.iso_19794_7_full (default) to select the data format. You can include flag SignatureDataFormat.iso_flag_meters for using ISO/IEC 19794-7:2007 without Technical Corrigendum 1. You can include flag SignatureDataFormat.iso_flag_compat1 for bug compatibility with SignWare before version 3.2.9.0. You can include flag SignatureDataFormat.iso_flag_no_ext_data to omit extended data.
iso_19794_7_2014	Blob format: ISO/IEC 19794-7:2014 Biometric Data Block (version 2.0). Please also use SignatureDataFormat.iso_19785_3_none, SignatureDataFormat.iso_19785_3_format2, SignatureDataFormat.iso_19785_3_format3, or SignatureDataFormat.iso_19785_3_format6 to specify the ISO/IEC 19785-3 wrapper. Unlike ISO/IEC 19794-7:2007, ISO/IEC 19794-7:2014 allows BDBs without CBEFF wrapper. Both signatures and references can be saved with any of these constants. Please also use SignatureDataFormat.iso_19794_7_full (default) to select the data format.
iso_19794_7_2021	Blob format: ISO/IEC 19794-7:2021 Biometric Data Block (version 2.1). Please also use SignatureDataFormat.iso_19785_3_none, SignatureDataFormat.iso_19785_3_format2, SignatureDataFormat.iso_19785_3_format3, or SignatureDataFormat.iso_19785_3_format6 to specify the ISO/IEC 19785-3 wrapper. Unlike ISO/IEC 19794-7:2007, ISO/IEC 19794-7:2021 allows BDBs without CBEFF wrapper. Both signatures and references can be saved with any of these constants. Please also use SignatureDataFormat.iso_19794_7_full (default) to select the data format.
iso_19794_7_full	Blob format: ISO/IEC 19794-7 full format. To be used with either SignatureDataFormat.iso_19794_7_2007tc1, SignatureDataFormat.iso_19794_7_2014, or SignatureDataFormat.iso_19794_7_2021. Contrast with compact format, compression format, and XML, all of which are not yet supported. Note This is the default value for the data format as the value of this constant is zero.
iso_flag_meters	Blob format flag: Use meters rather than millimeters for X and Y coordinates. ISO-format signatures written by SignWare before version 3.2.9.0 use meters as units for the X and Y coordinates as specified by the original version of ISO/IEC 19794-7:2007. Technical Corrigendum for ISO/IEC 19794-7:2007 changed the units to millimeters. Set this flag for compatibility with software that implements ISO/IEC 19794-7:2007 without Technical Corrigendum 1. This flag takes effect only if the Biometric Data Block is in ISO/IEC 19794-7:2007 format (version 1). For loading signatures or references written by SignWare before version 3.2.9.0, just leave SignatureDataFormat.iso_flag_no_fix unset rather than setting this flag. For saving signatures or references to be read by SignWare before version 3.2.9.0, set SignatureDataFormat.iso_flag_compat1 rather than this flag. This flag is ignored for non-ISO formats. See also iso_flag_compat1, iso_flag_no_fix
iso_flag_no_fix	Blob format flag: do not attempt to automatically fix ISO-format signatures that have been written by SignWare before version 3.2.9.0. ISO-format signatures written by SignWare before version 3.2.9.0 have multiple issues: the origin is in the upper left corner rather than in the lower left corner. Technical Corrigendum 1 for ISO/IEC 19794-7:2007 is not implemented. In consequence, the X and Y scaling factors are based on meters rather than millimeters. for CBEFF patron format type 6, garbage is written for bdbCreationDate if the signature does not have a timestamp. the CBEFF wrapper does not use the correct BDB format type. These bugs have been fixed in SignWare 3.2.9.0. When loading a signature or reference, all of these issues will be fixed automatically if data written by SignWare before version 3.2.9.0 is detected, unless this flag (iso_flag_no_fix) is set. If this flag is set, no attempt is made to fix the data. If the signature or reference was indeed written by SignWare before version 3.2.9.0, loading will fail or the data read will be incorrect. When saving a signature or reference, this flag must not be set. This flag is ignored for non-ISO formats. See also iso_flag_compat1, iso_flag_meters
iso_flag_compat1	Blob format flag: write with bug compatibility with SignWare before version 3.2.9.0. ISO-format signatures written by SignWare before version 3.2.9.0 have multiple issues: the origin is in the upper left corner rather than in the lower left corner. Technical Corrigendum 1 for ISO/IEC 19794-7:2007 is not implemented. In consequence, the X and Y scaling factors are based on meters rather than millimeters. for CBEFF patron format type 6, garbage is written for bdbCreationDate if the signature does not have a timestamp. the CBEFF wrapper does not use the correct BDB format type. These bugs have been fixed in SignWare 3.2.9.0. Use this flag for saving signatures in a format that is bug-compatible with old versions of SignWare (except for the bdbCreationDate bug). Extended data will be omitted (see SignatureDataFormat.iso_flag_no_ext_data). When saving a signature or reference, this flag takes effect only if the Biometric Data Block is in ISO/IEC 19794-7:2007 format (version 1) with a patron format type 2, 3, or 6 CBEFF wrapper, that is, for format SignatureDataFormat.iso_19794_7_2007tc1 (with SignatureDataFormat.iso_19785_3_format2, SignatureDataFormat.iso_19785_3_format3, or SignatureDataFormat.iso_19785_3_format6). When loading a signature or reference, this flag must not be set. This flag is ignored for non-ISO formats. See also iso_flag_meters, iso_flag_no_fix
iso_flag_no_ext_data	Blob format flag: Omit or ignore extended data. By default, extended data will be written that includes the following information: a version number the SPTablet device ID the tablet serial ID If this flag is set, extended data won't be added when saving a signature or reference and extended data will be ignored when loading a signature or reference. This flag is ignored for non-ISO formats. See also iso_flag_compat1

enum SignatureDataType

strong

Type of handwritten signatures stored in a SignDocSignatureData object.

This is the return type of SignDocSignatureData.getType().

Enumerator

Empty

Empty.

SignDocSignatureData objects of this type do not contain any handwritten signature.

Signature

Signature.

SignDocSignatureData objects of this type contain exactly one handwritten signature.

Reference

Reference.

SignDocSignatureData objects of this type contain two or more handwritten signatures.

enum SignatureParametersHAlignment

strong

Horizontal alignment.

Used for integer parameters "ImageHAlignment" and "TextHAlignment" of SignDocSignatureParameters and for SignDocSignatureParameters.addTextItem2().

See also: SignDocSignatureParameters.addTextItem2(), SignDocSignatureParameters.setInteger()

Enumerator
Left	Align left.
Center	Center.
Right	Align right.
Justify	Justify (align both and right, expanding white space). Note Expanding white space is not the correct way to justify Arabic text.
Auto	Align left if the text begins with an LTR run, align right if the text begins with an RTL run.
Default	addTextItem2(): use integer parameter "TextHAlignment".

enum SignatureParametersVAlignment

strong

Vertical alignment.

Used for integer parameters "ImageVAlignment" and "TextVAlignment" of SignDocSignatureParameters.

See also: SignDocSignatureParameters.setInteger().

Enumerator
Top	Align top.
Center	Center.
Bottom	Align bottom.

enum SignatureParameterType

strong

Return values of SignDocSignatureParameters.getType().

Enumerator
Undefined	The specified parameter is not defined.
Integer	Integer. See also SignDocSignatureParameters.getInteger(), SignDocSignatureParameters.setInteger()
String	String. See also SignDocSignatureParameters.getString(), SignDocSignatureParameters.setString()
Color	Color. See also SignDocSignatureParameters.setColor()
Blob	Blob. See also SignDocSignatureParameters.setBlob()
Length	Length. See also SignDocSignatureParameters.setLength()

enum SignatureState

strong

State of a signature.

Enumerator
Unmodified	No error, signature and document verified.
DocumentExtended	No error, signature and document verified, document modified by adding data to the signed document.
DocumentModified	Document modified (possibly forged).
UnsupportedSignature	Unsupported signature method.
InvalidCertificate	Invalid certificate.
Empty	Signature field without signature.

enum SignatureType

strong

Signature type.

Enumerator
NotASignatureField	The field is not a signature field.
NotSigned	The signature field is not signed.
Approval	Approval signature (that's the normal type of signature).
Certification	Certification signature (signed by the author).
DocumentTimeStamp	Document time stamp.

enum SigningMethod

strong

Signing methods.

Used for integer parameter "Method" of SignDocSignatureParameters and by SignDocVerificationResult.getMethod().

See also: SignDocSignatureParameters.setInteger()

Enumerator
Default	Default method. For signature parameters created by SignDocDocument.createSignatureParametersForTimeStamp(), this value is treated as SigningMethod.DigSigCadesRFC3161. Use the method specified by the SubFilter values of the signature field seed value dictionary or, if not present, SigningMethod.DigSigPKCS7Detached. This is the recommended method unless you need an ETSI CAdES signature (SigningMethod.DigSigCadesDetached).
DigSigPKCS1	PKCS #1 (RSA keys only). Not allowed for PDF/A-2 and PDF/A-3.
DigSigPKCS7Detached	Detached PKCS #7.
DigSigPKCS7SHA1	PKCS #7 with SHA-1 (deprecated).
Hash	The signature is just a hash (TIFF only).
DigSigCadesDetached	Detached ETSI CAdES (PAdES-BES).
DigSigCadesRFC3161	ETSI CAdES RFC 3161 time stamp.

enum SigningMethodFlags

strong

Bit masks for SignDocSignatureParameters.getAvailableMethods().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
DigSigPKCS1	Bit mask for SigningMethod.DigSigPKCS1.
DigSigPKCS7Detached	Bit mask for SigningMethod.DigSigPKCS7Detached.
DigSigPKCS7SHA1	Bit mask for SigningMethod.DigSigPKCS7SHA1.
Hash	Bit mask for SigningMethod.Hash.
DigSigCadesDetached	Bit mask for SigningMethod.DigSigCadesDetached.
DigSigCadesRFC3161	Bit mask for SigningMethod.DigSigCadesRFC3161.

enum TextGroup

strong

Text groups.

One font size is used per group and is chosen such that the text fits horizontally. The maximum font size is specified by length parameter "FontSize". The font size of the secondary group cannot be greater than the font size of the primary group, that is, long text in the secondary group won't reduce the font size of the primary group.

There must be at least one primary text item if there is a secondary text item.

See also: SignDocSignatureParameters.addTextItem(), SignDocSignatureParameters.addTextItem2(), SignDocSignatureParameters.setLength()

Enumerator
Primary	Primary group.
Secondary	Secondary group.
Master
Slave

enum TextItemDirection

strong

Paragraph direction of a text item.

Enumerator
LTR	Paragraph direction: LTR.
RTL	Paragraph direction: RTL.
DefaultLTR	Choose direction automatically, default to LTR. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 0 (LTR) for paragraphs having no strong directional character.
DefaultRTL	Choose direction automatically, default to RTL. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 1 (RTL) for paragraphs having no strong directional character.

enum TextPosition

strong

Position of the text block w.r.t. to the image.

Used for integer parameter "TextPosition" of SignDocSignatureParameters.

See also: SignDocSignatureParameters.setInteger()

Enumerator
Overlay	Text and image are independent and overlap (text painted on image).
Below	Text is put below the image.
Underlay	Text and image are independent and overlap (image painted on text).
RightOf	Text is put on the right of the image.
Above	Text is put above the image.
LeftOf	Text is put on the left of the image.

enum TimeStamperStampFlags

strong

Flags for TimeStamper.stamp().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator

Zero

No flags set.

DontCheckRevocation

Do not check revocation.

Set this flag if you need only the size of the timestamp.

DontHash

Do not hash the document message digest again.

enum TimeStamperStampResult

strong

Return value of TimeStamper.stamp().

Enumerator
OK	Success.
InvalidInput	Invalid argument or invalid time-stamp request.
Timeout	Timeout.
Stopped	Transaction interrupted by stop().
TCPError	Some failure at the TCP/IP layer.
SSLError	Some failure at the SSL/TLS layer.
HTTPError	Some failure at the HTTP layer.
ServerError	The server failed to create the time stamp (according to PKIStatus).
InvalidResponse	The response from the server is invalid.

enum TimeStampState

strong

State of the RFC 3161 time stamp.

Enumerator
Valid	No error, an RFC 3161 time stamp is present and valid (but you have to check the certificate chain and revocation).
Missing	There is no RFC 3161 time stamp.
Invalid	An RFC 3161 time stamp is present but invalid.

enum UpdateDSSFlags

strong

Flags for SignDocDocument.updateDSS() and SignDocDocument.updateDSS2().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator

Zero

No flags set.

Simulate

Perform all the checks but do not modify the document.

VRI

Create VRI dictionaries.

This is discouraged by ETSI TS 103 172 V2.2.2 section 8.1.1.

enum UserTimeStamperFlags

strong

Flags for UserTimeStamper.stamp().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator

Zero

No flags set.

GetSize

Get the size only.

This flag is set if only the size of the timestamp is needed.

enum UserTimeStamperResult

strong

Return value of UserTimeStamper.stamp().

Enumerator
OK	Success.
InvalidArgument	Invalid argument.
Timeout	Timeout.
Stopped	Transaction interrupted by stop().
Error	Error.

enum VerificationFlags

strong

Flags for certificate verification.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

See also: verifyCertificateChain(), verifyTimeStampCertificateChain()

Enumerator
Zero	No flags set.
CheckRevocation	Check the revocation state of the certificates. Nowadays, most OCSP responders do not return the nonce, but SignDoc SDK expects to receive a nonce when it sends one. That is, you should always set VerificationFlags.NoOCSPNonce if you enable revocation checking.
UseCRLOnly	Use only certification revocation lists for checking the revocation state of the certificates. This flag is ignored unless VerificationFlags.CheckRevocation is set. VerificationFlags.UseOCSPOnly must not be set if this flag is set.
UseOCSPOnly	Use only OCSP for checking the revocation state of the certificates. This flag is ignored unless VerificationFlags.CheckRevocation is set. VerificationFlags.UseCRLOnly must not be set if this flag is set.
Offline	Use only CRLs and OCSP responses stored in the document, do not connect to any server for getting CRLs and OCSP responses. This flag is ignored unless VerificationFlags.CheckRevocation is set. VerificationFlags.Online must not be set if this flag is set.
EnforceNextUpdate	Enforce nextUpdate of CRLs and OCSP responses. If this flag is set, CRLs and OCSP responses whose nextUpdate time is before the signing time or verification time (depending on the verification model) will be ignored. See also integer parameter "ComputeOfflineNextUpdate". This flag is ignored unless VerificationFlags.CheckRevocation is set. If this flag is set, there are more cases in which an OCSP or CRL server needs to be contacted.
EnforceOCSPSigner	Enforce correct OCSP signer. If this flag is set, an OCSP response must be signed by the issuer certificate or a delegate issued by the issuer certificate. This flag flag is not set, any trusted signer will be accepted as OCSP signer. This flag is ignored unless VerificationFlags.CheckRevocation is set.
Online	Do not use CRLs and OCSP responses stored in the document, always use server for getting CRLs and OCSP responses. This flag is ignored unless VerificationFlags.CheckRevocation is set. VerificationFlags.Offline must not be set if this flag is set.
NoOCSPNonce	Do not use a nonce in OCSP requests. If this flag is set, OCSP requests won't use a nonce, enabling OCSP responders to cache responses and enabling attackers to mount replay attacks. If this flag is not set, a nonce is used in OCSP requests (and is therefore required in OCSP responses).
CRLFirst	Try CRL before OCSP for certificates that specify both CRL distribution points and OCSP distribution points. If this flag is set, CRLs will be tried first which has the advantage of CRLs being cacheable. If this flag is not set, OCSP will be tried first which has the advantage of OCSP responses being usually smaller than CRLs.
IgnoreNoRevocation	Ignore for revocation checking certificates that don't have CRL and OCSP distribution points. If this flag is set, certificates that have neither CRL distribution points nor OCSP distribution points will be ignored during revocation checking. If this flag is not set, certificates that have neither CRL distribution points nor OCSP distribution points cause revocation checking to fail (result CertificateRevocationState.NotChecked for SignDocVerificationResult.getCertificateRevocationState()) unless there is a revoked certificate (result CertificateRevocationState.Revoked for SignDocVerificationResult.getCertificateRevocationState()).
OCSPUseCurrentTime	Use current time for validating a BasicOCSPResponse signed by a delegate. If this flag is not set, producedAt will be used.

enum VerificationModel

strong

Values for integer parameter "VerificationModel" of SignDocVerificationParameters.

See also: SignDocVerificationParameters.setInteger()

Enumerator
Minimal	Minimal. The signing certificate must be valid at signing time. Apparently, this is what Adobe Reader does.
Chain	Chain model. Each certificate in the chain (except for the root certificate) must have been issued during the validity time period of its issuer certificate. The signing certificate must be valid at signing time.
ModifiedShell	Modified shell model (also known as hybrid model). All certificates in the chain must be valid at signing time.
Shell	Shell model. All certificates in the chain must be valid at verification time and the signing certificate must be valid at signing time. The shell model is not really suitable for digital signatures as it allows for repudiation of signatures. An exception is LTV (long term validity) validation as signatures are validated at times in the past established by document time stamps.

enum VerificationParameterType

strong

Return values of SignDocVerificationParameters.getType().

Enumerator
Undefined	The specified parameter is not defined.
Integer	Integer. See also SignDocVerificationParameters.setInteger()
String	String. See also SignDocVerificationParameters.setString()
Blob	Blob. See also SignDocVerificationParameters.setBlob()

enum WatermarkFlags

strong

Flags for SignDocWatermark.setFlags().

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

Enumerator
Zero	No flags set.
LTR	Paragraph direction: LTR. If none of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL is set, WatermarkFlags.LTR will be used. At most one of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL can be set.
RTL	Paragraph direction: RTL. If none of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL is set, WatermarkFlags.LTR will be used. At most one of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL can be set.
DefaultLTR	Choose direction automatically, default to LTR. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 0 (LTR) for paragraphs having no strong directional character. If none of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL is set, WatermarkFlags.LTR will be used. At most one of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL can be set.
DefaultRTL	Choose direction automatically, default to RTL. The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph. The paragraph level will be 1 (RTL) for paragraphs having no strong directional character. If none of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL is set, WatermarkFlags.LTR will be used. At most one of WatermarkFlags.LTR, WatermarkFlags.RTL, WatermarkFlags.DefaultLTR, and WatermarkFlags.DefaultRTL can be set.

enum WatermarkHAlignment

strong

Horizontal alignment of a watermark.

Enumerator
Left	Align left.
Center	Center.
Right	Align right.

enum WatermarkJustification

strong

Justification of multi-line text of a watermark.

Enumerator
Left	Left-justify.
Center	Center.
Right	Right-justify.

enum WatermarkLocation

strong

Location of watermark.

Enumerator
Overlay	Watermark appears on top of page.
Underlay	Watermark appears behind page.

enum WatermarkVAlignment

strong

Vertical alignment of a watermark.

Enumerator
Top	Align top.
Center	Center.
Bottom	Align bottom.

enum WidgetFlags

strong

Annotation flags of a widget.

See the PDF Reference for the meaning of these flags. All these flags are supported for PDF documents only, they are ignored for TIFF documents.

Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.

See also: SignDocField.getWidgetFlags(), SignDocField.setWidgetFlags()

Enumerator
Zero	No flags set.
Invisible	Do not display non-standard annotation.
Hidden	Do not display or print or interact.
Print	Print the annotation.
NoZoom	Do not scale to match magnification.
NoRotate	Do not rotate to match page's rotation.
NoView	Do not display or interact.
ReadOnly	Do not interact.
Locked	Annotation cannot be deleted or modified, but its value can be changed.
ToggleNoView	Toggle WidgetFlags.NoView for certain events.
LockedContents	Value cannot be changed.

Classes

Enumerations

Enumeration Type Documentation