 |
|
SignDoc SDK (.NET without exceptions)
5.0.0
|
|
|
SignDoc SDK (.NET without exceptions)
5.0.0
|
Classes | |
| class | Blobs |
| An array of blobs. 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 | 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 | 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. 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 } |
| 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 | ChangeType { Other, FieldAdded, FieldRemoved, FieldModified, FieldFilledIn, AnnotationAdded, AnnotationRemoved, AnnotationModified, AttachmentAdded, AttachmentRemoved, AttachmentModified, PageAdded, PageRemoved, PageModified } |
| 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 { Master, Slave } |
| 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 | 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 } |
| 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 | RemoveFlags { Zero = 0 } |
| Flags for SignDocDocument.removeLogicalStructure(), SignDocDocument.removePDFA(), SignDocDocument.removePDFUA(), SignDocDocument.removePermissions(), and SignDocDocument.removeXFA(). More... | |
| enum | DocumentFlags { Zero = 0, RelaxByteRange, AmbiguousButtonValueEmpty, UseDSSOnly, NoKerningForStandardFonts, KeepEscapeSequences, RequireAlternateFieldName, RequireLang, InsertAtEnd, UseEscapeSequences, FailForBrokenTargetStructure } |
| 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 } |
| 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_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, 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... | |
|
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. |
|
strong |
Values for integer parameter "AddCertificates" of SignDocSignatureParameters.
|
strong |
Flags for integer parameter "AddRevocationInfo" of SignDocSignatureParameters.
|
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. |
|
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. |
|
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.
|
| 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.
|
| 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.
|
| 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.
|
|
strong |
|
strong |
|
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".
| 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.
|
| 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. |
|
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.
| 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. |
|
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 |
Wacmo 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. |
| 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. |
| 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. |
|
strong |
Certificate chain state for SignDocVerificationResult.verifyCertificateChain() and SignDocVerificationResult.verifyTimeStampCertificateChain().
|
strong |
Values for integer parameter "CertificateChainVerificationPolicy" of SignDocVerificationParameters.
| 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. |
|
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. |
|
strong |
Values for integer parameter "CertificateRevocationVerificationPolicy" of SignDocVerificationParameters.
|
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.
| 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). |
|
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. |
|
strong |
Type of change.
| 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. |
|
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. |
|
strong |
Return values of SignDocCheckSignatureParameters.getType().
| Enumerator | |
|---|---|
| Undefined |
The specified parameter is not defined. |
| Boolean |
Boolean.
|
| Integer |
Integer.
|
|
strong |
Return values of SignDocCleanParameters.getType() and SignDocCleanParameters.getTypeAt().
|
strong |
|
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. |
|
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. |
|
strong |
Flags for SignDocDocument.setFlags().
Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.
| 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.
|
| 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.
|
| 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).
|
| 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().
|
| 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. |
| 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.
|
|
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. |
|
strong |
Flags for SignDocDocumentLoader.setFlags().
Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.
|
strong |
Supported document types.
| Enumerator | |
|---|---|
| Unknown |
Unknown, for SignDocDocumentLoader.ping() and SignDocDocumentLoader.pingMemory(). |
|
PDF document. | |
| TIFF |
TIFF document. |
| Other |
Other document. |
| FDF |
FDF document. |
|
strong |
Vertical alignment for SignDocDocument.addTextRect() and SignDocDocument.addTextRect2().
| Enumerator | |
|---|---|
| Top |
Align top. |
| Center |
Center. |
| Bottom |
Align bottom. |
|
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. |
|
strong |
|
strong |
|
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.
|
strong |
|
strong |
Field types.
Most field types are supported for PDF documents only.
|
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. |
|
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.
|
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.
|
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.
|
strong |
Flag for FindTextOccurrence.getBoundingBoxes().
Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.
|
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.
| 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. |
|
strong |
Return values of SignDocImageParameters.getType().
|
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.
|
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). |
|
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.
|
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. |
|
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. |
|
strong |
Indicate how measurements are specified.
| 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. |
|
strong |
|
strong |
Fields to be locked when signing this signature field.
| 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. |
|
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". |
|
strong |
Return values of SignDocMatchParameters.getType().
| Enumerator | |
|---|---|
| Undefined |
The specified parameter is not defined. |
| Boolean |
Boolean.
|
| Integer |
Integer.
|
|
strong |
|
strong |
Optimization of document before signing.
Used for integer parameter "Optimize" of SignDocSignatureParameters.
|
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.
|
strong |
|
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. |
|
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. |
|
strong |
Values for integer parameter "RemoveXFA" of SignDocSignatureParameters.
| 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. |
|
strong |
Return values of SignDocRenderParameters.getType().
|
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.
|
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. |
| 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. |
| InvalidStructure |
Invalid logical structure (28). The document has invalid logical structure. |
| UnknownParameter |
Unknown parameter (29). The specified parameter (aName) is unknown. For 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(). |
|
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).
|
| 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.
|
| 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.
|
| 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. |
|
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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
|
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), secp256r1 (prime256v1), 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.
|
|
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.
|
| iso_19785_3_none |
Blob format: No ISO/IEC 19785-3:2015 (CBEFF) wrapper. This should be used with SignatureDataFormat.iso_19794_7_2014 (version 2) only as ISO/IEC 19794-7:2007 (version 1) requires a CBEFF wrapper. However, some products accept only unwrapped version 1 BDBs.
|
| 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 or SignatureDataFormat.iso_19794_7_2014. With SignatureDataFormat.iso_19794_7_2007tc1, this patron format cannot be used for saving references.
|
| 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 or SignatureDataFormat.iso_19794_7_2014. With SignatureDataFormat.iso_19794_7_2007tc1, this patron format cannot be used for saving references.
|
| 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 or SignatureDataFormat.iso_19794_7_2014. Both signatures and references can be saved with this patron format.
|
| 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). 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_full |
Blob format: ISO/IEC 19794-7 full format. To be used with either SignatureDataFormat.iso_19794_7_2007tc1 or SignatureDataFormat.iso_19794_7_2014. Contrast with compact format, compression format, and XML, all of which are not yet supported.
|
| 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.
|
| 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:
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.
|
| 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:
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.
|
| 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:
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.
|
|
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. |
|
strong |
Horizontal alignment.
Used for integer parameters "ImageHAlignment" and "TextHAlignment" of SignDocSignatureParameters and for SignDocSignatureParameters.addTextItem2().
|
strong |
Vertical alignment.
Used for integer parameters "ImageVAlignment" and "TextVAlignment" of SignDocSignatureParameters.
| Enumerator | |
|---|---|
| Top |
Align top. |
| Center |
Center. |
| Bottom |
Align bottom. |
|
strong |
Return values of SignDocSignatureParameters.getType().
|
strong |
State of a signature.
|
strong |
|
strong |
Signing methods.
Used for integer parameter "Method" of SignDocSignatureParameters and by SignDocVerificationResult.getMethod().
| 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. |
|
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. |
|
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 slave group cannot be greater than the font size of the master group, that is, long text in the slave group won't reduce the font size of the master group.
There must be at least one master text item if there is a slave text item.
| Enumerator | |
|---|---|
| Master |
Master group. |
| Slave |
Slave group. |
|
strong |
Paragraph direction of a text item.
|
strong |
Position of the text block w.r.t. to the image.
Used for integer parameter "TextPosition" of SignDocSignatureParameters.
|
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. |
|
strong |
Return value of TimeStamper.stamp().
|
strong |
|
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. |
|
strong |
Flags for certificate verification.
Bitwise combination of values with the | operator is possible due to the System.FlagsAttribute attribute being set.
| Enumerator | |
|---|---|
| Zero |
No flags set. |
| CheckRevocation |
Check the revocation state of the certificates. |
| 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()). |
|
strong |
Values for integer parameter "VerificationModel" of SignDocVerificationParameters.
|
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. |
|
strong |
|
strong |
|
strong |
|
strong |
|
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.
| Enumerator | |
|---|---|
| Zero |
No flags set. |
| Invisible |
Do not display non-standard annotation. |
| Hidden |
Do not display or print or interact. |
|
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. |
1.8.9.1 
