PdfForms Class

Represents the PDF forms in doucument

Inheritance Hierarchy

SystemObject
Patagames.Pdf.NetPdfForms

Namespace: Patagames.Pdf.Net
Assemblies: Patagames.Pdf.Xamarin.iOS (in Patagames.Pdf.Xamarin.iOS.dll) Version: 4.84.2704
Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.84.2704

Syntax

C++

JavaScript

Copy

public class PdfForms : IDisposable

Public Class PdfForms
	Implements IDisposable

public ref class PdfForms : IDisposable

type PdfForms =  
    class
        interface IDisposable
    end

public class PdfForms implements IDisposable

Patagames.Pdf.Net.PdfForms = function();

Type.createClass(
	'Patagames.Pdf.Net.PdfForms',
	null,
	IDisposable);

The PdfForms type exposes the following members.

Constructors

	Name	Description
	PdfForms	Initializes a new instance of the PdfForms class.

Top

Properties

	Name	Description
	Document	Gets PDF Document associated with this PdfForms.
	FocusedText	Gets the text in the widget that is currently processing the input queue.
	Handle	Gets the Pdfium SDK handle that the forms is bound to
	InterForm	Gets Interactive Forms object for current PDF document.
	IsDisposed	Gets a value indicating whether the object has been disposed of. Field Value Type: true if the control has been disposed of; otherwise, false.
	SelectedText	Gets the selected text in the widget that is currently processing the input queue.
	SynchronizationContext	Gets or sets the object used to marshal event-handler calls that are issued from JS engine.
	SynchronizingObject	Obsolete. Gets or sets the object used to marshal event-handler calls that are issued from JS engine.

Top

Methods

	Name	Description
	Dispose	Release all resources used by PdfForms
	Dispose(Boolean)	Releases all resources used by the PdfImageObject.
	Finalize	Finalize object (Overrides ObjectFinalize.)
	ForceToKillFocus	You can call this member function to force to kill the focus of the form field which got focus. It would kill the focus on the form field, save the value of form field if it's changed by user.
	OnAfterCheckedStatusChangeCallback	This method invoked by SDK after checked statuses is changed.
	OnAfterFormImportDataCallback	This method invoked by SDK after forms data is imported.
	OnAfterFormResetCallback	This method invoked by SDK after forms is reseted.
	OnAfterSelectionChangeCallback	This method invoked by SDK after field's selection is changed.
	OnAfterValueChangeCallback	This method invoked by SDK after field is changed.
	OnBeforeFormImportDataCallback	This method invoked by SDK before forms data is imported.
	OnBeforeFormResetCallback	This method invoked by SDK before forms is reseted.
	OnBeforeSelectionChangeCallback	This method invoked by SDK before field's selection is changed.
	OnBeforeValueChangeCallback	This method invoked by SDK before field is changed.
	RemoveHighlightColor	Remove the form field highlight color in the document.
	SelectText	Select text in the widget that is currently processing the input queue.
	SetHighlightColor	Set the highlight color of specified or all the form fields in the document.
	SetHighlightColorEx	Set the highlight color of specified or all the form fields in the document.

Top

Events

	Name	Description
	AfterCheckedStatusChange	Occurs when the checked statuses for check boxes or radion buttons are changed.
	AfterFormImportData	Occurs when the ImportFromFdf(FdfDocument) or the FPDFInterForm_ImportFromFDF(IntPtr, IntPtr, Boolean) is calling.
	AfterFormReset	Occurs when the ResetForm or the FPDFInterForm_ResetForm(IntPtr, Boolean) is calling.
	AfterSelectionChange	Occurs when the selected index for list box is changed.
	AfterValueChange	Occurs when the value of a text box or combo box is changed.
	AppAlert	pop up a dialog to show warning or hint.
	AppBeep	Causes the system to play a sound.
	AppResponse	Displays a dialog box containing a question and an entry field for the user to reply to the question.
	BeforeFormImportData	Occurs when the ImportFromFdf(FdfDocument) or the FPDFInterForm_ImportFromFDF(IntPtr, IntPtr, Boolean) is calling.
	BeforeFormReset	Occurs when the ResetForm or FPDFInterForm_ResetForm(IntPtr, Boolean) is calling.
	BeforeSelectionChange	Alerts listeners when a selected index for a list box is about to change.
	BeforeValueChange	Alerts listeners when a text box or combo box value is about to change.
	BrowseFile	Show a file selection dialog, and return the selected file path.
	DoGotoAction	While processing this event pplication must be changes the view to a specified destination.
	DoNamedAction	This event will execute an named action.
	DoURIAction	This action resolves to a uniform resource identifier.
	FieldChanged	This event will be invoked to notify implementation when the value of any FormField on the document had been changed.
	FocusChanged	This event will be fired when a text field is getting or losing a focus.
	GetDocumentPath	Get the file path of the current document.
	GotoPage	Jump to a specified page.
	Invalidate	SDK will fire this event when the page need to be repainted.
	LocalTime	With this event SDK receives the current local time on the system.
	OutputSelectedRect	SDK fire this event when user is taking the mouse to select texts on a form field.
	Print	Prints all or a specific number of pages of the document.
	Release	Give implementation a chance to release any data after the forms is no longer used
	SendMail	Mails the data buffer as an attachment to all recipients, with or without user interaction.
	SetCursor	Application shoud use this event for sets the specified cursor for the entire application.
	SubmitForm	Send the form data to a specified URL.

Top

Reference

Patagames.Pdf.Net Namespace

PdfForms Class

Field Value

Reference