ImageSignOptions (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- com.groupdocs.signature.options.sign.SignOptions
- - com.groupdocs.signature.options.sign.ImageSignOptions

All Implemented Interfaces:

com.aspose.ms.System.IDisposable, IAlignment, IRectangle, IRotation, ITransparency

Direct Known Subclasses:

DigitalSignOptions, StampSignOptions
```
public class ImageSignOptions
extends SignOptions
implements IRectangle, IAlignment, IRotation, ITransparency, com.aspose.ms.System.IDisposable
```
Represents the Image signature options.

Constructor Summary

Constructors
Constructor and Description
`ImageSignOptions()` Initializes a new instance of the ImageSignOptions class with default values.
`ImageSignOptions(InputStream imageStream)` Initializes a new instance of the ImageSignOptions class with image stream.
`ImageSignOptions(String imageFilePath)` Initializes a new instance of the ImageSignOptions class with image file.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Clears internal resources
`static ImageSignOptions`	`fromBase64(String base64Content)` Creates a new instance of the ImageSignOptions class with predefined Image from Base64.
`Border`	`getBorder()` Specify border settings
`int`	`getHeight()` Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType).
`int`	`getHorizontalAlignment()` Horizontal alignment of signature on document page.
`String`	`getImageFilePath()` Gets or sets the signature image file path.
`InputStream`	`getImageStream()` Gets or sets the signature image stream.
`int`	`getLeft()` Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType).
`int`	`getLocationMeasureType()` Measure type (pixels, percents or millimeters) for Left and Top properties.
`Padding`	`getMargin()` Gets or sets the space between Sign and Document edges.
`int`	`getMarginMeasureType()` Gets or sets the measure type (pixels, percents or millimeters) for Margin.
`Rectangle`	`getRectangle()` Rectangle of area to put the image on document.
`int`	`getRotationAngle()` Rotation angle of signature on document page (clockwise).
`int`	`getShapePosition()` Defines where shape should be presented in the document layout
`int`	`getSizeMeasureType()` Measure type (pixels, percents or millimeters) for Width and Height properties.
`int`	`getStretch()` Stretch mode on Document Page.
`int`	`getTop()` Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType).
`double`	`getTransparency()` Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
`int`	`getVerticalAlignment()` Vertical alignment of signature on document page.
`int`	`getWidth()` Width of Signature on Document Page in Measure values (pixels, percents or millimeters `MeasureType` SizeMeasureType).
`void`	`setBorder(Border value)` Specify border settings
`void`	`setHeight(int value)` Height of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` SizeMeasureType).
`void`	`setHorizontalAlignment(int value)` Horizontal alignment of signature on document page.
`void`	`setImageFilePath(String value)` Gets or sets the signature image file path.
`void`	`setImageStream(InputStream value)` Gets or sets the signature image stream.
`void`	`setLeft(int value)` Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType).
`void`	`setLocationMeasureType(int value)` Measure type (pixels, percents or millimeters) for Left and Top properties.
`void`	`setMargin(Padding value)` Gets or sets the space between Sign and Document edges.
`void`	`setMarginMeasureType(int value)` Gets or sets the measure type (pixels, percents or millimeters) for Margin.
`void`	`setRotationAngle(int value)` Rotation angle of signature on document page (clockwise).
`void`	`setShapePosition(int value)` Defines where shape should be presented in the document layout
`void`	`setSizeMeasureType(int value)` Measure type (pixels, percents or millimeters) for Width and Height properties.
`void`	`setStretch(int value)` Stretch mode on Document Page.
`void`	`setTop(int value)` Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see `MeasureType` LocationMeasureType).
`void`	`setTransparency(double value)` Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
`void`	`setVerticalAlignment(int value)` Vertical alignment of signature on document page.
`void`	`setWidth(int value)` Width of Signature on Document Page in Measure values (pixels, percents or millimeters `MeasureType` SizeMeasureType).
`String`	`toString()` Override string conversion.

Methods inherited from class com.groupdocs.signature.options.sign.SignOptions
addSignature, getAllPages, getAppearance, getDocumentType, getExtensions, getPageNumber, getPagesSetup, getSignatureType, getZOrder, setAllPages, setAppearance, setDocumentType, setExtensions, setPageNumber, setPagesSetup, setZOrder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ImageSignOptions
```
public ImageSignOptions()
```
    Initializes a new instance of the ImageSignOptions class with default values.
  - ImageSignOptions
```
public ImageSignOptions(InputStream imageStream)
```
    Initializes a new instance of the ImageSignOptions class with image stream.
    
    Parameters:
    
    imageStream - Image stream
  - ImageSignOptions
```
public ImageSignOptions(String imageFilePath)
```
    Initializes a new instance of the ImageSignOptions class with image file.
    
    Parameters:
    
    imageFilePath - Image file path
- Method Detail
  - dispose
```
public final void dispose()
```
    Clears internal resources
    
    Specified by:
    
    dispose in interface com.aspose.ms.System.IDisposable
  - fromBase64
```
public static ImageSignOptions fromBase64(String base64Content)
```
    Creates a new instance of the ImageSignOptions class with predefined Image from Base64.
    
    Parameters:
    
    base64Content - Image content in Base64 string format
    
    Returns:
  - getBorder
```
public final Border getBorder()
```
    Specify border settings
    
    Returns:
  - 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
  - getImageFilePath
```
public final String getImageFilePath()
```
    Gets or sets the signature image file path. This property is used only if ImageStream is not specified.
  - getImageStream
```
public final InputStream getImageStream()
```
    Gets or sets the signature image stream. If this property is specified it is always used instead ImageGuid.
    
    Overrides:
    
    getImageStream in class SignOptions
  - 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
  - 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
  - getShapePosition
```
public final int getShapePosition()
```
    Defines where shape should be presented in the document layout
  - 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
  - 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
  - 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 MeasureType SizeMeasureType).
    
    Specified by:
    
    getWidth in interface IRectangle
  - setBorder
```
public final void setBorder(Border value)
```
    Specify border settings
  - 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
  - setImageFilePath
```
public final void setImageFilePath(String value)
```
    Gets or sets the signature image file path. 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
  - setRotationAngle
```
public final void setRotationAngle(int value)
```
    Rotation angle of signature on document page (clockwise).
    
    Specified by:
    
    setRotationAngle in interface IRotation
  - setShapePosition
```
public final void setShapePosition(int value)
```
    Defines where shape should be presented in the document layout
  - 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
  - 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
  - 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 MeasureType SizeMeasureType).
    
    Specified by:
    
    setWidth in interface IRectangle
  - toString
```
public String toString()
```
    Override string conversion.
    
    Overrides:
    
    toString in class SignOptions
    
    Returns:

Class ImageSignOptions

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.signature.options.sign.SignOptions

Methods inherited from class java.lang.Object

Constructor Detail

ImageSignOptions

ImageSignOptions

ImageSignOptions

Method Detail

dispose

fromBase64

getBorder

getHeight

getHorizontalAlignment

getImageFilePath

getImageStream

getLeft

getLocationMeasureType

getMargin

getMarginMeasureType

getRectangle

getRotationAngle

getShapePosition

getSizeMeasureType

getStretch

getTop

getTransparency

getVerticalAlignment

getWidth

setBorder

setHeight

setHorizontalAlignment

setImageFilePath

setImageStream

setLeft

setLocationMeasureType

setMargin

setMarginMeasureType

setRotationAngle

setShapePosition

setSizeMeasureType

setStretch

setTop

setTransparency

setVerticalAlignment

setWidth

toString