SftPrintPreview/OCX 1.0

SftPrintPreview.VisitedPageInfo Property

Softel vdm, Inc.

Returns saved page information for a given page.

Syntax       

Get

VB.NET

Info = object.get_VisitedPageInfo(ByVal PageNumber As Integer)  As Object

VB

Info = object.VisitedPageInfo(ByVal PageNumber As Long)  As Variant

C#.NET

object Info = object.get_VisitedPageInfo(int PageNumber);

VC++

_variant_t Info = object->VisitedPageInfo[long PageNumber];
_variant_t Info = object->GetVisitedPageInfo(long PageNumber);

C

HRESULT object->get_VisitedPageInfo(long PageNumber, VARIANT* Info);

Delphi

Info := object.VisitedPageInfo[PageNumber : Integer]   : OleVariant;

object

A SftPrintPreview object.

PageNumber

The zero-based page number, for which saved page information is requested.  The valid range is 0 .. maximum visited pages.  The last visited page number is available using the VisitedPages property.

Info

Returns saved page information for a given page.

Comments

The VisitedPageInfo property returns saved page information for a given page.

When the RenderContent event is called with a Function argument of renderSftPrintPreview_1Page, the application renders the requested page.  At the end, it can save an application defined value in the VisitedPageInfo argument of the event.  This value can be a simple long value, or even an object or a pointer to an application allocated structure.   In either case, the value describes the exact output position necessary to resume printing (the next page).  SftPrintPreview/OCX saves all these returned values and they are accessible through the VisitedPageInfo property.  The VisitedPageInfo property is an array of application-defined values, one entry for each visited page (starting at the first page, page 0).  Up to VisitedPages entries are available.

The VisitedPages property is used to determine the total number of currently visited pages.  The TotalPages property contains the total number of pages. 


Feedback / comments / error reports for this topic
© 2004 - Softel vdm, Inc. - www.windowscontrols.com