public abstract class SignTextOptions extends SignOptions implements IRectangle, IAlignment, IRotation
Represents the Text Signature Options.
Modifier and Type | Field and Description |
---|---|
static com.aspose.ms.System.Drawing.Color |
DEFAULT_BKGR_COLOR |
static com.aspose.ms.System.Drawing.Color |
DEFAULT_FORE_COLOR |
DEFAULT_PPM, imageBorderData
Constructor and Description |
---|
SignTextOptions()
Initializes a new instance of the SignTextOptions class with default values.
|
SignTextOptions(String text)
Initializes a new instance of the SignTextOptions class with text.
|
Modifier and Type | Method and Description |
---|---|
Color |
getBackgroundColor()
Gets or sets the background color of signature.
|
com.aspose.ms.System.Drawing.Color |
getBackgroundColorInternal() |
Color |
getBorderColor()
Gets or sets the border color of signature.
|
com.aspose.ms.System.Drawing.Color |
getBorderColorInternal() |
SignatureFont |
getFont()
Gets or sets the font of signature.
|
Color |
getForeColor()
Gets or sets the fore color of signature.
|
com.aspose.ms.System.Drawing.Color |
getForeColorInternal() |
int |
getHeight()
Height of Signature on Document Page in Measure values (pixels or percent see
MeasureType SizeMeasureType property). |
int |
getHorizontalAlignment()
Horizontal alignment of signature on document page.
|
protected com.groupdocs.signature.domain.helpers.ImageHelper |
getImageHelper() |
com.aspose.ms.System.IO.Stream |
getImageStream()
Gets the image stream.
|
int |
getLeft()
Left X position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType property). |
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.
|
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.Drawing.Rectangle |
getSpecificRectangle()
Gets or sets the signature rectangle.
|
String |
getText()
Gets or sets the text of signature.
|
int |
getTop()
Top Y Position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType property). |
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 property). |
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 |
setBackgroundColor(Color value)
Gets or sets the background color of signature.
|
void |
setBorderColor(Color value)
Gets or sets the border color of signature.
|
void |
setFont(SignatureFont value)
Gets or sets the font of signature.
|
void |
setForeColor(Color value)
Gets or sets the fore color of signature.
|
void |
setHeight(int value)
Height of Signature on Document Page in Measure values (pixels or percent see
MeasureType SizeMeasureType property). |
void |
setHorizontalAlignment(int value)
Horizontal alignment of signature on document page.
|
void |
setLeft(int value)
Left X position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType property). |
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 |
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 |
setSpecificRectangle(com.aspose.ms.System.Drawing.Rectangle value)
Gets or sets the signature rectangle.
|
void |
setText(String value)
Gets or sets the text of signature.
|
void |
setTop(int value)
Top Y Position of Signature on Document Page in Measure values (pixels or percent see
MeasureType LocationMeasureType property). |
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 property). |
String |
toString()
Override string conversion
|
void |
validate()
Internal method to validate the options parameters
|
getAppearance, getDocumentPageNumber, getDocumentPPM, getImageBorder, getOpacity, getPagesSetup, getPropertyOrDefault, getPropertyOrDefault, getSignatureConfig, getSignPagesQueue, isRotationChanged, onError, setAppearance, setDocumentPageNumber, setPagesSetup, setRotationChanged, setSignatureConfig
public static final com.aspose.ms.System.Drawing.Color DEFAULT_FORE_COLOR
public static final com.aspose.ms.System.Drawing.Color DEFAULT_BKGR_COLOR
public SignTextOptions()
Initializes a new instance of the SignTextOptions class with default values.
public SignTextOptions(String text)
Initializes a new instance of the SignTextOptions class with text.
text
- Signature textpublic 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).
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 property).
(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 property).
(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 property).
(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 property).
getWidth
in interface IRectangle
public void setWidth(int value)
Width of Signature on Document Page in Measure values (pixels or percent see MeasureType
SizeMeasureType property).
setWidth
in interface IRectangle
public int getHeight()
Height of Signature on Document Page in Measure values (pixels or percent see MeasureType
SizeMeasureType property).
getHeight
in interface IRectangle
public void setHeight(int value)
Height of Signature on Document Page in Measure values (pixels or percent see MeasureType
SizeMeasureType property).
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 String getText()
Gets or sets the text of signature.
public void setText(String value)
Gets or sets the text of signature.
public boolean getSignAllPages()
Put signature on all document pages.
public void setSignAllPages(boolean value)
Put signature on all document pages.
public SignatureFont getFont()
Gets or sets the font of signature.
public void setFont(SignatureFont value)
Gets or sets the font of signature.
public Color getForeColor()
Gets or sets the fore color of signature.
public com.aspose.ms.System.Drawing.Color getForeColorInternal()
public void setForeColor(Color value)
Gets or sets the fore color of signature.
public Color getBorderColor()
Gets or sets the border color of signature.
public com.aspose.ms.System.Drawing.Color getBorderColorInternal()
public void setBorderColor(Color value)
Gets or sets the border color of signature.
public Color getBackgroundColor()
Gets or sets the background color of signature.
public com.aspose.ms.System.Drawing.Color getBackgroundColorInternal()
public void setBackgroundColor(Color value)
Gets or sets the background color of signature.
public com.aspose.ms.System.IO.Stream getImageStream() throws Exception
Gets the image stream.
Exception
public com.aspose.ms.System.Drawing.Rectangle getSpecificRectangle()
Gets or sets the signature rectangle.
public void setSpecificRectangle(com.aspose.ms.System.Drawing.Rectangle value)
Gets or sets the signature rectangle.
protected com.groupdocs.signature.domain.helpers.ImageHelper getImageHelper()
public void release()
Override method to clean up resources after each signing.
public void validate()
Internal method to validate the options parameters
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 isHorizontalAlignmentSet()
Indicates if user set horizontal alignment.
public boolean isVerticalAlignmentSet()
Indicates if user set vertical alignment.
public String toString()
Override string conversion
toString
in class SignOptions
Copyright © 2017. All rights reserved.