OdSignatureField Class

Class Hierarchy

Syntax

C++

class OdSignatureField : public OdObject;

File

PdfPublishSignatureField.h

Description

This class implements a signature field contained in a .pdf document created with Publish SDK.

Group

Classes

Public Methods

	Name	Description
	~OdSignatureField	Destroys the signature field instance.

OdSignatureField Methods

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

Send feedback about this topic