OdPage Class

Class Hierarchy

Syntax

C++

class OdPage : public OdObject;

File

PdfPublishPage.h

Description

This class implements a page object for a .pdf document created with Publish SDK. A page is determined by two properties: format (size of its sides) and orientation (which side aligns horizontally) and can contain a set of different controls and fields (such as text labels, annotations, text fields, buttons, links, etc.).

Group

Classes

Public Methods

	Name	Description
	~OdPage	Destroys a page object.

OdPage Methods

	Name	Description
	add2dGeometry	This is the overview for the add2dGeometry method overload.
	addAnnotation	Adds a new annotation to the page.
	addButton	Adds a button control to the page.
	addCADReference	This is the overview for the addCADReference method overload.
	addCheckBox	Adds a checkbox to the page.
	addDropDownList	Adds a drop-down list (combo box) to the page.
	addImage	Adds an image to the page.
	addJavaScriptActionByField	Adds a JavaScript scenario for a specified field on the page.
	addLink	Adds a link to the page.
	addListBox	Adds a list box to the page.
	addRadioButton	Adds a radio button to the page.
	addSignatureField	Adds a signature field to the page.
	addSlideTable	Adds a table with slides to the page.
	addTable	Adds a table to the page.
	addText	Adds a text label to the page.
	addTextField	Adds a text field to the page.
	get2dGeoms	Returns two-dimensional geometry references previously added to the page. The method fills two passed arrays with geometry references and their locations, then returns these arrays to a calling subroutine.
	getAnnotations	Returns all annotations that the page contains and their locations. The method fills two passed arrays with annotation objects and their locations, then returns these arrays to a calling subroutine.
	getButtons	Returns all buttons that the page contains and their locations. The method fills two passed arrays with button objects and their locations, then returns these arrays to a calling subroutine.
	getCADReferences	Returns all CAD references previously added to the page. The method fills two passed arrays with CAD references and their locations, then returns these arrays to a calling subroutine.
	getCheckBoxes	Returns all checkboxes that the page contains and their locations. The method fills two passed arrays with checkbox objects and their locations, then returns these arrays to a calling subroutine.
	getDropDownLists	Returns all drop-down lists that the page contains and their locations. The method fills two passed arrays with drop-down list objects and their locations, then returns these arrays to a calling subroutine.
	getFormat	Returns the current page format value.
	getImages	Returns all images that the page contains and their locations. The method fills two passed arrays with image objects and their locations, then returns these arrays to a calling subroutine.
	getJavaScriptActionsByField	Returns all JavaScript scenarios previously added to the page's field. The method fills passed arrays with scenario source text, action types and source types, then returns these arrays to a calling subroutine.
	getLinks	Returns all links that the page contains and their locations. The method fills two passed arrays with link objects and their locations, then returns these arrays to a calling subroutine.
	getListBoxes	Returns all list boxes that the page contains and their locations. The method fills two passed arrays with list box objects and their locations, then returns these arrays to a calling subroutine.
	getOrientation	Returns the current page orientation value.
	getPaperSize	Returns the current page size.
	getRadioButtons	Returns all radio buttons that the page contains and their locations. The method fills two passed arrays with radio button objects and their locations, then returns these arrays to a calling subroutine.
	getSignatureFields	Returns all signature fields that the page contains and their locations. The method fills two passed arrays with signature field objects and their locations, then returns these arrays to a calling subroutine.
	getSlideTables	Returns all slide tables, which the page contains, and their locations. The method fills two passed arrays with slide table objects and their locations, then returns these arrays to a calling subroutine.
	getTables	Returns all tables that the page contains and their locations. The method fills two passed arrays with table objects and their locations, then returns these arrays to a calling subroutine.
	getTextFields	Returns all text fields, which the page contains, and their locations. The method fills two passed arrays with text field objects and their locations, then returns these arrays to a calling subroutine.
	getTexts	Returns all text labels that the page contains and their locations. The method fills two passed arrays with text label objects and their locations, then returns these arrays to a calling subroutine.
	setFormat	Sets the page format.
	setOrientation	Sets the page orientation.
	setPaperSize	Sets a new page size.

Send feedback about this topic