SetSignProcessAppearanceText

Security and Signatures

Description

Builds an automatically generated visible text appearance for the signature field of the specified digital signature process. The Options bit mask selects which lines appear: the signer name, the reason and location supplied through SetSignProcessInfo, and the signing date, optionally prefixed with descriptive labels such as "Signed by:" and "Reason:".

The text block is laid out inside the signature field rectangle (see SetSignProcessFieldBounds) using the standard Helvetica font. When FontSize is 0 the size is fitted automatically to the field. An image set through SetSignProcessFieldImageFromFile takes precedence over the text appearance, and document time-stamp processes ignore it.

Syntax

Delphi

Function TPDFlib.SetSignProcessAppearanceText(SignProcessID, Options: Integer; Const SignerName: WideString; FontSize, FontRed, FontGreen, FontBlue: Double): Integer;

ActiveX

Function PDFlib::SetSignProcessAppearanceText(SignProcessID As Long, Options As Long, SignerName As String, FontSize As Double, FontRed As Double, FontGreen As Double, FontBlue As Double) As Long

DLL

int DLSetSignProcessAppearanceText(int InstanceID, int SignProcessID, int Options, const wchar_t * SignerName, double FontSize, double FontRed, double FontGreen, double FontBlue);

Parameters

SignProcessID	A value returned by the NewSignProcessFromFile, NewSignProcessFromStream or NewSignProcessFromString functions.
Options	Bit mask selecting the text lines: 1 = signer name (the SignerName parameter), 2 = reason, 4 = location (both from SetSignProcessInfo), 8 = signing date, 16 = descriptive labels in front of each line. 0 disables the text appearance.
SignerName	The name shown on the signer name line when bit 1 is set.
FontSize	Font size in points; 0 fits the text block to the signature field rectangle automatically.
FontRed, FontGreen, FontBlue	Text colour components in the range 0..1.

Return values

0	The sign process handle was not valid
1	Success