Represents the list box field of a interactive forms.

public class ListBox : ChoiceField, ISerializable
Public Class ListBox
    Inherits ChoiceField
    Implements ISerializable

Inheritance: ObjectPageElementTaggablePageElementFormElementChoiceFieldListBox

Implements: ISerializable

Licensing Info

This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:


This example shows how to create an List 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 List Box
        Dim MyListBox As ListBox = New ListBox("list", 5, 2, 100, 150)
        Dim MyFont As OpenTypeFont = new OpenTypeFont("fontname")
        MyListBox.Font = MyFont
        MyListBox.BackgroundColor = RgbColor.AliceBlue
        MyListBox.BorderColor = RgbColor.DarkMagenta
        MyListBox.BorderStyle = BorderStyle.Dashed
        MyListBox.Multiselect = true
        MyListBox.ToolTip = "Select"
        ' Add the List Box to the page
        ' Add pages to the document
        ' Save the PDF document
    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 List Box
        ListBox listBox = new ListBox("list", 5, 2, 100, 150);
        OpenTypeFont myFont = new OpenTypeFont(fontPath);
        listBox.Font = myFont;
        listBox.Items.Add("One", true);
        listBox.Items.Add("Two", "ExportTwo", true);
        listBox.BackgroundColor = RgbColor.AliceBlue;
        listBox.BorderColor = RgbColor.DarkMagenta;
        listBox.BorderStyle = BorderStyle.Dashed;
        listBox.Multiselect = true;
        listBox.ToolTip = "Select";

        // Add the List Box to the page

        // Add pages to the document

        // Save the PDF document


For more details on list box fields take a look at the Interactive Forms topic.


ListBox(String, Single, Single, Single, Single)Creates a new instance of ListBox class.


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)
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)
MultiselectGets or Sets the multi select flag status of list box. If set, more than one of the field’s option items may be selected simultaneously; if clear, no more than one item at a time may be selected.
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)
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)


Draw(PageWriter)Draws the list 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


In this topic