NiXPSObjects::NODocument Class Reference

#include "NODocument.h"

Inheritance diagram for NiXPSObjects::NODocument:

[legend]

Collaboration diagram for NiXPSObjects::NODocument:

[legend]

List of all members.

Public Member Functions
NCommon::UInt32	getNumberOfPages ()
NOPage	getPage (const UInt32 &pNum)
NCommon::UInt32	getPageNumberOf (const NOPage &pPage)
NOPage	insertPage (const NOPage &pPage, UInt32 pPos)
NOPage	createPage ()
UInt32	exportToPDF (const UTF8Char *pPDFFileName, NOProgressReporter &pProgressReporter)
NOXDocumentStructure	getDocumentStructure ()
bool	hasDocumentStructure ()
bool	searchAndReplaceText (const UTF8Char *pSearch, const UTF8Char *pReplace, NOFontVector &pMissingFonts, bool pDryRun)
NOPackage	getPackage ()
NCommon::UInt32	getDocumentNumber ()
UInt32	getFonts (NOFontVector &pFonts)
UInt32	getImages (NOImageVector &pImages)
UInt32	resolveLink (const UTF8Char *pSearch, UInt16 &pPageID, UInt32 &pObjectID)

---

Detailed Description

Class representing a document in an XPS package.

---

Member Function Documentation

NCommon::UInt32 NiXPSObjects::NODocument::getNumberOfPages

(

)

Returns the number of pages.

NOPage NiXPSObjects::NODocument::getPage

(

const UInt32 &

pNum

)

Returns a given page represented by an NOPage object

Parameters:

pNum

The location of the page to obtain

Examples:

docexample_createpackage.cpp, docexample_extractimage.cpp, docexample_nocontentstream.cpp, docexample_render.cpp, and docexample_replacefont.cpp.

NCommon::UInt32 NiXPSObjects::NODocument::getPageNumberOf

(

const NOPage &

pPage

)

Returns the page number this page has in the document

Parameters:

pPage

the NOPage object representing the page of which we want to know the page number

NOPage NiXPSObjects::NODocument::insertPage	(	const NOPage &	pPage,
		UInt32	pPos
	)

Insert a page into a given location

Parameters:

	pPage	the NOPage object representing the page to be inserted
	pPos	the Postion to insert the page at

Examples:

docexample_createpackage.cpp.

NOPage NiXPSObjects::NODocument::createPage

(

)

Creates a new page adding it to the back of the pagelist.

Examples:

docexample_createpage.cpp.

UInt32 NiXPSObjects::NODocument::exportToPDF	(	const UTF8Char *	pPDFFileName,
		NOProgressReporter &	pProgressReporter
	)

Exports the document to a PDF file

Parameters:

	pPDFFileName	the path of the file to write
	pProgressReporter	This progress reporter object gets polled regularly with % update of the export process

NOXDocumentStructure NiXPSObjects::NODocument::getDocumentStructure

(

)

get the entry point to the object model for the document structure

bool NiXPSObjects::NODocument::hasDocumentStructure

(

)

returns wheter the document has structure information

bool NiXPSObjects::NODocument::searchAndReplaceText	(	const UTF8Char *	pSearch,
		const UTF8Char *	pReplace,
		NOFontVector &	pMissingFonts,
		bool	pDryRun
	)

Search and replace text in a document

Parameters:

	pSearch	String to search for
	pReplace	String to replace search string with
	pMissingFonts	Font vector that will represent the fonts missing to do the replacement if the search and replace fails
	pDryRun	Do a dry run, i.e. only test the search and replace and don't actually perform the operation

NOPackage NiXPSObjects::NODocument::getPackage

(

)

Returns the package to which the document belongs.

UInt32 NiXPSObjects::NODocument::getDocumentNumber

(

)

Returns the number of this document within its package.

NCommon::UInt32 NiXPSObjects::NODocument::getFonts

(

NOFontVector &

pFonts

)

Returns the count of the number of fonts in this document and a vector with all the fonts.

Parameters:

pFonts

The vector to put the fonts in

NCommon::UInt32 NiXPSObjects::NODocument::getImages

(

NOImageVector &

pImages

)

Returns the count of the number of images in this document and a vector with all the images.

Parameters:

pImages

The vector to put the images in

UInt32 NiXPSObjects::NODocument::resolveLink	(	const UTF8Char *	pSearch,
		UInt16 &	pPageID,
		UInt32 &	pObjectID
	)

Returns the page and the object ID the link is pointing to.

---

The documentation for this class was generated from the following files:

• NODocument.h
• NODocument.cpp

---