com.groupdocs.signature.options

Class SignTextOptions

    • Field Detail

      • DEFAULT_FORE_COLOR

        public static final com.aspose.ms.System.Drawing.Color DEFAULT_FORE_COLOR
      • DEFAULT_BKGR_COLOR

        public static final com.aspose.ms.System.Drawing.Color DEFAULT_BKGR_COLOR
    • Constructor Detail

      • SignTextOptions

        public SignTextOptions()

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

      • SignTextOptions

        public SignTextOptions(String text)

        Initializes a new instance of the SignTextOptions class with text.

        Parameters:
        text - Signature text
    • Method Detail

      • getLeft

        public int getLeft()

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

        Specified by:
        getLeft in interface IRectangle
      • setLeft

        public void setLeft(int value)

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

        Specified by:
        setLeft in interface IRectangle
      • getTop

        public int getTop()

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

        Specified by:
        getTop in interface IRectangle
      • setTop

        public void setTop(int value)

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

        Specified by:
        setTop in interface IRectangle
      • getWidth

        public int getWidth()

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

        Specified by:
        getWidth in interface IRectangle
      • setWidth

        public void setWidth(int value)

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

        Specified by:
        setWidth in interface IRectangle
      • getHeight

        public int getHeight()

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

        Specified by:
        getHeight in interface IRectangle
      • setHeight

        public void setHeight(int value)

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

        Specified by:
        setHeight in interface IRectangle
      • getLocationMeasureType

        public int getLocationMeasureType()

        Measure type (pixels or percent) for Left and Top properties.

        Specified by:
        getLocationMeasureType in interface IRectangle
      • setLocationMeasureType

        public void setLocationMeasureType(int value)

        Measure type (pixels or percent) for Left and Top properties.

        Specified by:
        setLocationMeasureType in interface IRectangle
      • getSizeMeasureType

        public int getSizeMeasureType()

        Measure type (pixels or percent) for Width and Height properties.

        Specified by:
        getSizeMeasureType in interface IRectangle
      • setSizeMeasureType

        public void setSizeMeasureType(int value)

        Measure type (pixels or percent) for Width and Height properties.

        Specified by:
        setSizeMeasureType in interface IRectangle
      • getRotationAngle

        public int getRotationAngle()

        Rotation angle of signature on document page (clockwise).

        Specified by:
        getRotationAngle in interface IRotation
      • setRotationAngle

        public void setRotationAngle(int value)

        Rotation angle of signature on document page (clockwise).

        Specified by:
        setRotationAngle in interface IRotation
      • getHorizontalAlignment

        public int getHorizontalAlignment()

        Horizontal alignment of signature on document page.

        Specified by:
        getHorizontalAlignment in interface IAlignment
      • setHorizontalAlignment

        public void setHorizontalAlignment(int value)

        Horizontal alignment of signature on document page.

        Specified by:
        setHorizontalAlignment in interface IAlignment
      • getVerticalAlignment

        public int getVerticalAlignment()

        Vertical alignment of signature on document page.

        Specified by:
        getVerticalAlignment in interface IAlignment
      • setVerticalAlignment

        public void setVerticalAlignment(int value)

        Vertical alignment of signature on document page.

        Specified by:
        setVerticalAlignment in interface IAlignment
      • 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
      • 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
      • getMarginMeasureType

        public int getMarginMeasureType()

        Gets or sets the measure type (pixels or percent) for Margin.

        Specified by:
        getMarginMeasureType in interface IAlignment
      • setMarginMeasureType

        public void setMarginMeasureType(int value)

        Gets or sets the measure type (pixels or percent) for Margin.

        Specified by:
        setMarginMeasureType in interface IAlignment
      • getText

        public String getText()

        Gets or sets the text of signature.

      • setText

        public void setText(String value)

        Gets or sets the text of signature.

      • getSignAllPages

        public boolean getSignAllPages()

        Put signature on all document pages.

      • setSignAllPages

        public void setSignAllPages(boolean value)

        Put signature on all document pages.

      • getFont

        public SignatureFont getFont()

        Gets or sets the font of signature.

      • setFont

        public void setFont(SignatureFont value)

        Gets or sets the font of signature.

      • getForeColor

        public Color getForeColor()

        Gets or sets the fore color of signature.

      • getForeColorInternal

        public com.aspose.ms.System.Drawing.Color getForeColorInternal()
      • setForeColor

        public void setForeColor(Color value)

        Gets or sets the fore color of signature.

      • getBorderColor

        public Color getBorderColor()

        Gets or sets the border color of signature.

      • getBorderColorInternal

        public com.aspose.ms.System.Drawing.Color getBorderColorInternal()
      • setBorderColor

        public void setBorderColor(Color value)

        Gets or sets the border color of signature.

      • getBackgroundColor

        public Color getBackgroundColor()

        Gets or sets the background color of signature.

      • getBackgroundColorInternal

        public com.aspose.ms.System.Drawing.Color getBackgroundColorInternal()
      • setBackgroundColor

        public void setBackgroundColor(Color value)

        Gets or sets the background color of signature.

      • getImageStream

        public com.aspose.ms.System.IO.Stream getImageStream()

        Gets the image stream.

      • getSpecificRectangle

        public com.aspose.ms.System.Drawing.Rectangle getSpecificRectangle()

        Gets or sets the signature rectangle.

      • setSpecificRectangle

        public void setSpecificRectangle(com.aspose.ms.System.Drawing.Rectangle value)

        Gets or sets the signature rectangle.

      • release

        public void release()

        Override method to clean up resources after each signing.

      • getSignPages

        public com.aspose.ms.System.Collections.Generic.List<Integer> getSignPages(int totalPages)

        Override method to get list of pages to sign.

        Overrides:
        getSignPages in class SignOptions
        Parameters:
        totalPages - Total count of pages
        Returns:
        List of page numbers
      • isHorizontalAlignmentSet

        public boolean isHorizontalAlignmentSet()

        Indicates if user set horizontal alignment.

      • isVerticalAlignmentSet

        public boolean isVerticalAlignmentSet()

        Indicates if user set vertical alignment.