SignDoc SDK (.NET without exceptions)
5.0.0
|
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... | |
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.
Constructor.
Copy constructor.
[in] | aSource | The object to be copied. |
Destructor.
Finalizer.
void clear | ( | ) |
Unset all attributes.
isSet() will return false.
SignDocTextFieldAttributes clone | ( | ) |
Clone this object.
string getFontName | ( | ) |
Get the name of the font.
This function returns an empty string if isSet() would return false.
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.
double getFontSize | ( | ) |
Get the font size.
This function returns 0 if isSet() would return false.
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.
SignDocColor getTextColor | ( | ) |
Get the text color.
This function returns null if isSet() would return false.
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).
bool isValid | ( | ) |
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.
[in] | aFontName | The new font name. |
void setFontSize | ( | double | aFontSize | ) |
Set the font size.
The default value is 24.
[in] | aFontSize | The font size (in user space units). |
void setRest | ( | string | aInput | ) |
Set unparsed parts of default appearance string.
[in] | aInput | The 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.
[in] | aTextColor | The text color. |