SignDoc SDK (.NET without exceptions)  5.0.0
SignDocTextFieldAttributes Class Reference

Attributes of a text field, list box field or combo box field used for the construction of the appearance (PDF documents only). More...

Public Member Functions

 SignDocTextFieldAttributes ()
 Constructor. More...
 
 SignDocTextFieldAttributes (SignDocTextFieldAttributes aSource)
 Copy constructor. More...
 
 ~SignDocTextFieldAttributes ()
 Destructor. More...
 
 !SignDocTextFieldAttributes ()
 Finalizer. More...
 
SignDocTextFieldAttributes clone ()
 Clone this object. More...
 
bool isSet ()
 Check if text field attributes are set or not. More...
 
bool isValid ()
 Check if the text field attributes are valid. More...
 
void clear ()
 Unset all attributes. More...
 
string getFontName ()
 Get the name of the font. More...
 
void setFontName (string aFontName)
 Set the name of the font. More...
 
string getFontResourceName ()
 Get the resource name of the font. More...
 
double getFontSize ()
 Get the font size. More...
 
void setFontSize (double aFontSize)
 Set the font size. More...
 
SignDocColor getTextColor ()
 Get the text color. More...
 
void setTextColor (SignDocColor aTextColor)
 Set the text color. More...
 
string getRest ()
 Get unparsed parts of default appearance string. More...
 
void setRest (string aInput)
 Set unparsed parts of default appearance string. More...
 

Detailed Description

Attributes of a text field, list box field or combo box field used for the construction of the appearance (PDF documents only).

This class represents a PDF default appearance string.

Modifying an object of this type does not modify the underlying field or document. Use SignDocDocument.setTextFieldAttributes() or SignDocField.setTextFieldAttributes() to update the text attributes of a field or of the document.

See also
SignDocDocument.getTextFieldAttributes(), SignDocDocument.setTextFieldAttributes(), SignDocField.getTextFieldAttributes(), SignDocField.setTextFieldAttributes()

Constructor & Destructor Documentation

Constructor.

Copy constructor.

Parameters
[in]aSourceThe object to be copied.
Returns
The new object.

Destructor.

Finalizer.

Member Function Documentation

void clear ( )

Unset all attributes.

isSet() will return false.

Clone this object.

Returns
A clone of this object.
string getFontName ( )

Get the name of the font.

This function returns an empty string if isSet() would return false.

Returns
The name of the font, "?" if the font is invalid.
See also
getFontResourceName(), getFontSize(), setFontName()
string getFontResourceName ( )

Get the resource name of the font.

This function returns an empty string if isSet() would return false.

Note that setting the resource name is not possible.

Returns
The resource name of the font.
See also
getFontName()
double getFontSize ( )

Get the font size.

This function returns 0 if isSet() would return false.

Returns
The font size (in user space units). If the font size is 0, the default font size (which depends on the field size) will be used.
See also
getFontName(), setFontSize()
string getRest ( )

Get unparsed parts of default appearance string.

If this function returns a non-empty string, there are unsupported operators in the default appearance string.

Returns
Concatenated unparsed parts of the default appearance string, ie, the default appearance string sans font name, font size, and text color. If this function returns a non-empty string, it will start with a space character.
See also
setRest()
SignDocColor getTextColor ( )

Get the text color.

This function returns null if isSet() would return false.

Returns
The text color or null if the text color is not available.
See also
setTextColor()
bool isSet ( )

Check if text field attributes are set or not.

If this function returns false for a SignDocTextFieldAttributes object retrieved from a text field, the document's natural text field attributes will be used (if present).

This function returns false for all SignDocTextFieldAttributes objects retrieved from TIFF documents (but you can set the attributes anyway, making isSet() return true).

Returns
true if any attribute is set, false if no attributes are set.
See also
isValid()
bool isValid ( )

Check if the text field attributes are valid.

This function does not check if the font name refers to a valid font. This function does not check the string set by setRest().

Returns
true if isSet() would return false or if all attributes are set and are valid, false otherwise.
See also
isSet(), setRest()
void setFontName ( string  aFontName)

Set the name of the font.

The font name can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file.

SignDocDocument.addSignature() ignores the font name set by this function if string parameter "FontName" of SignDocSignatureParameters is set to a non-empty value or if the "SignatureTemplate" element of the XML document given to blob parameter "Template" has a non-empty "font-name" attribute.

Parameters
[in]aFontNameThe new font name.
See also
getFontName(), setFontSize(), setTextColor(), SignDocDocumentLoader.loadFontConfigBlob(), SignDocDocumentLoader.loadFontConfigEnvironment(), SignDocDocumentLoader.loadFontConfigFile(), SignDocDocumentLoader.loadFontConfigStream()
void setFontSize ( double  aFontSize)

Set the font size.

The default value is 24.

Parameters
[in]aFontSizeThe font size (in user space units).
See also
setFontName(), setScale()
void setRest ( string  aInput)

Set unparsed parts of default appearance string.

Parameters
[in]aInputThe new string of unparsed operators. If this string is non-empty and does not start with a space character, a space character will be prepended automatically.
void setTextColor ( SignDocColor  aTextColor)

Set the text color.

Parameters
[in]aTextColorThe text color.

The documentation for this class was generated from the following file: