Packages

 

com.groupdocs.signature.options.textsignature

Class PdfSignTextOptions

    • Constructor Detail

      • PdfSignTextOptions

        public PdfSignTextOptions()

        Initializes a new instance of the PdfSignTextOptions class with default values.

      • PdfSignTextOptions

        public PdfSignTextOptions(String text)

        Initializes a new instance of the PdfSignTextOptions class with text.

        Parameters:
        text - Signature text
      • PdfSignTextOptions

        public PdfSignTextOptions(String text,
                          int left,
                          int top,
                          int width,
                          int height)

        Initializes a new instance of the PdfSignTextOptions class with text and signature area rectangle.

        Parameters:
        text - Text signature.
        left - The x-coordinate of the left edge of this Text Signature.
        top - The y-coordinate of the top edge of this Text Signature.
        width - The width of Text Signature.
        height - The height of Text Signature.
    • Method Detail

      • getBackgroundBrushStyle

        public Brush getBackgroundBrushStyle()

        Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For Stamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. It is not used for Annotation, Sticker, TextToFormField and Watermark implementations.

        Overrides:
        getBackgroundBrushStyle in class SignTextOptions
      • getFormTextFieldTitle

        public final String getFormTextFieldTitle()

        Gets or sets the title of text form field to put text signature into it. This property could be used only with PdfTextSignatureImplementation = TextToFormField.

      • getFormTextFieldType

        public final int getFormTextFieldType()

        Gets or sets the type of form field to put text signature into it. This property could be used only with PdfTextSignatureImplementation = TextToFormField. Value by default is AllTextTypes.

      • getOpacity

        public final double getOpacity()

        Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.

        Specified by:
        getOpacity in interface IOpacity
      • getSignatureID

        public final int getSignatureID()

        Gets or sets the unique ID of signature. It can be used in signature verification options.

      • getSignatureImplementation

        public final int getSignatureImplementation()

        Gets or sets the type of text signature implementation.

      • setBackgroundBrushStyle

        public void setBackgroundBrushStyle(Brush value)

        Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For Stamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. It is not used for Annotation, Sticker, TextToFormField and Watermark implementations.

        Overrides:
        setBackgroundBrushStyle in class SignTextOptions
      • setFormTextFieldTitle

        public final void setFormTextFieldTitle(String value)

        Gets or sets the title of text form field to put text signature into it. This property could be used only with PdfTextSignatureImplementation = TextToFormField.

      • setFormTextFieldType

        public final void setFormTextFieldType(int value)

        Gets or sets the type of form field to put text signature into it. This property could be used only with PdfTextSignatureImplementation = TextToFormField. Value by default is AllTextTypes.

      • setOpacity

        public final void setOpacity(double value)

        Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.

        Specified by:
        setOpacity in interface IOpacity
      • setSignatureID

        public final void setSignatureID(int value)

        Gets or sets the unique ID of signature. It can be used in signature verification options.

      • setSignatureImplementation

        public final void setSignatureImplementation(int value)

        Gets or sets the type of text signature implementation.

      • setTextHorizontalAlignment

        public final void setTextHorizontalAlignment(int value)

        Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see PdfTextSignatureImplementation SignatureImplementation property).

        Specified by:
        setTextHorizontalAlignment in interface ITextAlignment