OdButton Class

Class Hierarchy

Syntax

C++

class OdButton : public OdObject;

File

PdfPublishButton.h

Description

This class implements a button control encapsulated in a .pdf document created with Publish SDK. A button control is used in a .pdf document to implement a reaction to user actions (such as different kinds of mouse clicks). The button control appearance (how a button looks in a document) is defined by a set of special properties (for example, font, color, text and so on).

Group

Classes

Public Methods

	Name	Description
	~OdButton	Destroys a button object.

OdButton Methods

	Name	Description
	getBorder	Returns whether the button has a border. The method fills a passed boolean value and returns it to a calling subroutine. If the button has a border, the method returns true, otherwise it returns false.
	getBorderColor	Returns the button border color. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.
	getBorderStyle	Returns the button border style. The method fills a passed value with the current style and returns it to a calling subroutine.
	getBorderThickness	Returns the button border thickness. The method fills a passed value with the current thickness value and returns it to a calling subroutine.
	getFillColor	Returns the button fill color. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.
	getFont	Returns the current button font parameters. The method fills passed values and returns them to a calling subroutine.
	getFontSize	Returns the button font size. The method fills a passed value and returns it to a calling subroutine.
	getHighlighting	Returns the current button highlighting mode. The method fills a passed value and returns it to a calling subroutine.
	getIconImage	Returns the button icon image. The method fills a passed OdImage object and returns it to a calling subroutine.
	getLabel	Returns the button label text. The method fills a passed string object with the label text and returns this string to a calling subroutine.
	getLabelPosition	Returns the current button label position. The method fills a passed value and returns it to a calling subroutine.
	getLock	Returns whether the button is locked. The method fills a passed boolean value and returns it to a calling subroutine. If the button is locked, the method returns true, otherwise it returns false.
	getName	Returns the button name. The method fills a passed string object with the name value and returns this string to a calling subroutine.
	getPrintability	Returns the current flag value that defines whether the button should be printed. The method fills a passed boolean value and returns it to a calling subroutine. If the button should be printed, the method returns true, otherwise it returns false.
	getTextColor	Returns the button text color. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.
	getTextRotation	Returns the current button text rotation. The method fills a passed value with the current rotation and returns it to a calling subroutine.
	getTooltip	Returns the button tooltip text. The method fills a passed string object and returns it to a calling subroutine.
	getVisibility	Returns the current button visibility state. The method fills a passed boolean value and returns it to a calling subroutine. If the button is visible, the method returns true, otherwise it returns false.
	setBorder	Shows or hides a border around the button.
	setBorderColor	Sets the button border color.
	setBorderStyle	Sets the button border style.
	setBorderThickness	Sets the button border thickness.
	setFillColor	Sets a color that is used for filling the button.
	setFont	This is the overview for the setFont method overload.
	setFontSize	Sets the button font size.
	setHighlighting	Sets the button highlighting mode.
	setIconImage	Sets the button icon image.
	setLabel	Sets the button label text.
	setLabelPosition	Sets a position for the button label.
	setLock	Locks or unlocks the button.
	setName	Sets the button name.
	setPrintability	Sets the button behavior when a document is printed.
	setTextColor	Sets the button text color. The text color is applied to the button label.
	setTextRotation	Sets the button text rotation.
	setTooltip	Sets the button tooltip text. Tooltip text is text that appears when a user hovers the pointer over the button.
	setVisibility	Sets the button visibility.

Send feedback about this topic