Class Controller
An abstarct base class for dialog
Inheritance
Implements
Inherited Members
Namespace: Sig.SignAPI.Dialog
Assembly: SigSignAPI.dll
Syntax
public abstract class Controller : IDisposable
Properties
Name | Description |
---|---|
Properties | This exposes some properties which are configurable by the user for the use of dialog mode |
Methods
Name | Description |
---|---|
AddCustomButton(String, String, String, String, CustomButtonNo) | Adds custom button to the button bar. For button no 3 and 4 if internal custom buttons are enabled then it takes precedence over custom defined Buttons |
AddKeyboard(String, String, String, String, String) | The API Adds custom keyboard. however the keyboard size is fixed and the no of rows are fixed to 4 as well. the no of coloumns in each row depends on comma seperated string. Each row string can contain one string or null or comma seperated string, the no of coloumns on each row depends on the no of commas |
Create(Int32) | The method reads all available formfields in the pdf such as combobox, checkbox, radio button and so on . It creates a Dialog using the formfields from pdf where the user can modify them. The Signature Field is Disabled in this mode. |
DeleteCustomButton(CustomButtonNo) | Deletes the Custom Button No if it exists |
DeleteKeyboard(String) | Deletes Custom Keyboards |
DisableFormFields() | Disables all Non Signature Formfields |
Dispose() | |
MessageBox(String, String, NumberOfMessageBoxButtons, String) | The user can use this to pop up some worning or error messages. The Message box may contain one or two or three buttons |
Of(IDriver, IClient) | Builds a dialog controller from a driver object and a PDF client object. The Dispose method does not call client.Dispose(). |
Save(String) | Normally when a pdf is loaded or Create() is called then Dialog is in Normal mode. In this mode if Save() method is called it saves all formfields except signature fields. if StartSignature() method is called then dialog is in Siganture mode. In this mode if Save() method is called then it just saves the pdf to location defined by parameter PathFileName. Note : StartSignature() Saves the current status of formfields and disables them before Signature capture is started. As and when each signature is captured the signature field is saved and disabled. |
Events
Name | Description |
---|---|
DialogEvents | An event that is generated when a button is pressed in dialog mode |