public class CellsSignTextOptions extends SignTextOptions implements IOpacity, ITextAlignment, ICellsPosition
Represents the Text Signature Options for Cells Documents.
Constructor and Description |
---|
CellsSignTextOptions()
Initializes a new instance of the CellsSignTextOptions class with default values.
|
CellsSignTextOptions(String text)
Initializes a new instance of the CellsSignTextOptions class with text.
|
Modifier and Type | Method and Description |
---|---|
Brush |
getBackgroundBrushStyle()
Gets or sets the signature background brush.
|
double |
getBackgroundTransparency()
Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).
|
int |
getBorderDashStyle()
Gets or sets the signature border style.
|
double |
getBorderTransparency()
Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
|
boolean |
getBorderVisiblity()
Gets or sets the signature border visibility.
|
double |
getBorderWeight()
Gets or sets the weight of the signature border.
|
int |
getColumnNumber()
Gets or sets the left column number of signature (min value is 0).
|
int |
getDocumentPageNumber()
Gets or sets worksheet number for signing.
|
int |
getLeft()
Gets or sets the position of the left edge of the Signature area in pixels.
|
int |
getLocationMeasureType()
Measure type (pixels, percents or millimeters) for Left and Top properties.
|
Padding |
getMargin()
Gets or sets the space between Sign and worksheet edges.
|
int |
getMarginMeasureType()
Gets or sets the measure type (pixels, percents or millimeters) for Margin.
|
double |
getOpacity()
Get or set Signature Opacity.
|
int |
getRowNumber()
Gets or sets the top row number of signature (min value is 0).
|
int |
getShapeType()
Gets or sets the type of shape to put text.
|
int |
getSheetNumber()
Gets or sets worksheet number for signing.
|
int |
getSignatureImplementation()
Gets or sets the type of text signature implementation.
|
int |
getSizeMeasureType()
Measure type (pixels, percents or millimeters) for Width and Height properties.
|
int |
getTextHorizontalAlignment()
Horizontal alignment of text inside a signature.
|
int |
getTextVerticalAlignment()
Vertical alignment of text inside a signature.
|
int |
getTop()
Gets or sets the position of the top edge of the Signature area in pixels.
|
void |
setBackgroundBrushStyle(Brush value)
Gets or sets the signature background brush.
|
void |
setBackgroundTransparency(double value)
Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).
|
void |
setBorderDashStyle(int value)
Gets or sets the signature border style.
|
void |
setBorderTransparency(double value)
Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
|
void |
setBorderVisiblity(boolean value)
Gets or sets the signature border visibility.
|
void |
setBorderWeight(double value)
Gets or sets the weight of the signature border.
|
void |
setColumnNumber(int value)
Gets or sets the left column number of signature (min value is 0).
|
void |
setDocumentPageNumber(int value)
Gets or sets worksheet number for signing.
|
void |
setLeft(int value)
Gets or sets the position of the left edge of the Signature area in pixels.
|
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 worksheet edges.
|
void |
setMarginMeasureType(int value)
Gets or sets the measure type (pixels, percents or millimeters) for Margin.
|
void |
setOpacity(double value)
Get or set Signature Opacity.
|
void |
setRowNumber(int value)
Gets or sets the top row number of signature (min value is 0).
|
void |
setShapeType(int value)
Gets or sets the type of shape to put text.
|
void |
setSheetNumber(int value)
Gets or sets worksheet number for signing.
|
void |
setSignatureImplementation(int value)
Gets or sets the type of text signature implementation.
|
void |
setSizeMeasureType(int value)
Measure type (pixels, percents or millimeters) for Width and Height properties.
|
void |
setTextHorizontalAlignment(int value)
Horizontal alignment of text inside a signature.
|
void |
setTextVerticalAlignment(int value)
Vertical alignment of text inside a signature.
|
void |
setTop(int value)
Gets or sets the position of the top edge of the Signature area in pixels.
|
getBackgroundColor, getBorderColor, getFont, getForeColor, getHeight, getHorizontalAlignment, getImageHelper, getRotationAngle, getSignAllPages, getStretch, getText, getVerticalAlignment, getWidth, setBackgroundColor, setBorderColor, setFont, setForeColor, setHeight, setHorizontalAlignment, setRotationAngle, setSignAllPages, setStretch, setText, setVerticalAlignment, setWidth, toString
getAppearance, getExtensions, getPagesSetup, setAppearance, setPagesSetup
public CellsSignTextOptions()
Initializes a new instance of the CellsSignTextOptions class with default values.
public CellsSignTextOptions(String text)
Initializes a new instance of the CellsSignTextOptions class with text.
text
- Signature textpublic Brush getBackgroundBrushStyle()
Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. It is not used for Watermark implementation.
getBackgroundBrushStyle
in class SignTextOptions
public final double getBackgroundTransparency()
Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).
public final int getBorderDashStyle()
Gets or sets the signature border style.
public final double getBorderTransparency()
Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
public final boolean getBorderVisiblity()
Gets or sets the signature border visibility.
public final double getBorderWeight()
Gets or sets the weight of the signature border.
public final int getColumnNumber()
Gets or sets the left column number of signature (min value is 0). This property is mutually exclusive with Top property. When ColumnNumber is set Left property will be reset to 0.
getColumnNumber
in interface ICellsPosition
public int getDocumentPageNumber()
Gets or sets worksheet number for signing. Minimal value is 1.
getDocumentPageNumber
in class SignOptions
public int getLeft()
Gets or sets the position of the left edge of the Signature area in pixels. This property is mutually exclusive with Column property. If Left property is set ColumnNumber will be reset to 0.
getLeft
in interface IRectangle
getLeft
in class SignTextOptions
public int getLocationMeasureType()
Measure type (pixels, percents or millimeters) for Left and Top properties. If measure type is percents signature location is calculated according to worksheet area where cells with data or style are located.
getLocationMeasureType
in interface IRectangle
getLocationMeasureType
in class SignTextOptions
public Padding getMargin()
Gets or sets the space between Sign and worksheet edges. (works ONLY if horizontal or vertical alignment are specified).
getMargin
in interface IAlignment
getMargin
in class SignTextOptions
public int getMarginMeasureType()
Gets or sets the measure type (pixels, percents or millimeters) for Margin. If measure type is percents signature margin is calculated according to worksheet area where cells with data or style are located.
getMarginMeasureType
in interface IAlignment
getMarginMeasureType
in class SignTextOptions
public final double getOpacity()
Get or set Signature Opacity. This value should be in range 0 - 1 and it inverts BackgroundTransparency. Opacity = 1 - BackgroundTransparency
getOpacity
in interface IOpacity
public final int getRowNumber()
Gets or sets the top row number of signature (min value is 0). This property is mutually exclusive with Left property. When RowNumber is set Top property will be reset to 0.
getRowNumber
in interface ICellsPosition
public final int getShapeType()
Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.
public final int getSheetNumber()
Gets or sets worksheet number for signing.
public final int getSignatureImplementation()
Gets or sets the type of text signature implementation.
public int getSizeMeasureType()
Measure type (pixels, percents or millimeters) for Width and Height properties. If measure type is percents signature size is calculated according to worksheet area where cells with data or style are located.
getSizeMeasureType
in interface IRectangle
getSizeMeasureType
in class SignTextOptions
public final int getTextHorizontalAlignment()
Horizontal alignment of text inside a signature.
getTextHorizontalAlignment
in interface ITextAlignment
public final int getTextVerticalAlignment()
Vertical alignment of text inside a signature.
getTextVerticalAlignment
in interface ITextAlignment
public int getTop()
Gets or sets the position of the top edge of the Signature area in pixels. This property is mutually exclusive with Row property. If Top property is set RowNumber will be reset to 0.
getTop
in interface IRectangle
getTop
in class SignTextOptions
public void setBackgroundBrushStyle(Brush value)
Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. For TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. It is not used for Watermark implementation.
setBackgroundBrushStyle
in class SignTextOptions
public final void setBackgroundTransparency(double value)
Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).
public final void setBorderDashStyle(int value)
Gets or sets the signature border style.
public final void setBorderTransparency(double value)
Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
public final void setBorderVisiblity(boolean value)
Gets or sets the signature border visibility.
public final void setBorderWeight(double value)
Gets or sets the weight of the signature border.
public final void setColumnNumber(int value)
Gets or sets the left column number of signature (min value is 0). This property is mutually exclusive with Top property. When ColumnNumber is set Left property will be reset to 0.
setColumnNumber
in interface ICellsPosition
public void setDocumentPageNumber(int value)
Gets or sets worksheet number for signing. Minimal value is 1.
setDocumentPageNumber
in class SignOptions
public void setLeft(int value)
Gets or sets the position of the left edge of the Signature area in pixels. This property is mutually exclusive with Column property. If Left property is set ColumnNumber will be reset to 0.
setLeft
in interface IRectangle
setLeft
in class SignTextOptions
public void setLocationMeasureType(int value)
Measure type (pixels, percents or millimeters) for Left and Top properties. If measure type is percents signature location is calculated according to worksheet area where cells with data or style are located.
setLocationMeasureType
in interface IRectangle
setLocationMeasureType
in class SignTextOptions
public void setMargin(Padding value)
Gets or sets the space between Sign and worksheet edges. (works ONLY if horizontal or vertical alignment are specified).
setMargin
in interface IAlignment
setMargin
in class SignTextOptions
public void setMarginMeasureType(int value)
Gets or sets the measure type (pixels, percents or millimeters) for Margin. If measure type is percents signature margin is calculated according to worksheet area where cells with data or style are located.
setMarginMeasureType
in interface IAlignment
setMarginMeasureType
in class SignTextOptions
public final void setOpacity(double value)
Get or set Signature Opacity. This value should be in range 0 - 1 and it inverts BackgroundTransparency. Opacity = 1 - BackgroundTransparency
setOpacity
in interface IOpacity
public final void setRowNumber(int value)
Gets or sets the top row number of signature (min value is 0). This property is mutually exclusive with Left property. When RowNumber is set Top property will be reset to 0.
setRowNumber
in interface ICellsPosition
public final void setShapeType(int value)
Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.
public final void setSheetNumber(int value)
Gets or sets worksheet number for signing.
public final void setSignatureImplementation(int value)
Gets or sets the type of text signature implementation.
public void setSizeMeasureType(int value)
Measure type (pixels, percents or millimeters) for Width and Height properties. If measure type is percents signature size is calculated according to worksheet area where cells with data or style are located.
setSizeMeasureType
in interface IRectangle
setSizeMeasureType
in class SignTextOptions
public final void setTextHorizontalAlignment(int value)
Horizontal alignment of text inside a signature.
setTextHorizontalAlignment
in interface ITextAlignment
public final void setTextVerticalAlignment(int value)
Vertical alignment of text inside a signature.
setTextVerticalAlignment
in interface ITextAlignment
public void setTop(int value)
Gets or sets the position of the top edge of the Signature area in pixels. This property is mutually exclusive with Row property. If Top property is set RowNumber will be reset to 0.
setTop
in interface IRectangle
setTop
in class SignTextOptions
Copyright © 2019. All rights reserved.