OdListBox Class

Class Hierarchy

Syntax

C++

class OdListBox : public OdObject;

File

PdfPublishListBox.h

Description

This class implements a list box control contained in a .pdf document created with Publish SDK. A list box contains a list of predefined items that can be selected (one or several depending on the multiple selection flag value).

Group

Classes

Public Methods

	Name	Description
	~OdListBox	Destroys the list box control.

OdListBox Methods

	Name	Description
	getBorder	Returns the current value of the flag that determines whether the list box has a border. If the flag value is equal to true, the list box has a border, otherwise it does not. The method fills a passed boolean value with the list box border flag value and returns it to a calling subroutine.
	getBorderColor	Returns the current list box border color. The method fills a passed ODCOLORREF value with the list box border color value and returns it to a calling subroutine.
	getBorderStyle	Returns the current list box border style. The method fills a passed value with the current list box border style and returns it to a calling subroutine.
	getBorderThickness	Returns the current list box border thickness. The method fills a passed value with the current list box border thickness and returns it to a calling subroutine.
	getContents	Returns the list box content items. The method fills passed string arrays for displaying and exporting values of the list box and returns them to a calling subroutine.
	getFillColor	Returns the current list box fill color. The method fills a passed ODCOLORREF value with the list box fill color value and returns it to a calling subroutine.
	getFont	Returns current font parameters used for displaying list box items. The method fills passed values and returns them to a calling subroutine.
	getFontSize	Returns the current font size used for displaying list box items. The method fills a passed integer value with the list box font size and returns it to a calling subroutine.
	getLock	Returns the current value of the flag that determines whether the list box is locked. If the flag value is equal to true, the list box is locked and becomes disabled, otherwise it is enabled and unlocked. The method fills a passed boolean value with the list box lock flag value and returns it to a calling subroutine.
	getMultipleSelection	Returns the current multiple selection flag of the list box. The multiple selection flag determines whether more than one item from the list box can be selected simultaneously.
	getName	Returns the current name of the list box. The method fills a passed string object with the list box name and returns it to a calling subroutine.
	getPrintability	Returns the current value of the flag that determines whether the list box should be printed. If the list box should be printed, the flag value is equal to true, otherwise it is equal to false. The method fills a passed boolean value with the list box printability flag value and returns it to a calling subroutine.
	getTextColor	Returns the current text color used for displaying list box items. The method fills a passed ODCOLORREF value with the list box caption color and returns it to a calling subroutine.
	getTextRotation	Returns the current text rotation for the list box. The method fills a passed value with the current text rotation value and returns it to a calling subroutine.
	getTooltip	Returns the current tooltip text for the list box. Tooltip text is text that appears when a user hovers the mouse pointer over the list box. The method fills a passed string object with the list box tooltip text and returns it to a calling subroutine.
	getVisibility	Returns the current value of the visibility flag for the list box. The visibility flag determines whether the list box is visible in a document (if true) or is hidden (if false). The method fills a passed boolean value with the list box visibility flag value and returns it to a calling subroutine.
	setBorder	Sets a new value of the flag that determines whether the list box has a border. If the flag value is equal to true, the list box has a border, otherwise it does not.
	setBorderColor	Sets the list box border color.
	setBorderStyle	Sets the list box border style.
	setBorderThickness	Sets the list box border thickness.
	setContents	Sets the list box content. The method fills the list box with an array of items. Each item is a string value.
	setFillColor	Sets the list box fill color.
	setFont	This is the overview for the setFont method overload.
	setFontSize	Sets a font size for the list box.
	setLock	Sets a new value of the flag that determines whether the list box is locked. If the flag value is equal to true, the list box is locked and becomes disabled, otherwise it is enabled and unlocked.
	setMultipleSelection	Sets the multiple selection flag of the list box. The multiple selection flag determines whether more than one item from the list box can be selected simultaneously.
	setName	Sets the list box name.
	setPrintability	Sets a new value of the flag that determines whether the list box should be printed. If the list box should be printed, the flag value is equal to true, otherwise it is equal to false.
	setTextColor	Sets a text color for the list box.
	setTextRotation	Sets a new value for the list box text rotation.
	setTooltip	Sets tooltip text for the list box. Tooltip text is text that appears when a user hovers the mouse pointer over the list box.
	setVisibility	Sets a new value of the visibility flag for the list box. The visibility flag determines whether the list box is visible in a document (if true) or is hidden (if false).

Send feedback about this topic