com.groupdocs.signature.options.sign

Class TextSignOptions

    • Field Detail

    • Constructor Detail

      • TextSignOptions

        public TextSignOptions()

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

      • TextSignOptions

        public TextSignOptions(String text)

        Initializes a new instance of the SignTextOptions class with text.

        Parameters:
        text - Signature text.
    • Method Detail

      • getBackground

        public final Background getBackground()

        Gets or sets the signature background settings.

      • getBorder

        public final Border getBorder()

        Specify border settings

        Returns:
      • getFont

        public final SignatureFont getFont()

        Gets or sets the font of signature.

      • getForeColor

        public Color getForeColor()

        Gets or sets the fore color of signature.

      • 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 SignatureImplementation = 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 SignatureImplementation = TextToFormField. Value by default is AllTextTypes.

      • getHeight

        public final int getHeight()

        Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

        Specified by:
        getHeight in interface IRectangle
      • getHorizontalAlignment

        public final int getHorizontalAlignment()

        Horizontal alignment of signature on document page.

        Specified by:
        getHorizontalAlignment in interface IAlignment
      • getLeft

        public final int getLeft()

        Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).

        Specified by:
        getLeft in interface IRectangle
      • getLocationMeasureType

        public int getLocationMeasureType()

        Measure type (pixels, percents or millimeters) for Left and Top properties.

        Specified by:
        getLocationMeasureType in interface IRectangle
      • getMargin

        public Padding getMargin()

        Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

        Specified by:
        getMargin in interface IAlignment
      • getMarginMeasureType

        public int getMarginMeasureType()

        Gets or sets the measure type (pixels, percents or millimeters) for Margin.

        Specified by:
        getMarginMeasureType in interface IAlignment
      • getNative

        public final boolean getNative()

        Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.

      • getRotationAngle

        public final int getRotationAngle()

        Rotation angle of signature on document page (clockwise).

        Specified by:
        getRotationAngle in interface IRotation
      • getShapeType

        public final int getShapeType()

        Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

      • getSignatureID

        public final int getSignatureID()

        Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

      • getSignatureImplementation

        public final int getSignatureImplementation()

        Gets or sets the type of text signature implementation.

      • getSizeMeasureType

        public int getSizeMeasureType()

        Measure type (pixels, percents or millimeters) for Width and Height properties.

        Specified by:
        getSizeMeasureType in interface IRectangle
      • getStretch

        public final int getStretch()

        Stretch mode on Document Page.

        Specified by:
        getStretch in interface IRectangle
      • getText

        public final String getText()

        Gets or sets the text of signature.

      • getTextHorizontalAlignment

        public final int getTextHorizontalAlignment()

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

      • getTextVerticalAlignment

        public final int getTextVerticalAlignment()

        Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see TextSignatureImplementation SignatureImplementation property).

      • getTop

        public final int getTop()

        Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).

        Specified by:
        getTop in interface IRectangle
      • getTransparency

        public final double getTransparency()

        Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

        Specified by:
        getTransparency in interface ITransparency
      • getVerticalAlignment

        public final int getVerticalAlignment()

        Vertical alignment of signature on document page.

        Specified by:
        getVerticalAlignment in interface IAlignment
      • getWidth

        public final int getWidth()

        Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

        Specified by:
        getWidth in interface IRectangle
      • getZOrder

        public final int getZOrder()

        Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.

      • setBackground

        public final void setBackground(Background value)

        Gets or sets the signature background settings.

      • setBorder

        public final void setBorder(Border value)

        Specify border settings

      • setFont

        public final void setFont(SignatureFont value)

        Gets or sets the font of signature.

      • setForeColor

        public void setForeColor(Color value)

        Gets or sets the fore color of signature.

      • 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 SignatureImplementation = 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 SignatureImplementation = TextToFormField. Value by default is AllTextTypes.

      • setHeight

        public final void setHeight(int value)

        Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

        Specified by:
        setHeight in interface IRectangle
      • setHorizontalAlignment

        public final void setHorizontalAlignment(int value)

        Horizontal alignment of signature on document page.

        Specified by:
        setHorizontalAlignment in interface IAlignment
      • setLeft

        public final void setLeft(int value)

        Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).

        Specified by:
        setLeft in interface IRectangle
      • setLocationMeasureType

        public void setLocationMeasureType(int value)

        Measure type (pixels, percents or millimeters) for Left and Top properties.

        Specified by:
        setLocationMeasureType in interface IRectangle
      • setMargin

        public void setMargin(Padding value)

        Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

        Specified by:
        setMargin in interface IAlignment
      • setMarginMeasureType

        public void setMarginMeasureType(int value)

        Gets or sets the measure type (pixels, percents or millimeters) for Margin.

        Specified by:
        setMarginMeasureType in interface IAlignment
      • setNative

        public final void setNative(boolean value)

        Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.

      • setRotationAngle

        public final void setRotationAngle(int value)

        Rotation angle of signature on document page (clockwise).

        Specified by:
        setRotationAngle in interface IRotation
      • setShapeType

        public final void setShapeType(int value)

        Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

      • setSignatureID

        public final void setSignatureID(int value)

        Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

      • setSignatureImplementation

        public final void setSignatureImplementation(int value)

        Gets or sets the type of text signature implementation.

      • setSizeMeasureType

        public void setSizeMeasureType(int value)

        Measure type (pixels, percents or millimeters) for Width and Height properties.

        Specified by:
        setSizeMeasureType in interface IRectangle
      • setStretch

        public final void setStretch(int value)

        Stretch mode on Document Page.

        Specified by:
        setStretch in interface IRectangle
      • setText

        public final void setText(String value)

        Gets or sets the text of signature.

      • 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 TextSignatureImplementation SignatureImplementation property).

      • setTextVerticalAlignment

        public final void setTextVerticalAlignment(int value)

        Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see TextSignatureImplementation SignatureImplementation property).

      • setTop

        public final void setTop(int value)

        Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).

        Specified by:
        setTop in interface IRectangle
      • setTransparency

        public final void setTransparency(double value)

        Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

        Specified by:
        setTransparency in interface ITransparency
      • setVerticalAlignment

        public final void setVerticalAlignment(int value)

        Vertical alignment of signature on document page.

        Specified by:
        setVerticalAlignment in interface IAlignment
      • setWidth

        public final void setWidth(int value)

        Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

        Specified by:
        setWidth in interface IRectangle
      • setZOrder

        public final void setZOrder(int value)

        Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.

      • validate

        public void validate()

        Internal method to validate the options parameters.

        Overrides:
        validate in class SignOptions