ComboBox
Represents the combo box field of a interactive forms. A combo box consisting of a drop list.
public class ComboBox : ChoiceField, ISerializable
Inheritance: ObjectPageElementTaggablePageElementFormElementChoiceFieldComboBox
Implements: ISerializable
Licensing Info
This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:
- An active DynamicPDF Ultimate Subscription
- An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
- A DynamicPDF Core Suite for .NET v12.X Developer License.
Examples
This example shows how to create an Combo Box and Add it to the page.using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
using ceTe.DynamicPDF.PageElements.Forms;
using ceTe.DynamicPDF.Text;
public class Example
{
public static void CreatePDF(string outputPath, string fontPath)
{
// Create a PDF Document
Document document = new Document();
// Create a PDF Page
Page page = new Page(PageSize.Letter);
// Create an Combo Box
ComboBox comboBox = new ComboBox("combo", 50, 75, 150, 25);
OpenTypeFont myFont = new OpenTypeFont(fontPath);
comboBox.Font = myFont;
comboBox.Items.Add("One", true);
comboBox.Items.Add("Two");
comboBox.Items.Add("Three");
comboBox.Items.Add("Four");
comboBox.Items.Add("Five");
comboBox.BackgroundColor = RgbColor.AliceBlue;
comboBox.BorderColor = RgbColor.DarkMagenta;
comboBox.Editable = true;
comboBox.ToolTip = "Select";
// Add the Combo Box to the page
page.Elements.Add(comboBox);
// Add pages to the document
document.Pages.Add(page);
// Save the PDF document
document.Draw(outputPath);
}
}
Remarks
For more details on combo box fields take a look at the Interactive Forms topic.
Constructors
ComboBox(String, Single, Single, Single, Single) | Creates a new instance of ComboBox class. |
Properties
BackgroundColor | Gets or Sets the fill/background color of a form field. (Inherited from FormElement) |
BorderColor | Gets or Sets the border color of a form field. (Inherited from FormElement) |
BorderStyle | Gets or Sets the BorderStyle . (Inherited from FormElement) |
Editable | Gets or Sets the editable state of a combo box. If set, the combo box includes an editable text box as well as a drop list; if clear, it includes only a drop list. |
Font | Gets or Sets the font for the field. (Inherited from ChoiceField) |
FontSize | Gets or Sets the font size for the field. (Inherited from ChoiceField) |
Height | Gets or Sets the height of a form field. (Inherited from FormElement) |
ID | Gets or sets the ID of the page element. (Inherited from PageElement) |
IgnoreMargins | Gets or sets ignore margin property. Setting false will consider the margin while placing the page element based on the RelativeTo property. (Inherited from PageElement) |
Items | Gets the list of items for the ChoiceField . (Inherited from ChoiceField) |
MappingName | Gets or Sets an mapping name, of a form field. (Inherited from FormElement) |
Name | Gets or Sets the name of a form field. (Inherited from FormElement) |
NoExport | Gets or Sets the export state of a choice field.
If set, the field will not be exported by a submit-form action. (Inherited from ChoiceField) |
Output | Gets or sets output options for the field. (Inherited from FormElement) |
Printable | Gets or Sets the form field printable on Pdf. By default its true. (Inherited from FormElement) |
ReaderEvents | Gets the reader events of the annotation. (Inherited from FormElement) |
ReadOnly | Gets or Sets the read only property status of the form field. (Inherited from FormElement) |
RelativeTo | Gets and sets placement of the page element on the page. (Inherited from PageElement) |
Required | Gets or Sets the value specifying the required state of a field. If set, the field must have a value at the time it is exported by a submit-form action. |
Rotate | Gets or Sets the angle of a form field.
Rotation angle should be multiple of 90, default is 0. (Inherited from FormElement) |
Tag | Gets or sets the structure element of the form element. (Inherited from FormElement) |
TagOrder | Gets or sets the tag order of the taggable element. (Inherited from TaggablePageElement) |
TextColor | Gets or Sets the color of the text for the field. (Inherited from FormElement) |
ToolTip | Gets or Sets an alternate field name, of a form field. (Inherited from FormElement) |
Visible | Gets or Sets the form field visible on Pdf. By default its true. (Inherited from FormElement) |
Width | Gets or Sets the width of a form field. (Inherited from FormElement) |
X | Gets or Sets the X coordinate of a form field. (Inherited from FormElement) |
Y | Gets or Sets the Y coordinate of a form field. (Inherited from FormElement) |
Methods
Draw(PageWriter) | Draws the combo box to the given PageWriter object. |
Equals(Object) | Determines whether the specified Object is equal to the current Object . (Inherited from Object) |
GetHashCode() | Serves as a hash function for a particular type. (Inherited from Object) |
GetType() | Gets the Type of the current instance. (Inherited from Object) |
ToString() | Returns a String that represents the current Object . (Inherited from Object) |