com.groupdocs.signature.options

Class SignImageOptions

    • Constructor Detail

      • SignImageOptions

        public SignImageOptions()

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

      • SignImageOptions

        public SignImageOptions(String imageGuid)

        Initializes a new instance of the SignImageOptions class with image file.

        Parameters:
        imageGuid - Image file GUID
      • SignImageOptions

        public SignImageOptions(InputStream imageStream)

        Initializes a new instance of the SignImageOptions class with image stream.

        Parameters:
        imageStream - Image stream
    • Method Detail

      • setImage

        @Deprecated
        public void setImage(String imageFileGuid)
        Deprecated. 

        Set signature image with image file.

        Parameters:
        imageFileGuid - Image file GUID
      • setImage

        @Deprecated
        public void setImage(InputStream imageStream)
        Deprecated. 

        Set signature image with image stream.

        Parameters:
        imageStream - Image stream
      • getImageFileName

        @Deprecated
        public String getImageFileName()
        Deprecated. 

        Gets or sets the signature image file name. This property is used only if ImageStream is not specified.

      • setImageFileName

        @Deprecated
        public void setImageFileName(String value)
        Deprecated. 

        Gets or sets the signature image file name. This property is used only if ImageStream is not specified.

      • getImageGuid

        public String getImageGuid()

        Gets or sets the signature image file name. This property is used only if ImageStream is not specified.

      • setImageGuid

        public void setImageGuid(String value)

        Gets or sets the signature image file name. This property is used only if ImageStream is not specified.

      • getImageStream

        public InputStream getImageStream()

        Gets or sets the signature image stream. If this property is specified it is always used instead ImageFileName.

      • getImageStreamInternal

        public com.aspose.ms.System.IO.Stream getImageStreamInternal()
      • setImageStream

        public void setImageStream(InputStream value)

        Gets or sets the signature image stream. If this property is specified it is always used instead ImageFileName.

      • setImageStreamInternal

        public void setImageStreamInternal(com.aspose.ms.System.IO.Stream value)
      • getLeft

        public int getLeft()

        Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType). (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). (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). (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). (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).

        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).

        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).

        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).

        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
      • getOpacity

        public double getOpacity()

        Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.

        Specified by:
        getOpacity in interface IOpacity
        Overrides:
        getOpacity in class SignOptions
      • setOpacity

        public void setOpacity(double value)

        Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.

        Specified by:
        setOpacity in interface IOpacity
      • getSignAllPages

        public boolean getSignAllPages()

        Put signature on all document pages.

      • setSignAllPages

        public void setSignAllPages(boolean value)

        Put signature on all document pages.

      • getRectangle

        public Rectangle getRectangle()

        Rectangle of area to put the image on document.

      • getStream

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

        Gets image Stream for sign.

      • isHorizontalAlignmentSet

        public boolean isHorizontalAlignmentSet()

        Indicates if user set horizontal alignment.

      • isVerticalAlignmentSet

        public boolean isVerticalAlignmentSet()

        Indicates if user set vertical alignment.

      • 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
      • hasImage

        public boolean hasImage()

        Indicates if options has an image.

      • getImageBorder

        public com.groupdocs.signature.domain.ImageBorderData getImageBorder()

        Gets image border data.

        Overrides:
        getImageBorder in class SignOptions