Packages

 

com.groupdocs.signature.options.imagesignature

Class SignImageOptions

    • Constructor Detail

      • SignImageOptions

        public SignImageOptions()

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

      • SignImageOptions

        public SignImageOptions(InputStream imageStream)

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

        Parameters:
        imageStream - Image stream
      • SignImageOptions

        public SignImageOptions(String imageGuid)

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

        Parameters:
        imageGuid - Image file GUID
    • Method Detail

      • getHeight

        public final int getHeight()

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

        Specified by:
        getHeight in interface IRectangle
      • getHorizontalAlignment

        public final int getHorizontalAlignment()

        Horizontal alignment of signature on document page.

        Specified by:
        getHorizontalAlignment in interface IAlignment
      • getImageGuid

        public final String getImageGuid()

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

      • getImageHelper

        protected com.groupdocs.signature.domain.helpers.ImageHelper getImageHelper()
      • getImageStream

        public final InputStream getImageStream()

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

      • getLeft

        public int getLeft()

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

        public final 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
      • getRectangle

        public final Rectangle getRectangle()

        Rectangle of area to put the image on document.

      • getRotationAngle

        public final int getRotationAngle()

        Rotation angle of signature on document page (clockwise).

        Specified by:
        getRotationAngle in interface IRotation
      • getSignAllPages

        public boolean getSignAllPages()

        Put signature on all document pages.

      • getSizeMeasureType

        public int getSizeMeasureType()

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

        Specified by:
        getSizeMeasureType in interface IRectangle
      • getStretch

        public int getStretch()

        Stretch mode on Document Page.

        Specified by:
        getStretch in interface IRectangle
      • getTop

        public int getTop()

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

        Specified by:
        getTop in interface IRectangle
      • 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 MeasureType SizeMeasureType).

        Specified by:
        getWidth in interface IRectangle
      • setHeight

        public final void setHeight(int value)

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

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

        public final void setImageGuid(String value)

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

      • setImageStream

        public final void setImageStream(InputStream value)

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

      • setLeft

        public void setLeft(int value)

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

        public final 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
      • setRotationAngle

        public final void setRotationAngle(int value)

        Rotation angle of signature on document page (clockwise).

        Specified by:
        setRotationAngle in interface IRotation
      • setSignAllPages

        public void setSignAllPages(boolean value)

        Put signature on all document pages.

      • 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 void setStretch(int value)

        Stretch mode on Document Page.

        Specified by:
        setStretch in interface IRectangle
      • setTop

        public void setTop(int value)

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

        Specified by:
        setTop in interface IRectangle
      • 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 MeasureType SizeMeasureType).

        Specified by:
        setWidth in interface IRectangle