The PDF view control, which is able to open/display/save/...etc the PDF document. More...
Inherits ContentControl.
Public Member Functions | |
Windows::Foundation::IAsyncOperation< foxit::common::ErrorCode > ^ | OpenDocAsync (Windows::Storage::StorageFile^ file, Platform::String^ password) |
Open pdf doc with async. More... | |
Windows::Foundation::IAsyncOperation< foxit::common::ErrorCode > ^ | OpenDocAsync (Platform::String^ filePath, Platform::String^ password) |
Open pdf doc with async. More... | |
Windows::Storage::StorageFile ^ | GetStorageFile () |
Get the storage file associates with current opened PDF document. More... | |
void | GotoPage (int iPageIndex) |
Go to a specified page. More... | |
void | GotoPagePoint (int iPageIndex, Windows::Foundation::Point pt) |
Go to a specified point on the specified page. More... | |
void | GotoBookmark (foxit::pdf::Bookmark^ bookmark) |
Go to a destination which associate with the bookmark. More... | |
bool | GotoFirstPage () |
Go to the first page. More... | |
bool | GotoLastPage () |
Go to the last page. More... | |
bool | GotoPreviousPage () |
Go to the previous page. More... | |
bool | GotoNextPage () |
Go to the next page. More... | |
int | GetCurrentPage () |
Get the current page index. More... | |
int | GetPageAtPoint (Windows::Foundation::Point pt) |
Get the page index at specified device point. More... | |
Windows::Foundation::Collections::IVector< int > ^ | GetVisiblePages () |
Get the visible pages. More... | |
foxit::rdk::ZoomMode | GetPageZoomMode () |
Get the page zoom mode. More... | |
void | SetPageZoomMode (foxit::rdk::ZoomMode pageMode) |
Set the page zoom mode. More... | |
foxit::rdk::LayoutMode | GetPageLayoutMode () |
Get the page layout mode. More... | |
void | SetPageLayoutMode (foxit::rdk::LayoutMode mode) |
Set the page layout mode. More... | |
foxit::pdf::PDFDoc ^ | GetDoc () |
Get the current document. More... | |
void | SetDoc (foxit::pdf::PDFDoc^ doc) |
Open the specified document, so that the document will be the current document. More... | |
Windows::Foundation::IAsyncAction ^ | SaveDoc () |
Save the current document to local file, only works when the document is opened from local, and file write access is granted. More... | |
void | CloseDoc () |
Close the current document. More... | |
bool | IsModified () |
Is the document is modified. More... | |
void | SetModified (bool isModified) |
Set the current document modification flag. More... | |
foxit::common::ContentFlag | GetRenderFlag () |
Get the render content flag, See macros FSRenderContentFlag::XXX. | |
void | SetRenderFlag (foxit::common::ContentFlag flag) |
Set the render content flag, See macros FSRenderContentFlag::XXX. | |
void | HideAnnotType (foxit::pdf::annots::AnnotType type) |
Hide the specified annotation type, so that this type of annotations will not be rendered. | |
int | GetPageCount () |
Get the page count of current document. | |
float | GetScale () |
Get the scale of view control. | |
void | SetScale (float scale) |
Set the scale of view control. | |
float | GetMinScale () |
Get the minimal scale of view control. | |
float | GetMaxScale () |
Get the maxium scale of view control. | |
void | OffsetView (double vOffset, double hOffset) |
Offset the current page view by the specified horizontal and vertical distance. More... | |
void | ZoomTo (Windows::Foundation::Point centerPt, double scale, bool isInertial, bool isManipulationComplete) |
Zoom the current page view by a specified scale, and centered on the specified device point. More... | |
void | SetRotate (int rotate) |
Set the rotation of page view. | |
int | GetRotate () |
Get the rotation of page view. | |
Windows::Foundation::Size | GetCanvasSize () |
Get the size of pdf canvas, in device cordinate. | |
void | SetDefaultViewMode (foxit::rdk::LayoutMode mode) |
Set the default view mode. | |
void | SetViewColor (Windows::UI::Color bgColor, Windows::UI::Color fgColor) |
Set the background and foreground color of page. | |
void | Redraw () |
Redraw all the visible pages on canvas, then update the device canvas. | |
void | Redraw (int pageIndex) |
Redraw the specified page on canvas, then update the device canvas. | |
void | Update () |
update the device canvas, which will trigger Render Canvas Event. | |
void | CancelRenderTask () |
Cancel the current render task. | |
void | EnableScrollView (bool isEnable) |
Enable or disable the page scrolling. | |
Windows::UI::Xaml::Media::Matrix | GetDisplayMatrix (int pageIndex) |
Get the display matrix with a specified page. | |
PDFPagePoint ^ | ConvertDevicePtToPDFPagePt (Windows::Foundation::Point devicePt) |
Convert the page point to device point. | |
Windows::Foundation::Point | ConvertPagePtToDevicePt (int pageIndex, Windows::Foundation::Point pagePt) |
Convert the device point to page point. | |
Windows::Foundation::Rect | ConvertDeviceRectToPageRect (int pageIndex, Windows::Foundation::Rect deviceRc) |
Convert the device rect to page rect. | |
Windows::Foundation::Rect | ConvertPageRectToDeviceRect (int pageIndex, Windows::Foundation::Rect pageRc) |
Convert the page rect to device rect. | |
Windows::Foundation::Rect | GetPageViewRect (int pageIndex) |
Get the specified page rect, in device coordinate. | |
void | SaveState (Windows::Storage::ApplicationDataCompositeValue^ data) |
Save the current view state. | |
Properties | |
IUIExtensionsEvents^ | ExtensionsManager [get, set] |
The UI extensions manager, which will extend the functions of view control. | |
Windows::UI::Xaml::Controls::Grid^ | Layout [get] |
The root layout of view control, caller may append UI layout to this root, so that view control will fit to any size of device. | |
float | CompositionScaleX [get] |
Horizontal scale of view control canvas. | |
float | CompositionScaleY [get] |
Vertical scale of view control canvas. | |
Windows::UI::Color | PageBgColor [get] |
Get the backgroud color of page. | |
Windows::UI::Color | PageFgColor [get] |
Get the foreground color of page. | |
bool | NightMode [get, set] |
Get/Set the night mode reading. | |
Events | |
RenderCanvasEvent^ | RenderCanvasEvent |
Canvas rendering event. | |
RenderPageEvent^ | RenderPageEvent |
Page rendering event. | |
OpenDocEvent^ | OpenPdfFileEvent |
PDF opened event. | |
CloseDocEvent^ | ClosePdfFileEvent |
PDF close event. | |
PageLoadedEvent^ | PageLoadedEvent |
Page load event. | |
PageUnloadedEvent^ | PageUnloadedEvent |
Page unload event. | |
PageVisibleEvent^ | PageVisibleEvent |
Page visible event. | |
PageInvisibleEvent^ | PageInvisibleEvent |
Page invisible event. | |
PageChangedEvent^ | PageChangedEvent |
Page index changed event. | |
PageLayoutModeChangedEvent^ | PageLayoutModeChangedEvent |
PageMOde changed event. | |
The PDF view control, which is able to open/display/save/...etc the PDF document.
void foxit::rdk::PDFViewCtrl::CloseDoc | ( | ) |
Close the current document.
int foxit::rdk::PDFViewCtrl::GetCurrentPage | ( | ) |
Get the current page index.
foxit::pdf::PDFDoc ^ foxit::rdk::PDFViewCtrl::GetDoc | ( | ) |
Get the current document.
int foxit::rdk::PDFViewCtrl::GetPageAtPoint | ( | Windows::Foundation::Point | pt | ) |
Get the page index at specified device point.
[in] | pt | The point on the view control,in device coordinate. |
foxit::rdk::LayoutMode foxit::rdk::PDFViewCtrl::GetPageLayoutMode | ( | ) |
Get the page layout mode.
foxit::rdk::ZoomMode foxit::rdk::PDFViewCtrl::GetPageZoomMode | ( | ) |
Get the page zoom mode.
Windows::Storage::StorageFile ^ foxit::rdk::PDFViewCtrl::GetStorageFile | ( | ) |
Get the storage file associates with current opened PDF document.
Windows::Foundation::Collections::IVector<int> ^ foxit::rdk::PDFViewCtrl::GetVisiblePages | ( | ) |
Get the visible pages.
void foxit::rdk::PDFViewCtrl::GotoBookmark | ( | foxit::pdf::Bookmark^ | bookmark | ) |
Go to a destination which associate with the bookmark.
[in] | bookmark | The pdf bookmark object. |
bool foxit::rdk::PDFViewCtrl::GotoFirstPage | ( | ) |
Go to the first page.
bool foxit::rdk::PDFViewCtrl::GotoLastPage | ( | ) |
Go to the last page.
bool foxit::rdk::PDFViewCtrl::GotoNextPage | ( | ) |
Go to the next page.
void foxit::rdk::PDFViewCtrl::GotoPage | ( | int | iPageIndex | ) |
Go to a specified page.
[in] | iPageIndex | The page index, which starts from 0 for the first page. |
void foxit::rdk::PDFViewCtrl::GotoPagePoint | ( | int | iPageIndex, |
Windows::Foundation::Point | pt | ||
) |
Go to a specified point on the specified page.
[in] | iPageIndex | The page index, which starts from 0 for the first page. |
[in] | pt | The point on page,in PDF page coordinate. |
bool foxit::rdk::PDFViewCtrl::GotoPreviousPage | ( | ) |
Go to the previous page.
bool foxit::rdk::PDFViewCtrl::IsModified | ( | ) |
Is the document is modified.
void foxit::rdk::PDFViewCtrl::OffsetView | ( | double | vOffset, |
double | hOffset | ||
) |
Offset the current page view by the specified horizontal and vertical distance.
[in] | vOffset | The vertical offset, is ignored when layout mode is LayoutMode::SingleMode. |
[in] | hOffset | The horizontal offset, is ignored when layout mode is LayoutMode::ContinueMode. |
Windows::Foundation::IAsyncOperation<foxit::common::ErrorCode> ^ foxit::rdk::PDFViewCtrl::OpenDocAsync | ( | Windows::Storage::StorageFile^ | file, |
Platform::String^ | password | ||
) |
Open pdf doc with async.
[in] | file | The storage file which represents a PDF file. |
[in] | password | The PDF file password, could be null if there is no password required. |
Platform::Exception | For more information about exception values, please refer to FSErrorCode::e_errXXX. |
Windows::Foundation::IAsyncOperation<foxit::common::ErrorCode> ^ foxit::rdk::PDFViewCtrl::OpenDocAsync | ( | Platform::String^ | filePath, |
Platform::String^ | password | ||
) |
Open pdf doc with async.
[in] | filePath | The file path which represents a PDF file. |
[in] | password | The PDF file password, could be null if there is no password required. |
Platform::Exception | For more information about exception values, please refer to FSErrorCode::e_errXXX. |
Windows::Foundation::IAsyncAction ^ foxit::rdk::PDFViewCtrl::SaveDoc | ( | ) |
Save the current document to local file, only works when the document is opened from local, and file write access is granted.
void foxit::rdk::PDFViewCtrl::SetDoc | ( | foxit::pdf::PDFDoc^ | doc | ) |
Open the specified document, so that the document will be the current document.
[in] | doc | The pdf document object. |
void foxit::rdk::PDFViewCtrl::SetModified | ( | bool | isModified | ) |
Set the current document modification flag.
[in] | isModified | The modification flag. |
void foxit::rdk::PDFViewCtrl::SetPageLayoutMode | ( | foxit::rdk::LayoutMode | mode | ) |
Set the page layout mode.
[in] | mode | The page layout mode. |
void foxit::rdk::PDFViewCtrl::SetPageZoomMode | ( | foxit::rdk::ZoomMode | pageMode | ) |
Set the page zoom mode.
[in] | pageMode | The page zoom mode. |
void foxit::rdk::PDFViewCtrl::ZoomTo | ( | Windows::Foundation::Point | centerPt, |
double | scale, | ||
bool | isInertial, | ||
bool | isManipulationComplete | ||
) |
Zoom the current page view by a specified scale, and centered on the specified device point.
[in] | centerPt | The center point that will zoom to, in device coordinate system. |
[in] | scale | The page scale. |
[in] | isInertial | If it will inertially scroll to the specified position. |
[in] | isManipulationComplete | If manipulation is completed. |