OdTextField Class

Class Hierarchy

Syntax

C++

class OdTextField : public OdObject;

File

PdfPublishTextField.h

Description

This class implements a text field control contained in a .pdf document created with Publish SDK. A text field allows entry of text information with specified format options.

Group

Classes

Public Methods

	Name	Description
	~OdTextField	Destroys the text field.

OdTextField Methods

	Name	Description
	getBorder	Returns the current value of the flag that determines whether the text field has a border. If the flag value is equal to true, the text field has a border, otherwise it does not. The method fills a passed boolean value with the text field border flag value and returns it to a calling subroutine.
	getBorderColor	Returns the current text field border color. The method fills a passed ODCOLORREF value with the text field border color value and returns it to a calling subroutine.
	getBorderStyle	Returns the current text field border style.
	getBorderThickness	Returns the current thickness value of the text field border. This method fills a passed value with the current thickness value and returns it to a calling subroutine.
	getDefaultValue	Returns the current text field default value. The method fills a passed string object with the current text field default value and returns it to a calling subroutine.
	getFillColor	Returns the text field fill color. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.
	getFont	Returns the current font type name used for displaying the text field caption. The method fills a passed string object with the text field font name and returns it to a calling subroutine.
	getFontSize	Returns the current font size used for displaying the text field caption. The method fills a passed integer value with the text field font size and returns it to a calling subroutine.
	getLock	Returns the current value of the flag that determines whether the text field is locked. If the flag value is equal to true, the text field is locked and becomes disabled, otherwise it is enabled and unlocked. The method fills a passed boolean value with the text field lock flag value and returns it to a calling subroutine.
	getMultiline	Returns the current multiline flag value of the text. This flag determines whether the text field content can be divided into several lines. If the flag is equal to true, the text field can contain several lines, otherwise text field content is in a single line. The method fills a passed boolean value with the current flag value and returns it to a calling subroutine.
	getName	Returns the current name of the text field. The method fills a passed string object with the text field name and returns it to a calling subroutine.
	getPrintability	Returns the current value of the flag that determines whether the text field should be printed. If the text field 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 text field printability flag value and returns it to a calling subroutine.
	getReadOnly	Returns the current read-only flag value of the text field. The read-only flag determines whether text field content can be edited (if its value is true) or not (if its value is false). The method fills a passed boolean value with the current flag value and returns it to a calling subroutine.
	getScrolling	Returns the current text field scrolling flag value. If the flag is equal to true, the text field has a scroll control that can be used to scroll multiline text. Otherwise the text field does not contain a scroll control. The method fills a passed boolean value with the current flag value and returns it to a calling subroutine.
	getTextColor	Returns the current text color used for displaying the text field caption. The method fills a passed ODCOLORREF value with the text field caption color and returns it to a calling subroutine.
	getTextJustification	Returns the current text field justification. The method fills a passed justification value and returns it to a calling subroutine.
	getTextRotation	Returns the current text field rotation value. The method fills a passed value with the current rotation value and returns it to a calling subroutine.
	getTooltip	Returns the current tooltip text for the text field. Tooltip text is the text that appears when a user hovers the mouse pointer over the text field. The method fills a passed string object with the text field tooltip text and returns it to a calling subroutine.
	getVisibility	Returns the current value of the visibility flag for the text field. The visibility flag determines whether the text field is visible in the document (if true) or is hidden (if false). The method fills a passed boolean value with the text field visibility flag value and returns it to a calling subroutine.
	setBorder	Sets a new value of the flag that determines whether the text field has a border. If the flag value is equal to true, the text field has a border, otherwise it does not.
	setBorderColor	Sets a text field border color.
	setBorderStyle	Sets a text field border style.
	setBorderThickness	Sets a text field border thickness.
	setDefaultValue	Sets a text field default value.
	setFillColor	Sets a text field fill color.
	setFont	This is the overview for the setFont method overload.
	setFontSize	Sets a font size for the text field.
	setLock	Sets a new value of the flag that determines whether the text field is locked. If the flag value is equal to true, the text field is locked and becomes disabled, otherwise it is enabled and unlocked.
	setMultiline	Sets a text field multiline flag value. This flag determines whether the text field content can be divided into several lines. If the flag is equal to true, the text field can contain several lines, otherwise text field content is in a single line.
	setName	Sets the text field name.
	setPrintability	Sets a new value of the flag that determines whether the text field should be printed. If the text field should be printed, the flag value is equal to true, otherwise it is equal to false.
	setReadOnly	Sets a text field read-only flag value. The read-only flag determines whether text field content can be edited (if its value is true) or not (if its value is false).
	setScrolling	Sets a text field scrolling flag value. If the flag is equal to true, the text field has a scroll control that can be used to scroll multiline text. Otherwise the text field does not contain a scroll control.
	setTextColor	Sets a foreground color for the text field.
	setTextJustification	Sets a text field justification value.
	setTextRotation	Sets a text field rotation value.
	setTooltip	Sets tooltip text for the text field. Tooltip text is the text that appears when a user hovers the mouse pointer over the text field.
	setVisibility	Sets a new value of the visibility flag for the text field. The visibility flag determines whether the text field is visible in the document (if true) or is hidden (if false).

Send feedback about this topic