OdPage Class

Syntax

C++

class OdPage : public OdObject;

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.).

Class Hierarchy

File: PdfPublishPage.h

Namespace: OdPdfPublish

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdRxObject	Default constructor for this class. (Inherited from OdRxObject)
~OdObject	Destroys an instance of a Publish SDK object. (Inherited from OdObject)
~OdPage	Destroys a page object.
~OdRxObject	The virtual destructor for this class. (Inherited from OdRxObject)

Methods

Show:Inherited

No members matching the current filter

add2dGeometry(const Od2dGeometryReferencePtr&)	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(const OdCADReferencePtr&)	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.
addRef	Declares the method incrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
addSignatureField	Adds a signature field to the page.
addSlideTable	Adds a table with slides to the page.
addStickyNote	Adds a sticky note object 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.
addWatermark	Adds a watermark label to the page.
cast	Casts the specified raw pointer to the smart pointer. (Inherited from OdRxObject)
clear	Clears the Publish SDK object. (Inherited from OdObject)
clone	Creates a clone of this object, and returns a pointer to the clone. (Inherited from OdRxObject)
comparedTo	Compares another object to this one in a some meaning. (Inherited from OdRxObject)
copyFrom	details Copies the contents of the specified object into this object. (Inherited from OdRxObject)
desc	Returns the raw pointer to the class describing instance statically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
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.
getImages	Returns all images that the page contains and their locations. The method fills three passed arrays with image objects, their locations, and their rotation angles, 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. The method fills two passed double values with width and height values, then returns them to a calling subroutine.
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.
getStickyNotes	Returns an array of sticky notes which the page contains. The method fills two passed arrays with smart pointers to sticky note objects and their locations (represented with rectangles), 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 three passed arrays with text label objects, their locations, and their rotation angles, then returns these arrays to a calling subroutine.
getWatermarks	Returns all watermarks that the page contains and their locations. The method fills two passed arrays with watermark objects and their locations, then returns these arrays to a calling subroutine.
isA	Returns the raw pointer to the class describing instance dynamically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
isEmpty	Determines whether the Publish SDK object is empty. (Inherited from OdObject)
isEqualTo	Returns true if and only if the specified object is equal to this one in a some meaning. (Inherited from OdRxObject)
isKindOf	Checks whether the object belongs to the specified class and returns true if and only if this object is an instance of the specified class or a subclass of the specified class. (Inherited from OdRxObject)
isValid	Determines whether the Publish SDK object is valid. (Inherited from OdObject)
numRefs	Returns the value of the reference counter, that is, the number of references to an instance of this class. (Inherited from OdRxObject)
queryX	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class. (Inherited from OdRxObject)
release	Declares the method decrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
rxInit	for internal use (Inherited from OdRxObject)
rxUninit	(Inherited from OdRxObject)
setFormat	Sets the page format.
setOrientation	Sets the page orientation.
setPaperSize	Sets a new page size.
x	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class, or throws an exception if it cannot. (Inherited from OdRxObject)

Links

OdPage Methods

Relief for ODA Team in Ukraine