Aspose::Pdf::InteractiveFeatures::Forms Namespace Reference

Classes

class  BarcodeField
 Class represents barcode field. More...
 
class  ButtonField
 Class represnets push button field. More...
 
class  CheckboxField
 Class representing checkbox field More...
 
class  ChoiceField
 Represents base class for choice fields. More...
 
class  ComboBoxField
 Class representing Combobox field of the form. More...
 
class  DocMDPSignature
 Represents the class of document MDP (modification detection and prevention) signature type. More...
 
class  Field
 Base class for acro form fields. More...
 
class  FileSelectBoxField
 Field for file select box element. More...
 
class  Form
 Class representing form object. More...
 
class  IconFit
 Describes how the widget annotation's icon shall be displayed within its annotation rectangle. More...
 
class  ListBoxField
 Class represents ListBox field. More...
 
class  NamespaceDoc
 The Aspose.Pdf.InteractiveFeatures.Forms namespace has classes which describes forms (standard, static, dynamic) and various types of fields like text box, list box, radio button etc. More...
 
class  Option
 Class represents option of choice field. More...
 
class  OptionCollection
 Class representing collection of options of the choice field. More...
 
class  PasswordBoxField
 Class descibes text field for entering password. More...
 
class  PKCS1
 Represents signature object regarding PKCS#1 standard. RSA encryption algorithm and SHA-1 digest method are used for signing. More...
 
class  PKCS7
 Represents the PKCS#7 object that conform to the PKCS#7 specification in Internet RFC 2315, PKCS #7: Cryptographic Message Syntax, Version 1.5. The SHA1 digest of the document's byte range is encapsulated in the PKCS#7 SignedData field. More...
 
class  PKCS7Detached
 Represents the PKCS#7 object that conform to the PKCS#7 specification in Internet RFC 2315, PKCS #7: Cryptographic Message Syntax, Version 1.5. The original signed message digest over the document's byte range is incorporated as the normal PKCS#7 SignedData field. No data shall is encapsulated in the PKCS#7 SignedData field. More...
 
class  RadioButtonField
 Class representing radio button field. More...
 
class  RadioButtonOptionField
 Class represents item of RadioButton field. More...
 
class  RichTextBoxField
 Class describes rich text editor component. More...
 
class  Signature
 An abstract class which represents signature object in the pdf document. Signatures are fields with values of signature objects, the last contain data which is used to verify the document validity. More...
 
class  SignatureField
 Represents signature form field. More...
 
class  SymbologyConverter
 
class  TextBoxField
 Class representing text box field. More...
 
class  XFA
 Represents XML form regarding XML Forms Architecture (XFA). More...
 

Enumerations

enum  BoxStyle {
  BoxStyle::Circle, BoxStyle::Check, BoxStyle::Cross, BoxStyle::Diamond,
  BoxStyle::Square, BoxStyle::Star
}
 Represents styles of check box More...
 
enum  DocMDPAccessPermissions { DocMDPAccessPermissions::NoChanges = 1, DocMDPAccessPermissions::FillingInForms, DocMDPAccessPermissions::AnnotationModification }
 The access permissions granted for this document. Valid values are: 1 - No changes to the document are permitted; any change to the document invalidates the signature. 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature. 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature. More...
 
enum  FormType { FormType::Standard, FormType::Static, FormType::Dynamic }
 Enumeration of posible types of Acro Form. More...
 
enum  IconCaptionPosition {
  IconCaptionPosition::NoIcon, IconCaptionPosition::NoCaption, IconCaptionPosition::CaptionBelowIcon, IconCaptionPosition::CaptionAboveIcon,
  IconCaptionPosition::CaptionToTheRight, IconCaptionPosition::CaptionToTheLeft, IconCaptionPosition::CaptionOverlaid
}
 Describes position of icon. More...
 
enum  ScalingMode { ScalingMode::Proportional, ScalingMode::Anamorphic }
 The type of scaling that shall be used. More...
 
enum  ScalingReason { ScalingReason::Always, ScalingReason::IconIsBigger, ScalingReason::IconIsSmaller, ScalingReason::Never }
 The circumstances under which the icon shall be scaled inside the annotation rectangle. More...
 
enum  Symbology { Symbology::PDF417, Symbology::QRCode, Symbology::DataMatrix }
 A (Barcode) Symbology defines the technical details of a particular type of barcode: the width of the bars, character set, method of encoding, checksum specifications, etc. More...
 

Enumeration Type Documentation

◆ BoxStyle

Represents styles of check box

Enumerator
Circle 

Circle style.

Check 

Check style.

Cross 

Cross style.

Diamond 

Diamond style.

Square 

Square style.

Star 

Star style.

◆ DocMDPAccessPermissions

The access permissions granted for this document. Valid values are: 1 - No changes to the document are permitted; any change to the document invalidates the signature. 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature. 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.

Enumerator
NoChanges 

1 - No changes to the document are permitted; any change to the document invalidates the signature.

FillingInForms 

2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.

AnnotationModification 

3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.

◆ FormType

Enumeration of posible types of Acro Form.

Enumerator
Standard 

Standard AcroForm.

Static 

Static XFA form.

Dynamic 

Dynamic XFA form.

◆ IconCaptionPosition

Describes position of icon.

Enumerator
NoIcon 

Icon is not displayed.

NoCaption 

Caption is not displayed.

CaptionBelowIcon 

Caption is below icon.

CaptionAboveIcon 

Caption is above icon.

CaptionToTheRight 

Caption to the right.

CaptionToTheLeft 

Caption to the left.

CaptionOverlaid 

Caption over laid.

◆ ScalingMode

The type of scaling that shall be used.

Enumerator
Proportional 

Scale the icon to fit the width or height of the annotation rectangle while maintaining the icon�s original aspect ratio.

Anamorphic 

Scale the icon to fill the annotation rectangle exactly.

◆ ScalingReason

The circumstances under which the icon shall be scaled inside the annotation rectangle.

Enumerator
Always 

Always scale.

IconIsBigger 

BScale only when the icon is bigger than the annotation rectangle.

IconIsSmaller 

Scale only when the icon is smaller than the annotation rectangle.

Never 

Never scale.

◆ Symbology

A (Barcode) Symbology defines the technical details of a particular type of barcode: the width of the bars, character set, method of encoding, checksum specifications, etc.

Enumerator
PDF417 

A multi-row, variable-length 2D symbology with high data capacity and error-correction capability.

QRCode 

QR code (short for Quick Response) is a specific matrix barcode (2D code), readable by dedicated QR barcode readers and camera phones.

DataMatrix 

A 2D matrix symbology consisting of black and white square modules arranged in either a square or rectangular pattern.