Version www.capesoft.com Updated 16 November 2005

	FePDF

Contents
		The FePDF Object
		Methods
		The Templates
		Overview
		Useful References
		Overview

File Explorer Classes - FePDF

The FePDF Object is used to display Adobe Acrobat PDF files.  According to the ACrobat Developer FAQ, the Adobe Acrobat Reader ActiveX control was only developed to be used inside Internet Explorer, up until version 7.  File Explorer supports Acrobat Reader version 5 and above, but we recommend that you install version 7 or later.

FePDF - Methods

Quick Reference

Init

Kill

Load

Navigate

PrintMe

PrintPages

Reload

Update




Init     ( long ParentControl, <string LoadPath>, long Handle1=0, long Handle2=0, byte SkipCallbacks=false ) ,byte,proc ThisViewer.Init (?feControl) This method initializes the object, and must be called before any other methods are called.

Kill     (  ) ThisViewer.Kill() Call this method as the procedure closes (ThisWindow::Kill).  This method handles the "closing down" of each object

Load     ( string CurrentPath, <long CurrentControl>, <byte Version> ) ,byte,proc TempByte = ThisViewer.Load ('c:\test.pdf') ThisViewer.Load ('c:\test.pdf', ?feControl5, 4) Loads a PDF document into the File Explorer Viewer control. The CurrentControl parameter is no longer used. The Version parameter is also no longer used.

Navigate     ( byte Location, <short PageNumber>, <string Optionals> ) ThisViewer.Navigate (1)  ! goto first page ThisViewer.Navigate (5, 22)  ! goto page number 22 Use this method to navigate within the loaded document ( i.e. to go to a specific page ). The "Location" parameter can be one of the following values: 1  - Go to the first page of the loaded document 2  - Go to the previous page 3  - Go to the next page 4  - Go to the end / last page of the loaded document 5  - Go to a specific page number If you pass 5 as the "Location" parameter (specific page), then you would pass the Page Number as the second parameter ("PageNumber"). Only Acrobat 4 supports this method.

PrintMe     ( byte ShowDialog ) ThisViewer.PrintMe (1) Prints the loaded document.  As if you pressed the "Print" button on Adobe Acrobat's toolbar. The ShowDialog parameter... (To Do)

PrintPages     ( long FromPage, long ToPage, byte ShrinkToFit ) ThisViewer.PrintPages (3, 5, 1) ! print pages 3 to 5, and shrink pages to fit the current printer settings This method differs from the "PrintMe" method in that it prints a document from a specific page, to a specific page, and does not support the option to first call the printer dialog window.  It also supports "ShrinkToFit", where a page larger that your current printer page settings will be "shrunk" to fit on a single page.

Reload     ( <long CurrentControl> ) ThisViewer.Reload() This method simply reloads the last document which was loaded successfully. The CurrentControl parameter is no longer used.

Update     ( string Property, string PropValue ) ThisViewer.Update ('PDFScrollBars', '1')  ! show scrollbars ThisViewer.Update ('PDFZoom', '50')  ! 50% Use this method to update various "properties" / "values" for the object.  These "values" could also be actual properties of the File Explorer class.  The reason you use this method and don't just change the properties "directly" is because using this method results in the changes being implemented "immediately", and not for instance only coming into effect the next time you load a document into the object which is often the "default" behavior. The "Property" parameter can be one of the following: "PDFScrollBars" (true / false) "PDFToolbar" (true / false) "PDFZoom" (1 to 100)

FePDF - Properties (alphabetical)

PdfScrollbars (Byte)	Set to "true" (1) to display scrollbars on the PDF control, or "false" (0) to hide them.  Can either be set before calling the Load method (see example 1 below), or at any time after the document has loaded, using the Update method (see example 2 below). Example 1: (before call to "load" method) ThisViewer1.PdfScrollbars = false ThisViewer1.Load ('c:\MyFile.pdf') Example 2: (any time after a document has loaded) ThisViewer.Update ( 'PdfScrollbars', '1' ) Note:  This property only works if you are using Adobe Acrobat 4, which can be set from the Viewer Control's properties.  ( See the notes on the "Init" method ).
PdfToolbar (Byte)	Similar to the PdfScrollbars property, (see above), this property can be set using the same techniques.  A value of True (1) shows the native Adobe toolbar, a value of False (0) hides it. Note:  This property only works if you are using Adobe Acrobat 4, which can be set from the Viewer Control's properties.  ( See the notes on the "Init" method ).
PdfVersion (String)	If you want to specify which version of Adobe Acrobat File Explorer should use, you can do it in one of two places: either in the Version parameter of the Load method, or by setting the PdfVersion property before calling the Load method.  Valid values are either "Acrobat 4" or "Acrobat 5" ( or just "4" or "5" ).  If you are using the templates, this can be set from the Viewer Control properties.
PdfZoom (Long)	Sets the "zoom" for the PDF control.  Holds a value from 1 (1%) to 100 (100%).  See the notes on the PdfScrollbars property (aboce) to see how you set this property (works the same way). Example: ThisViewer.Update ( 'PdfZoom', '75' ) ! sets the zoom to 75% Note:  This property only works if you are using Adobe Acrobat 4, which can be set from the Viewer Control's properties.  ( See the notes on the "Init" method ).

FePDF - Templates

At this time there is quite an overlap in terms of multiple File Explorer classes being implemented by the same templates.  In the future we may revisit this, but for now all templates are covered in the main (FileExplorer.htm) help document, please click here.

FePDF - Useful References

At this time this section is found in the main (FileExplorer.htm) help document, please click here.