com.groupdocs.signature.options.textsignature

Class CellsSignTextOptions

java.lang.Object

com.groupdocs.signature.options.SignOptions

com.groupdocs.signature.options.textsignature.SignTextOptions

com.groupdocs.signature.options.textsignature.CellsSignTextOptions

All Implemented Interfaces:

IAlignment, IOpacity, IRectangle, IRotation

public class CellsSignTextOptions
extends SignTextOptions
implements IOpacity

Represents the Text Signature Options for Cells Documents.

Constructor Summary

Constructors

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.

Method Summary

Methods

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.
Padding	getMargin() Gets or sets the space between Sign and worksheet edges.
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.
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	setMargin(Padding value) Gets or sets the space between Sign and worksheet edges.
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.

Methods inherited from class com.groupdocs.signature.options.textsignature.SignTextOptions

getBackgroundColor, getBorderColor, getFont, getForeColor, getHeight, getHorizontalAlignment, getImageHelper, getLeft, getLocationMeasureType, getMarginMeasureType, getRotationAngle, getSignAllPages, getSizeMeasureType, getStretch, getText, getTop, getVerticalAlignment, getWidth, setBackgroundColor, setBorderColor, setFont, setForeColor, setHeight, setHorizontalAlignment, setLeft, setLocationMeasureType, setMarginMeasureType, setRotationAngle, setSignAllPages, setSizeMeasureType, setStretch, setText, setTop, setVerticalAlignment, setWidth, toString

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

getAppearance, getExtensions, getPagesSetup, release, setAppearance, setPagesSetup, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.groupdocs.signature.domain.interfaces.IOpacity

getOpacity, setOpacity

Constructor Detail

CellsSignTextOptions

public CellsSignTextOptions()

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

CellsSignTextOptions

public CellsSignTextOptions(String text)

Initializes a new instance of the CellsSignTextOptions class with text.

Parameters:

text - Signature text

Method Detail

getBackgroundBrushStyle

public 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.

Overrides:

getBackgroundBrushStyle in class SignTextOptions

getBackgroundTransparency

public double getBackgroundTransparency()

Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).

getBorderDashStyle

public int getBorderDashStyle()

Gets or sets the signature border style.

getBorderTransparency

public double getBorderTransparency()

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

getBorderVisiblity

public boolean getBorderVisiblity()

Gets or sets the signature border visibility.

getBorderWeight

public double getBorderWeight()

Gets or sets the weight of the signature border.

getColumnNumber

public int getColumnNumber()

Gets or sets the left column number of signature (min value is 0).

getDocumentPageNumber

public int getDocumentPageNumber()

Gets or sets worksheet number for signing. Minimal value is 1.

Overrides:

getDocumentPageNumber in class SignOptions

getMargin

public Padding getMargin()

Gets or sets the space between Sign and worksheet edges. (works ONLY if horizontal or vertical alignment are specified).

Specified by:

getMargin in interface IAlignment

Overrides:

getMargin in class SignTextOptions

getRowNumber

public int getRowNumber()

Gets or sets the top row number of signature (min value is 0).

getShapeType

public 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.

getSheetNumber

public int getSheetNumber()

Gets or sets worksheet number for signing.

getSignatureImplementation

public int getSignatureImplementation()

Gets or sets the type of text signature implementation.

setBackgroundBrushStyle

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.

Overrides:

setBackgroundBrushStyle in class SignTextOptions

setBackgroundTransparency

public void setBackgroundTransparency(double value)

Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).

setBorderDashStyle

public void setBorderDashStyle(int value)

Gets or sets the signature border style.

setBorderTransparency

public void setBorderTransparency(double value)

Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).

setBorderVisiblity

public void setBorderVisiblity(boolean value)

Gets or sets the signature border visibility.

setBorderWeight

public void setBorderWeight(double value)

Gets or sets the weight of the signature border.

setColumnNumber

public void setColumnNumber(int value)

Gets or sets the left column number of signature (min value is 0).

setDocumentPageNumber

public void setDocumentPageNumber(int value)

Gets or sets worksheet number for signing. Minimal value is 1.

Overrides:

setDocumentPageNumber in class SignOptions

setMargin

public void setMargin(Padding value)

Gets or sets the space between Sign and worksheet edges. (works ONLY if horizontal or vertical alignment are specified).

Specified by:

setMargin in interface IAlignment

Overrides:

setMargin in class SignTextOptions

setRowNumber

public void setRowNumber(int value)

Gets or sets the top row number of signature (min value is 0).

setShapeType

public 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.

setSheetNumber

public void setSheetNumber(int value)

Gets or sets worksheet number for signing.

setSignatureImplementation

public void setSignatureImplementation(int value)

Gets or sets the type of text signature implementation.