NiXPSObjects::NODocument Class Reference

#include "NODocument.h"

Inheritance diagram for NiXPSObjects::NODocument:

Inheritance graph
[legend]
Collaboration diagram for NiXPSObjects::NODocument:

Collaboration graph
[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 ()
bool searchAndReplaceText (const UTF8Char *pSearch, const UTF8Char *pReplace, NOFontVector &pMissingFonts, bool pDryRun)


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.

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


The documentation for this class was generated from the following files:
Generated on Mon Sep 24 15:01:43 2007 for NiXPS Library by  doxygen 1.5.3