| SignDocTextFieldAttributes Class |
Attributes of a text 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.
Inheritance HierarchyNamespace: de.softpro.signdocsdk
Assembly: SPSignDoc_4.3_DotNetLib (in SPSignDoc_4.3_DotNetLib.dll) Version: 1.0.6773.37566
SyntaxC#
public sealed class SignDocTextFieldAttributes : IDisposable
The SignDocTextFieldAttributes type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SignDocTextFieldAttributes | Constructor. |
| SignDocTextFieldAttributes(SignDocTextFieldAttributes) | Copy Constructor. |
Methods| Name | Description | |
|---|---|---|
| clear | Unset all attributes.
isSet() will return false.
|
| clone | Clone this object. |
| Dispose | Releases all resources used by the SignDocTextFieldAttributes |
| getFontName | Get the name of the font.
This function returns an empty string if isSet() would return false.
|
| 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.
|
| getFontSize | Get the font size.
This function returns 0 if isSet() would return false.
|
| 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.
|
| getTextColor | Get the text color.
This function returns null if isSet() would return false.
|
| 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 default
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).
|
| 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().
|
| setFontName | 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.
|
| setFontSize | Set the font size.
|
| setRest | Set unparsed parts of default appearance string.
|
| setTextColor | Set the text color.
|
See Also