pdftron::Layout::FlowDocument Class Reference

#include <FlowDocument.h>

Inheritance diagram for pdftron::Layout::FlowDocument:

Public Member Functions
	FlowDocument ()
	~FlowDocument ()
Section	AddSection ()
Section	GetCurrentSection ()
UInt32	GetNumSections ()
Section	GetSection (UInt32 index)
void	SetDefaultMargins (double left, double top, double right, double bottom)
void	SetDefaultPageSize (double width, double height)
PDF::PDFDoc	PaginateToPDF ()
Public Member Functions inherited from pdftron::Layout::ContentContainer
Paragraph	AddParagraph ()
Paragraph	AddParagraph (const UString &text)
List	AddList ()
Table	AddTable ()
Public Member Functions inherited from pdftron::Layout::ContentNode
	~ContentNode ()
void	Destroy ()
ContentNodeIterator	GetContentNodeIterator ()
Public Member Functions inherited from pdftron::Layout::ContentElement
	~ContentElement ()
void	Destroy ()
ElementRef< List >	AsList () const
ElementRef< ListItem >	AsListItem () const
ElementRef< ContentNode >	AsContentNode () const
ElementRef< TextRun >	AsTextRun () const
ElementRef< PageNumber >	AsPageNumber () const
ElementRef< Shape >	AsShape () const
ElementRef< Float >	AsFloat () const
ElementRef< Chart >	AsChart () const
ElementRef< Paragraph >	AsParagraph () const
ElementRef< Table >	AsTable () const
ElementRef< TableRow >	AsTableRow () const
ElementRef< TableCell >	AsTableCell () const
TextStyledElement	GetTextStyledElement ()

Public Attributes
TRN_FlowDocument	m_flowdoc_impl
Public Attributes inherited from pdftron::Layout::ContentElement
TRN_ContentElement	m_impl

Additional Inherited Members
Protected Member Functions inherited from pdftron::Layout::ContentContainer
	ContentContainer (TRN_ContentContainer impl)
Protected Member Functions inherited from pdftron::Layout::ContentNode
	ContentNode (TRN_ContentNode impl)
Protected Member Functions inherited from pdftron::Layout::ContentElement
	ContentElement (TRN_ContentElement impl)

Detailed Description

The class FlowDocument. Encapsulates document creation API.

Definition at line 17 of file FlowDocument.h.

Constructor & Destructor Documentation

pdftron::Layout::FlowDocument::FlowDocument

(

)

A constructor. Creates an empty document containing a single section.

pdftron::Layout::FlowDocument::~FlowDocument

(

)

Destroy the FlowDocument object

Member Function Documentation

Section pdftron::Layout::FlowDocument::AddSection

(

)

Add a new section at the end of the document and make it the current section.

Content added directly to the FlowDocument afterwards is added to the newly created section.

Returns

The newly created Section object.

Section pdftron::Layout::FlowDocument::GetCurrentSection

(

)

Get the current section, i.e. the section that content added directly to the FlowDocument goes into.

Returns

The current Section object.

UInt32 pdftron::Layout::FlowDocument::GetNumSections

(

)

Get the number of sections in the document.

Returns

The number of sections.

Section pdftron::Layout::FlowDocument::GetSection

(

UInt32

index

)

Get a section of the document by index.

Parameters

index

The zero based index of the section.

Returns

The Section object at the given index.

PDF::PDFDoc pdftron::Layout::FlowDocument::PaginateToPDF

(

)

Paginates the content tree into a PDFDoc object.

Returns

The PDFDoc object

void pdftron::Layout::FlowDocument::SetDefaultMargins	(	double	left,
		double	top,
		double	right,
		double	bottom
	)

Set the default margins for the document.

Parameters

left	The left margin in points
top	The top margin in points
right	The right margin in points
bottom	The bottom margin in points

void pdftron::Layout::FlowDocument::SetDefaultPageSize	(	double	width,
		double	height
	)

Set the default page size for the document.

Parameters

width	The width in points
height	The height in points

Member Data Documentation

TRN_FlowDocument pdftron::Layout::FlowDocument::m_flowdoc_impl

Definition at line 92 of file FlowDocument.h.

---

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

• Layout/FlowDocument.h