OnExportPages-Methode der IDocumentViewerEvents-Schnittstelle

Diese Methode wird clientseitig implementiert. Sie wird von ABBYY FineReader Engine vor dem Start des Exportvorgangs aufgerufen, der im Document Viewer ausgelöst wurde. Der Vorgang wird gestartet, wenn einer der folgenden Befehle aufgerufen wird:

Die Befehle können über die entsprechenden Einträge im Kontextmenü oder mithilfe der Methode DoCommand von IDocumentViewer::Commands aufgerufen werden. Weitere Informationen finden Sie in der Liste Document Viewer Commands. Die Methode übermittelt dem Client Informationen zum Exportvorgang: Exportdateiname und -format, Exportparameter sowie die Indizes der Seiten, die exportiert werden sollen. Mithilfe dieser Methode kann der Vorgang abgebrochen werden.

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
)

Parameter

FileName [in] Enthält den Namen der Datei, in der die Seiten gespeichert werden. Format [in] Gibt das Exportformat an. Siehe die Beschreibung der Konstanten in FileExportFormatEnum. PageIndices [in] Gibt die Indizes der Seiten in einem Dokument an, die als IntsCollection-Objekt exportiert werden sollen. ExportParams [in] Verweist auf das Exportparameterobjekt des Typs, der dem Exportdateiformat entspricht. Wenn Seiten beispielsweise in einer RTF-Datei gespeichert werden, verweist es auf das RTFExportParams-Objekt. Cancel [out] Sie können diese Variable auf TRUE setzen, um anzugeben, dass der Vorgang abgebrochen werden soll. In diesem Fall werden die Seiten nicht exportiert.

Rückgabewerte

[Nur C++] Wenn diese Methode einen anderen Wert als S_OK zurückgibt, weist dies darauf hin, dass auf der Clientseite ein Fehler aufgetreten ist; in diesem Fall wird der Wert des Parameters Cancel nicht berücksichtigt.

Hinweise

Die Client-Implementierung dieser Methode muss sicherstellen, dass alle innerhalb der Methode ausgelösten Ausnahmen abgefangen und behandelt werden und dass keine Ausnahmen über die Methode hinaus weitergegeben werden. Wird eine Ausnahme über die Methode hinaus weitergegeben, kann dies zu unvorhersehbaren Ergebnissen führen (z. B. zum Programmabbruch).