Form Class - Aspose.PDF for .NET

SystemObject
  Aspose.Pdf.FacadesFacade
    Aspose.Pdf.FacadesSaveableFacade
      Aspose.Pdf.FacadesForm

public sealed class Form : SaveableFacade

Public NotInheritable Class Form
	Inherits SaveableFacade

public ref class Form sealed : public SaveableFacade

[<SealedAttribute>]
type Form =  
    class
        inherit SaveableFacade
    end

	Name	Description
	Form	Construtcor of Form without parameters. Examples C# Form form = new Aspose.Pdf.Facades.Form(); form.SrcFileName = "file.pdf";
	Form(Document)	Initializes new Form object on base of the document.
	Form(Stream)	Constructor for form.
	Form(String)	Constructor of Form.
	Form(Document, Stream)	Obsolete. Initializes new Form object on base of the document.
	Form(Document, String)	Obsolete. Initializes new Form object on base of the document.
	Form(Stream, Stream)	Obsolete. Constructor of Form with two stream parameters. Specify same source and destination stream for incremental update.
	Form(Stream, String)	Obsolete. Constructor of Form
	Form(Stream, HttpResponse)	Obsolete. Creates form which will save result into HttpResponse object.
	Form(String, Stream)	Obsolete. Constructor of Form.
	Form(String, String)	Obsolete. Constructor of Form class. Specify same source file name and destination file name to perform incremental update.
	Form(String, HttpResponse)	Obsolete. Creates form which will save result into HttpResponse object.

	Name	Description
	AttachmentName	Gets or sets name of attachment when result of operation is stored into HttpResponse objects as attachment.
	ContentDisposition	Gets or sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.
	ConvertTo	Sets PDF file format. Result file will be saved in specified file format. If this property is not specified then file will be save in default PDF format without conversion.
	DestFileName	Obsolete. Gets or sets destiination file name.
	DestStream	Obsolete. Gets or sets destination stream.
	Document	Gets the document facade is working on. (Inherited from Facade.)
	FieldNames	Gets list of field names on the form.
	FormSubmitButtonNames	Gets all form submit button names.
	ImportResult	Result of last import operation. Array of objects which descibre result of import for each field.
	Response	Gets or sets Response object where result of operation will be stored.
	SaveOptions	Gets or sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.
	SrcFileName	Obsolete. Gets or sets source file name. Examples C# Form form = new Aspose.Pdf.Facades.Form(); form.SrcFileName = "file.pdf";
	SrcStream	Obsolete. Gets or sets source stream. Examples C# Form form = new Aspose.Pdf.Facades.Form(); form.SrcStream = new FileStream("source.pdf", FileMode.Open, FileAccess.Read);

	Name	Description
	BindPdf(Document)	Initializes the facade. (Inherited from Facade.)
	BindPdf(Stream)	Initializes the facade. (Inherited from Facade.)
	BindPdf(String)	Initializes the facade. (Inherited from Facade.)
	Close	Closes opened files without any changes. (Overrides FacadeClose.)
	Dispose	Disposes the facade. (Inherited from Facade.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExportFdf	Exports the content of the fields of the pdf into the fdf stream.
	ExportXfdf	Exports the content of the fields of the pdf into the xml stream. The button field's value will not be exported.
	ExportXml	Exports the content of the fields of the pdf into the xml stream. The button field's value will not be exported.
	ExtractXfaData	Extracts XFA data packet
	FillBarcodeField	Fill a barcode field according to its fully qualified field name.
	FillField(String, Boolean)	Fills the check box field with a boolean value. Notice: Only be applied to Check Box. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.CheckBoxField" you should specify full name and not "CheckBoxField". You can use FieldNames property to explore existing field names and search required field by its partial name.
	FillField(String, Int32)	Fills the radio box field with a valid index value according to a fully qualified field name. Before filling the fields, only field's name must be known. While the value can be specified by its index. Notice: Only be applied to Radio Box, Combo Box and List Box fields. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.ListBoxField" you should specify full name and not "ListBoxField". You can use FieldNames property to explore existing field names and search required field by its partial name.
	FillField(String, String)	Fills the field with a valid value according to a fully qualified field name. Before filling the fields, every field's names and its corresponding valid values must be known. Both the fields' name and values are case sensitive. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.TextField" you should specify full name and not "TextField". You can use FieldNames property to explore existing field names and search required field by its partial name.
	FillField(String, String)	Fill a field with multiple selections.Note: only for AcroForm List Box Field.
	FillField(String, String, Boolean)	Fills field with specified value.
	FillFields	Fills the text box fields with a text values and save the document. Relevant for signed documents. Notice: Only be applied to Text Box. Both the fields' name and values are case sensitive.
	FillImageField(String, Stream)	Overloads function of FillImageField. The input is a image stream.
	FillImageField(String, String)	Pastes an image onto the existing button field as its appearance according to its fully qualified field name.
	FlattenAllFields	Flattens all the fields.
	FlattenField	Flattens a specified field with the fully qualified field name. Any other field will remain unchangable. If the fieldName is invalid, all the fields will remain unchangable.
	GetButtonOptionCurrentValue	Returns the current value for radio button option fields.
	GetButtonOptionValues	Gets the radio button option fields and related values based on the field name. This method has meaning for radio button groups.
	GetField	Gets the field's value according to its field name.
	GetFieldFacade	Returns FrofmFieldFacade object containing all appearance attributes. Examples C# Aspose.Pdf.Facades.Form form = new Aspose.Pdf.Facades.Form("form.pdf"); FormFieldFacade field = form.GetFieldFacade("field1"); Console.WriteLine("Color of field border: " + field.BorderColor);
	GetFieldFlag	Returns flags of the field.
	GetFieldLimit	Get the limitation of text field.
	GetFieldType	Returns type of field.
	GetFullFieldName	Gets the full field name according to its short field name.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRichText	Get a Rich Text field's value, including the formattinf information of every character.
	GetSubmitFlags	Returns the submit button's submission flags
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImportFdf	Imports the content of the fields from the fdf file and put them into the new pdf.
	ImportXfdf	Imports the content of the fields from the xfdf(xml) file and put them into the new pdf.
	ImportXml(Stream)	Imports the content of the fields from the xml file and put them into the new pdf.
	ImportXml(Stream, Boolean)	Imports the content of the fields from the xml file and put them into the new pdf.
	IsRequiredField	Determines whether field is required or not.
	RenameField	Renames a field. Either AcroForm field or XFA field is OK.
	Save	Obsolete. Saves the value of the filled fields and close the opened Pdf document.
	Save(Stream)	Saves document into specified stream. (Overrides SaveableFacadeSave(Stream).)
	Save(String)	Saves document into specified file. (Overrides SaveableFacadeSave(String).)
	SetXfaData	Replaces XFA data with specified data packet. Data packet may be extracted using ExtractXfaData.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Reference

Aspose.Pdf.Facades Namespace