ListBox
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:
- 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 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.Items.Add("One",true)
MyListBox.Items.Add("Two","ExportTwo",true)
MyListBox.Items.Add("Three")
MyListBox.Items.Add("Four")
MyListBox.Items.Add("Five")
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
MyPage.Elements.Add(MyListBox)
' 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 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.Items.Add("Three");
listBox.Items.Add("Four");
listBox.Items.Add("Five");
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
page.Elements.Add(listBox);
// Add pages to the document
document.Pages.Add(page);
// Save the PDF document
document.Draw(outputPath);
}
}
Remarks
For more details on list box fields take a look at the Interactive Forms topic.
Constructors
ListBox(String, Single, Single, Single, Single) | Creates a new instance of ListBox 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) |
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) |
Multiselect | Gets 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. |
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) |
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 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) |