public abstract class SignImageOptions extends SignOptions implements IRectangle, IAlignment, IRotation, IOpacity
Represents the Image Signature Options.
DEFAULT_PPM, imageBorderData
Constructor and Description |
---|
SignImageOptions()
Initializes a new instance of the SignImageOptions class with default values.
|
SignImageOptions(InputStream imageStream)
Initializes a new instance of the SignImageOptions class with image stream.
|
SignImageOptions(String imageGuid)
Initializes a new instance of the SignImageOptions class with image file.
|
Modifier and Type | Method and Description |
---|---|
int |
getHeight()
Height of Signature on Document Page in Measure values (pixels or percent see
MeasureType SizeMeasureType). |
int |
getHorizontalAlignment()
Horizontal alignment of signature on document page.
|
com.groupdocs.signature.domain.ImageBorderData |
getImageBorder()
Gets image border data.
|
String |
getImageFileName()
Deprecated.
|
String |
getImageGuid()
Gets or sets the signature image file name.
|
InputStream |
getImageStream()
Gets or sets the signature image stream.
|
com.aspose.ms.System.IO.Stream |
getImageStreamInternal() |
int |
getLeft()
Left X position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType). |
int |
getLocationMeasureType()
Measure type (pixels or percent) 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 or percent) for Margin.
|
double |
getOpacity()
Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)).
|
Rectangle |
getRectangle()
Rectangle of area to put the image on document.
|
int |
getRotationAngle()
Rotation angle of signature on document page (clockwise).
|
boolean |
getSignAllPages()
Put signature on all document pages.
|
com.aspose.ms.System.Collections.Generic.List<Integer> |
getSignPages(int totalPages)
Override method to get list of pages to sign.
|
int |
getSizeMeasureType()
Measure type (pixels or percent) for Width and Height properties.
|
com.aspose.ms.System.IO.Stream |
getStream()
Gets image Stream for sign.
|
int |
getTop()
Top Y Position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType). |
int |
getVerticalAlignment()
Vertical alignment of signature on document page.
|
int |
getWidth()
Width of Signature on Document Page in Measure values (pixels or percent see
MeasureType SizeMeasureType). |
boolean |
hasImage()
Indicates if options has an image.
|
boolean |
isHorizontalAlignmentSet()
Indicates if user set horizontal alignment.
|
boolean |
isVerticalAlignmentSet()
Indicates if user set vertical alignment.
|
void |
release()
Override method to clean up resources after each signing.
|
void |
setHeight(int value)
Height of Signature on Document Page in Measure values (pixels or percent see
MeasureType SizeMeasureType). |
void |
setHorizontalAlignment(int value)
Horizontal alignment of signature on document page.
|
void |
setImage(InputStream imageStream)
Deprecated.
|
void |
setImage(String imageFileGuid)
Deprecated.
|
void |
setImageFileName(String value)
Deprecated.
|
void |
setImageGuid(String value)
Gets or sets the signature image file name.
|
void |
setImageInternal(com.aspose.ms.System.IO.Stream imageStream) |
void |
setImageStream(InputStream value)
Gets or sets the signature image stream.
|
void |
setImageStreamInternal(com.aspose.ms.System.IO.Stream value) |
void |
setLeft(int value)
Left X position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType). |
void |
setLocationMeasureType(int value)
Measure type (pixels or percent) 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 or percent) for Margin.
|
void |
setOpacity(double value)
Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)).
|
void |
setRotationAngle(int value)
Rotation angle of signature on document page (clockwise).
|
void |
setSignAllPages(boolean value)
Put signature on all document pages.
|
void |
setSizeMeasureType(int value)
Measure type (pixels or percent) for Width and Height properties.
|
void |
setTop(int value)
Top Y Position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType). |
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 or percent see
MeasureType SizeMeasureType). |
String |
toString()
Override string conversion
|
getAppearance, getDocumentPageNumber, getDocumentPPM, getPagesSetup, getPropertyOrDefault, getPropertyOrDefault, getSignatureConfig, getSignPagesQueue, isRotationChanged, onError, setAppearance, setDocumentPageNumber, setPagesSetup, setRotationChanged, setSignatureConfig
public SignImageOptions()
Initializes a new instance of the SignImageOptions class with default values.
public SignImageOptions(String imageGuid)
Initializes a new instance of the SignImageOptions class with image file.
imageGuid
- Image file GUIDpublic SignImageOptions(InputStream imageStream)
Initializes a new instance of the SignImageOptions class with image stream.
imageStream
- Image stream@Deprecated public void setImage(String imageFileGuid)
Set signature image with image file.
imageFileGuid
- Image file GUID@Deprecated public void setImage(InputStream imageStream)
Set signature image with image stream.
imageStream
- Image streampublic void setImageInternal(com.aspose.ms.System.IO.Stream imageStream)
@Deprecated public String getImageFileName()
Gets or sets the signature image file name. This property is used only if ImageStream is not specified.
@Deprecated public void setImageFileName(String value)
Gets or sets the signature image file name. This property is used only if ImageStream is not specified.
public String getImageGuid()
Gets or sets the signature image file name. This property is used only if ImageStream is not specified.
public void setImageGuid(String value)
Gets or sets the signature image file name. This property is used only if ImageStream is not specified.
public InputStream getImageStream()
Gets or sets the signature image stream. If this property is specified it is always used instead ImageFileName.
public com.aspose.ms.System.IO.Stream getImageStreamInternal()
public void setImageStream(InputStream value)
Gets or sets the signature image stream. If this property is specified it is always used instead ImageFileName.
public void setImageStreamInternal(com.aspose.ms.System.IO.Stream value)
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).
getLeft
in interface IRectangle
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).
setLeft
in interface IRectangle
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).
getTop
in interface IRectangle
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).
setTop
in interface IRectangle
public int getWidth()
Width of Signature on Document Page in Measure values (pixels or percent see MeasureType
SizeMeasureType).
getWidth
in interface IRectangle
public void setWidth(int value)
Width of Signature on Document Page in Measure values (pixels or percent see MeasureType
SizeMeasureType).
setWidth
in interface IRectangle
public int getHeight()
Height of Signature on Document Page in Measure values (pixels or percent see MeasureType
SizeMeasureType).
getHeight
in interface IRectangle
public void setHeight(int value)
Height of Signature on Document Page in Measure values (pixels or percent see MeasureType
SizeMeasureType).
setHeight
in interface IRectangle
public int getLocationMeasureType()
Measure type (pixels or percent) for Left and Top properties.
getLocationMeasureType
in interface IRectangle
public void setLocationMeasureType(int value)
Measure type (pixels or percent) for Left and Top properties.
setLocationMeasureType
in interface IRectangle
public int getSizeMeasureType()
Measure type (pixels or percent) for Width and Height properties.
getSizeMeasureType
in interface IRectangle
public void setSizeMeasureType(int value)
Measure type (pixels or percent) for Width and Height properties.
setSizeMeasureType
in interface IRectangle
public int getRotationAngle()
Rotation angle of signature on document page (clockwise).
getRotationAngle
in interface IRotation
public void setRotationAngle(int value)
Rotation angle of signature on document page (clockwise).
setRotationAngle
in interface IRotation
public int getHorizontalAlignment()
Horizontal alignment of signature on document page.
getHorizontalAlignment
in interface IAlignment
public void setHorizontalAlignment(int value)
Horizontal alignment of signature on document page.
setHorizontalAlignment
in interface IAlignment
public int getVerticalAlignment()
Vertical alignment of signature on document page.
getVerticalAlignment
in interface IAlignment
public void setVerticalAlignment(int value)
Vertical alignment of signature on document page.
setVerticalAlignment
in interface IAlignment
public Padding getMargin()
Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
getMargin
in interface IAlignment
public void setMargin(Padding value)
Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
setMargin
in interface IAlignment
public int getMarginMeasureType()
Gets or sets the measure type (pixels or percent) for Margin.
getMarginMeasureType
in interface IAlignment
public void setMarginMeasureType(int value)
Gets or sets the measure type (pixels or percent) for Margin.
setMarginMeasureType
in interface IAlignment
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.
getOpacity
in interface IOpacity
getOpacity
in class SignOptions
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.
setOpacity
in interface IOpacity
public boolean getSignAllPages()
Put signature on all document pages.
public void setSignAllPages(boolean value)
Put signature on all document pages.
public Rectangle getRectangle()
Rectangle of area to put the image on document.
public com.aspose.ms.System.IO.Stream getStream() throws Exception
Gets image Stream for sign.
Exception
public boolean isHorizontalAlignmentSet()
Indicates if user set horizontal alignment.
public boolean isVerticalAlignmentSet()
Indicates if user set vertical alignment.
public void release()
Override method to clean up resources after each signing.
public com.aspose.ms.System.Collections.Generic.List<Integer> getSignPages(int totalPages)
Override method to get list of pages to sign.
getSignPages
in class SignOptions
totalPages
- Total count of pagespublic boolean hasImage()
Indicates if options has an image.
public com.groupdocs.signature.domain.ImageBorderData getImageBorder()
Gets image border data.
getImageBorder
in class SignOptions
public String toString()
Override string conversion
toString
in class SignOptions
Copyright © 2017. All rights reserved.