OdCheckBox Class

Class Hierarchy

Syntax

C++

class OdCheckBox : public OdObject;

File

PdfPublishCheckBox.h

Description

This class implements a checkbox control encapsulated in a .pdf document created with Publish SDK. A checkbox control is used in a .pdf document to set any boolean parameters and can accept two values: true (the checkbox is switched on) and false (the checkbox is switched off).

Group

Classes

Public Methods

	Name	Description
	~OdCheckBox	Destroys a checkbox control.

OdCheckBox Methods

	Name	Description
	getBorder	Returns the current value of the flag that determines whether the checkbox has a border. If the flag value is equal to true, the checkbox has a border, otherwise it does not. The method fills a passed boolean value with the checkbox border flag value and returns it to a calling subroutine.
	getBorderColor	Returns the current checkbox border color. The method fills a passed ODCOLORREF value with the checkbox border color value and returns it to a calling subroutine.
	getBorderStyle	Returns the current checkbox border style. The method fills a passed value with current border style and returns it to a calling subroutine.
	getBorderThickness	Returns the current checkbox border thickness. The method fills a passed value with the current border thickness and returns it to a calling subroutine.
	getDefaultState	Returns the current checkbox default state. If the default state is equal to true, the checkbox is switched on when it displays in a document, otherwise the checbox is switched off. The method fills a boolean object with the checkbox default state value and returns it to a calling subroutine.
	getExportValue	Returns the current export value for the checkbox. The method fills a passed string object with the checkbox export value and returns it to a calling subroutine.
	getFillColor	Returns the current checkbox fill color. The method fills a passed ODCOLORREF value with the checkbox fill color value and returns it to a calling subroutine.
	getFont	Returns the current font parameters used for displaying the checkbox caption. The method fills passed values and returns them to a calling subroutine.
	getFontSize	Returns the current font size used for displaying the checkbox caption. The method fills a passed integer value with the checkbox font size and returns it to a calling subroutine.
	getLock	Returns the current value of the flag that determines whether the checkbox is locked. If the flag value is equal to true, the checkbox is locked and becomes disabled, otherwise it is enabled and unlocked. The method fills a passed boolean value with the checkbox lock flag value and returns it to a calling subroutine.
	getName	Returns the current name of the checkbox. The method fills a passed string object with the checkbox name and returns it to a calling subroutine.
	getPrintability	Returns the current value of the flag that determines whether the checkbox should be printed. If the checkbox 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 checkbox printability flag value and returns it to a calling subroutine.
	getTextColor	Returns the current text color used for displaying the checkbox caption. The method fills a passed ODCOLORREF value with the checkbox caption color and returns it to a calling subroutine.
	getTextRotation	Returns the current rotation for the checkbox text. The method fills a passed value with current rotation value and returns it to a calling subroutine.
	getTooltip	Returns the current tooltip text for the checkbox. Tooltip text is text that appears when a user hovers the mouse pointer over the checkbox. The method fills a passed string object with the checkbox tooltip text and returns it to a calling subroutine.
	getVisibility	Returns the current value of the visibility flag for the checkbox. The visibility flag determines whether the checkbox is visible in a document (if true) or is hidden (if false). The method fills a passed boolean value with the checkbox visibility flag value and returns it to a calling subroutine.
	setBorder	Sets a new value of the flag that determines whether the checkbox has a border. If the flag value is equal to true, the checkbox has a border, otherwise it does not.
	setBorderColor	Sets a checkbox border color.
	setBorderStyle	Sets a checkbox border style.
	setBorderThickness	Sets a checkbox border thickness.
	setDefaultState	Sets a checkbox default state. If the default state is equal to true, the checkbox is switched on when it is displayed in a document, otherwise the checbox is switched off.
	setExportValue	Sets an export value for the checkbox.
	setFillColor	Sets a checkbox fill color.
	setFont	This is the overview for the setFont method overload.
	setFontSize	Sets a font size used for displaying the checkbox caption.
	setLock	Sets a new value of the flag that determines whether the checkbox is locked. If the flag value is equal to true, the checkbox is locked and becomes disabled, otherwise it is enabled and unlocked.
	setName	Sets a name for the checkbox.
	setPrintability	Sets a new value of the flag that determines whether the checkbox should be printed. If the checkbox should be printed, the flag value is equal to true, otherwise it is equal to false.
	setTextColor	Sets a text color used for displaying the checkbox caption.
	setTextRotation	Sets a new rotation value for the checkbox text.
	setTooltip	Sets tooltip text for the checkbox. Tooltip text is text that appears when a user hovers the mouse pointer over the checkbox.
	setVisibility	Sets a new value of the visibility flag for the checkbox. The visibility flag determines whether the checkbox is visible in a document (if true) or is hidden (if false).

Send feedback about this topic