OdRadioButton Class

Class Hierarchy

Syntax

C++

class OdRadioButton : public OdObject;

File

PdfPublishRadioButton.h

Description

This class implements a radio button control contained in a .pdf document created with Publish SDK. A radio button represent a dependent option to be selected. An option is called dependent when several options are joined into a group and only one option from the group can be selected. Then the other options become unselected.

Group

Classes

Public Methods

	Name	Description
	~OdRadioButton	Destroys the radio button.

OdRadioButton Methods

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

Send feedback about this topic