OnSendToPages Method of the IDocumentViewerEvents Interface

OnSendToPages 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 sending recognized pages from Document Viewer to an external application. The process is invoked if one of the following commands is called:

• MI_SendToAcrobat
• MI_SendToClipboard
• MI_SendToMSExcel
• MI_SendToMSWord
• MI_SendToOpenOffice
• MI_SendToPowerPoint
• MI_SendToWebBrowser
• MI_SendToWordPerfect
• MI_SendToWordPro

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 application, to which the pages are going to be sent, and the parameters of export. With the help of this method it is possible to cancel the operation.

Syntax

C++

HRESULT OnSendToPages(
  SendToDestinationEnum Destination,
  IUnknown*             ExportParams,
  VARIANT_BOOL*         Cancel
);

C#

void OnSendToPages(
  SendToDestinationEnum Destination,
  object                ExportParams,
  out bool              Cancel
);

Visual Basic .NET

Sub OnSendToPages(
  Destination As SendToDestinationEnum, _
  ExportParams As Object, _
  ByRef Cancel As Boolean
)

Parameters

Destination

[in] Specifies the destination application, where recognized pages are sent. See the description of the SendToDestinationEnum constants.

ExportParams

[in] Refers to the export parameters object of the type corresponding to the destination application. For example, if pages are sent to Microsoft Word, 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, pages will not be sent.

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