ComboBox

Represents the combo box field of a interactive forms. A combo box consisting of a drop list.

public class ComboBox : ChoiceField, ISerializable
Public Class ComboBox
    Inherits ChoiceField
    Implements 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:

Examples

This example shows how to create an Combo Box and Add it to the page.
Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements.Forms
Imports ceTe.DynamicPDF.Text
     
Module MyModule
     		
    Sub Main()
     		
        ' Create a PDF Document
        Dim MyDocument As Document = New Document
     		
        ' Create a PDF Page
        Dim MyPage As Page = New Page(PageSize.Letter)
     		
        ' Create an Combo Box
        Dim MyComboBox As ComboBox = New ComboBox("combo", 50, 75, 150, 25)
        Dim MyFont As OpenTypeFont = new OpenTypeFont("fontname")
        MyComboBox.Font = MyFont
        MyComboBox.Items.Add("One", true)
        MyComboBox.Items.Add("Two")
        MyComboBox.Items.Add("Three")
        MyComboBox.Items.Add("Four")
        MyComboBox.Items.Add("Five")
        MyComboBox.BackgroundColor = RgbColor.AliceBlue
        MyComboBox.BorderColor = RgbColor.DarkMagenta
        MyComboBox.Editable = true
        MyComboBox.ToolTip = "Select"
     		
        ' Add the Combo Box to the page
        MyPage.Elements.Add(MyComboBox)
     		
        ' Add pages to the document
        MyDocument.Pages.Add(MyPage)
     
        ' Save the PDF document
        MyDocument.Draw("C:\MyDocument.pdf")
     		
    End Sub
End Module
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

BackgroundColorGets or Sets the fill/background color of a form field.
(Inherited from FormElement)
BorderColorGets or Sets the border color of a form field.
(Inherited from FormElement)
BorderStyleGets or Sets the BorderStyle .
(Inherited from FormElement)
EditableGets 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.
FontGets or Sets the font for the field.
(Inherited from ChoiceField)
FontSizeGets or Sets the font size for the field.
(Inherited from ChoiceField)
HeightGets or Sets the height of a form field.
(Inherited from FormElement)
IDGets or sets the ID of the page element.
(Inherited from PageElement)
IgnoreMarginsGets or sets ignore margin property. Setting false will consider the margin while placing the page element based on the RelativeTo property.
(Inherited from PageElement)
ItemsGets the list of items for the ChoiceField .
(Inherited from ChoiceField)
MappingNameGets or Sets an mapping name, of a form field.
(Inherited from FormElement)
NameGets or Sets the name of a form field.
(Inherited from FormElement)
NoExportGets 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)
OutputGets or sets output options for the field.
(Inherited from FormElement)
PrintableGets or Sets the form field printable on Pdf. By default its true.
(Inherited from FormElement)
ReaderEventsGets the reader events of the annotation.
(Inherited from FormElement)
ReadOnlyGets or Sets the read only property status of the form field.
(Inherited from FormElement)
RelativeToGets and sets placement of the page element on the page.
(Inherited from PageElement)
RequiredGets 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.
RotateGets or Sets the angle of a form field. Rotation angle should be multiple of 90, default is 0.
(Inherited from FormElement)
TagGets or sets the structure element of the form element.
(Inherited from FormElement)
TagOrderGets or sets the tag order of the taggable element.
(Inherited from TaggablePageElement)
TextColorGets or Sets the color of the text for the field.
(Inherited from FormElement)
ToolTipGets or Sets an alternate field name, of a form field.
(Inherited from FormElement)
VisibleGets or Sets the form field visible on Pdf. By default its true.
(Inherited from FormElement)
WidthGets or Sets the width of a form field.
(Inherited from FormElement)
XGets or Sets the X coordinate of a form field.
(Inherited from FormElement)
YGets 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)

See Also

ceTe.DynamicPDF.PageElements.Forms

In this topic