PdfListBox Class

Class for a scrollable list box control.

Inheritance Hierarchy

System.Object
  BitMiracle.Docotic.Pdf.PdfWidget
    BitMiracle.Docotic.Pdf.PdfControl
      BitMiracle.Docotic.Pdf.PdfListBox

Namespace:  BitMiracle.Docotic.Pdf
Assembly:  BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)

Syntax

C#
public sealed class PdfListBox : PdfControl
VB
Public NotInheritable Class PdfListBox
	Inherits PdfControl

The PdfListBox type exposes the following members.

Properties

  NameDescription
Public propertyBackgroundColor
Gets or sets the color of the control background.
(Inherited from PdfControl.)
Public propertyBorder
Gets the properties of the control border.
(Inherited from PdfControl.)
Public propertyBoundingBox
Gets or sets the bounding box (rectangle that defines the location of the control on the page).
(Inherited from PdfControl.)
Public propertyFlags
Gets or sets the set of flags specifying various characteristics of the widget.
(Inherited from PdfWidget.)
Public propertyFont
Gets or sets the font used to display text in the control.
Public propertyFontColor
Gets or sets the color of the font used to display text in the control.
Public propertyFontSize
Gets or sets the size of the font (in points) used to display text in the control.
Public propertyFullName
Gets the fully qualified name of the control.
(Inherited from PdfControl.)
Public propertyHeight
Gets or sets the height of the bounding box (rectangle that defines the location of the widget on the page).
(Inherited from PdfWidget.)
Public propertyHidden
Gets or sets a value indicating whether this PdfWidget is hidden.
(Inherited from PdfWidget.)
Public propertyHint
Gets or sets the text displayed when the mouse hovers over the control.
(Inherited from PdfControl.)
Public propertyInvisible
Gets or sets a value indicating whether this PdfWidget is invisible.
(Inherited from PdfWidget.)
Public propertyItems
Gets the collection of items in the list box.
Public propertyLayer
(PDF 1.5) Gets or sets the layer to which this widget belongs.
(Inherited from PdfWidget.)
Public propertyLeft
Gets or sets the x-coordinate of the left edge of the bounding box (rectangle that defines the location of the widget on the page).
(Inherited from PdfWidget.)
Public propertyLocked
(PDF 1.4) Gets or sets a value indicating whether this PdfWidget is locked.
(Inherited from PdfWidget.)
Public propertyLockedContents
(PDF 1.7) Gets or sets a value indicating whether to allow the contents of the widget to be modified by the user.
(Inherited from PdfWidget.)
Public propertyMappingName
Gets or sets the mapping name.
(Inherited from PdfControl.)
Public propertyModifiedDate
Gets or sets the date and time when the widget was last modified.
(Inherited from PdfWidget.)
Public propertyMultiSelection
Gets or sets a value indicating whether this list box can have more than one of its items selected.
Public propertyName
Gets or sets the control name.
(Inherited from PdfControl.)
Public propertyNoRotate
Gets or sets a value indicating whether to rotate the widget's appearance to match the rotation of the page.
(Inherited from PdfWidget.)
Public propertyNoView
Gets or sets a value indicating whether to display widget on screen and allow it to interact with the user.
(Inherited from PdfWidget.)
Public propertyNoZoom
Gets or sets a value indicating whether to scale widget's appearance to match the magnification of the page.
(Inherited from PdfWidget.)
Public propertyOnActivation
Gets or sets the action to be performed when the control is activated.
(Inherited from PdfControl.)
Public propertyOnBeforeFormatting
Gets or sets the PdfJavaScriptAction action to be performed before the control is formatted to display its current value.
(Inherited from PdfControl.)
Public propertyOnChange
Gets or sets the PdfJavaScriptAction action to be performed when the control's value is changed.
(Inherited from PdfControl.)
Public propertyOnKeyPress
Gets or sets the PdfJavaScriptAction action to be performed when the user types a keystroke into PdfTextBox or PdfComboBox or modifies the selection in a scrollable list box.
(Inherited from PdfControl.)
Public propertyOnLostFocus
Gets or sets the action to be performed when the control loses the input focus.
(Inherited from PdfControl.)
Public propertyOnMouseDown
Gets or sets the action to be performed when the mouse button is pressed inside the control's active area.
(Inherited from PdfControl.)
Public propertyOnMouseEnter
Gets or sets the action to be performed when the cursor enters the control's active area.
(Inherited from PdfControl.)
Public propertyOnMouseExit
Gets or sets the action to be performed when the cursor exits the controls' active area.
(Inherited from PdfControl.)
Public propertyOnMouseUp
Gets or sets the action to be performed when the mouse button is released inside the control's active area.
(Inherited from PdfControl.)
Public propertyOnOtherControlChanged
Gets or sets the PdfJavaScriptAction action to be performed to recalculate the value of this control when that of another control changes.
(Inherited from PdfControl.)
Public propertyOnSetFocus
Gets or sets the action to be performed when the control receives the input focus.
(Inherited from PdfControl.)
Public propertyOwner
Gets the page with which this widget is associated.
(Inherited from PdfWidget.)
Public propertyPrint
Gets or sets a value indicating whether this PdfWidget gets printed when the page is printed.
(Inherited from PdfWidget.)
Public propertyReadOnly
Gets or sets a value indicating whether to allow widget to interact with the user.
(Inherited from PdfWidget.)
Public propertyRotation
Gets the PdfRotation value specifying the rotation of the control counterclockwise relative to the page.
(Inherited from PdfControl.)
Public propertySelectedItems
Gets the collection of selected items in the list box.
Public propertyToggleNoView
(PDF 1.5) Gets or sets a value indicating whether to invert the interpretation of NoView property for certain events.
(Inherited from PdfWidget.)
Public propertyTop
Gets or sets the y-coordinate of the top edge of the bounding box (rectangle that defines the location of the widget on the page).
(Inherited from PdfWidget.)
Public propertyType
Gets the type of this PdfWidget.
(Inherited from PdfWidget.)
Public propertyValueIsRequired
Gets or sets a value indicating whether this control must have a value at the time it is exported by a PdfSubmitFormAction.
(Inherited from PdfControl.)
Public propertyWidth
Gets or sets the width of the bounding box (rectangle that defines the location of the widget on the page).
(Inherited from PdfWidget.)

Methods

  NameDescription
Public methodAddItem(PdfListItem)
Adds the specified item to the list box.
Public methodAddItem(String)
Creates new list item with specified text and adds it to the list box.
Public methodAddItems(IEnumerable<PdfListItem>)
Adds the specified items to the list box.
Public methodAddItems(PdfListItem[])
Adds the specified items to the list box.
Public methodClearItems
Removes all items from the list box.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from PdfWidget.)
Public methodFlatten
Flattens this control to its parent page. In effect, replaces the control with its appearance.
(Inherited from PdfControl.)
Public methodGetHashCode
Serves as a hash function for a this type.
(Inherited from PdfWidget.)
Public methodGetType (Inherited from Object.)
Public methodRotate
Rotates control around top-left control's corner, counter-clockwise, relative to the page. Useful when PdfPage is rotated.
(Inherited from PdfControl.)
Public methodSelectItems
Marks specified items as selected.
Public methodToString
Returns a String that represents this instance.
(Overrides PdfControl.ToString().)

See Also