OnExportPages Method of the IDocumentViewerEvents Interface

OnExportPages method of the IDocumentViewerEvents Interface in ABBYY FineReader Engine Visual Components on Windows — This method is implemented on the client-side.

This method is implemented on the client-side. It is called by ABBYY FineReader Engine before the start of the export process which has been invoked from Document Viewer. The process is invoked if one of the following commands is called:

• MI_SaveAsCsv
• MI_SaveAsDocX
• MI_SaveAsEpub
• MI_SaveAsFb2
• MI_SaveAsHtm
• MI_SaveAsOdt
• MI_SaveAsPdf
• MI_SaveAsPdfA
• MI_SaveAsPptX
• MI_SaveAsRtf
• MI_SaveAsTxt
• MI_SaveAsXls
• MI_SaveAsXlsX

The commands can be called using the corresponding items in the context menu, or using the DoCommand method of the IDocumentViewer::Commands. See the Document Viewer Commands list for details.

The method delivers to the client information on the export operation: export file name and format, parameters of export, and the indices of pages that are going to be exported. With the help of this method it is possible to cancel the operation.

Syntax

C++

HRESULT OnExportPages(
  BSTR                 FileName,
  FileExportFormatEnum Format,
  IIntsCollection*     PageIndices,
  IUnknown*            ExportParams,
  VARIANT_BOOL*        Cancel
);

C#

void OnExportPages(
  string               FileName,
  FileExportFormatEnum Format,
  IIntsCollection      PageIndices,
  object               ExportParams,
  out bool             Cancel
);

Visual Basic .NET

Sub OnActivePageChanging( _
  FileName As String, _
  Format As FileExportFormatEnum, _
  PageIndices As IIntsCollection, _
  ExportParams As Object, _
  ByRef Cancel As Boolean
)

Parameters

FileName

[in] Contains the name of the file to save pages to.

Format

[in] Specifies the format of export. See the description of the FileExportFormatEnum constants.

PageIndices

[in] Specifies the indices of pages in a document which should be exported as an IntsCollection object.

ExportParams

[in] Refers to the export parameters object of the type corresponding to the export file format. For example, if pages are saved into an RTF file, it refers to the RTFExportParams object.

Cancel

[out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the pages will not be exported.

Return values

[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client-side, and in this case the value of the Cancel parameter is not taken into account.

Remarks

The client implementation of this method must assure that all exceptions thrown inside the method are caught and handled and no exceptions are propagated outside the method. Propagation of an exception outside the method may lead to unpredictable results (such as program termination).

See also

IDocumentViewerEvents