Dokumentation Print-Klassen

cntPrintPreview ist ein Container, welcher die eigentliche Druckvorschau, einen Seitenumschalter sowie je eine Auswahlbox für den Report und für die Größe der Ansicht enthält.

Weiterhin beinhaltet der Container Buttons zum Drucken und Anpassen des Reports.

Um den Container cntPrintPreview einem Fenster hinzuzufügen, ziehen Sie diesen, wie andere Controls, einfach auf das Fenster.

Properties

Active

Boolean – Schaltet die globale Erfassung der Tastatureingaben für die Preview ein bzw. aus.

Weisen Sie dieser Eigenschaft den Wert „True“ zu, wenn der Container im Fenster sichtbar wird. Dadurch werden die nachfolgenden Tastaturbefehle generell vom cntPrintPreview verarbeitet:

Key	Aktion
Pos 1	wechselt zur ersten Seite des Reports
Ende	wechselt zur letzten Seite des Reports
Pfeil hoch	wechselt zur nächsten Seite
Pfeil runter	wechselt zur vorherigen Seite
Pfeil links	wechselt zur ersten Seite des Reports
Pfeil rechts	wechselt zur letzten Seite des Reports
Bild hoch	wechselt zur nächsten Seite
Bild runter	wechselt zur vorherigen Seite
Enter	ruft den Event onReportModify auf
Esc	unterbricht die Erstellung des Report

CurrentPage

Integer – liefert die Seitennummer der aktuell dargestellten Seite

Boolean – Setzen Sie diese Eigenschaft auf „True“, sobald sich die Daten für den aktuellen Report geändert haben. Wird jetzt die Methode Report_Refresh aufgerufen, löst sie den Event
onReportBuild aus.

Nachdem der Report neu eingelesen wurde, wird der Wert der Eigenschaft wieder auf „False“ gesetzt.

showDebugInfo

Boolean – Nutzen Sie diese Eigenschaft, um das Anzeigen der Debug-Informationen ein- bzw. auszuschalten. Defaultwert ist „True“.

Hat showDebugInfo den Wert „True“, werden bei folgenden Label Informationen als Helptag angezeigt:

LabelText	Information
Was:	benötigte Zeit zum Erstellen des Report
Ansicht:	benötigte Zeit zum Anzeigen der aktuellen Seite

Events

OnChoiceLoad

Parameter:

Rückgabewert:

Der Event wird durch den Aufruf der Methode Choice_Load ausgelöst. Füllen Sie im Event die Auswahlbox mit den Reports, die zur Verfügung stehen.

Beispiel:

me.Choice_Append(constPrint_lstFirstItem_PleaseSelect,"-")

me.Choice_AppendSeparator

me.Choice_Append("Tabellen","GridReport")

me.Choice_Append("erster Report","FirstReport")

me.Choice_Append("zweiter Report","SecondReport")

me.Choice_Append("dritter Report","ThirdReport")

OnReportBuild

Parameter:

psReportName As string

Rückgabewert:

CRSRReport

OnReportBuild wird ausgelöst, wenn der Benutzer einen Report aus der Auswahlbox „Was:“ wählt, bzw. durch den Aufruf der Methode Report_Refresh.

Er liefert als Parameter den Namen des Reports, der in der Auswahlbox „Was:“ ausgewählt ist.

Als Rückgabewert erwartet der Event ein Objekt vom Typ CRSRReport.

Nachdem Sie einen Report zurückgeliefert haben, wird die Methode Build des Reports aufgerufen und der Report erstellt. Hier besteht die Möglichkeit, die Erstellung des Reports abzubrechen: Entweder programmgesteuert durch Sie oder über den Button „Abbrechen“, durch den Benutzer. Ist die Erstellung beendet oder wurde abgebrochen, wird der Event OnReportFinish ausgelöst.

Beispiel:

Über eine Select Case Anweisung wird der ausgewählte Report zurückgeliefert.

select Case psReportName

case "FirstReport"

return createFirstReport(me)

case "SecondReport"

return createSecondReport(me)

case "ThirdReport"

return CreateThirdReport(me)

case "GridReport"

return CreateGridReport(me)

end select

Die Methoden „create…“ sind in diesem Fall Hilfsmethoden, die den Report liefern.

OnReportFinish

Parameter:

Rückgabewert:

Der Event wird ausgelöst, nachdem eine Reporterstellung beendet wurde. Hier haben Sie die Möglichkeit, Controls, die eventuell im Event OnReportBuild ausgeschaltet/deaktiviert wurden, wieder einzuschalten/zu aktivieren.

OnReportModify

Parameter:

Rückgabewert:

OnReportModify wird durch den Benutzer ausgelöst, indem er auf den Button „Anpassen…“ klickt. Des Weiteren wird der Event durch einen Doppelklick auf die Seitenvorschau oder die Auswahl des Menüpunktes „Anpassen…“ im Kontextmenü der Seitenvorschau ausgelöst.

Methoden

Choice_Append

Parameter:

psReportTitle As String

psReportName As String

Rückgabewert:

Fügt an das Ende der Auswahlbox „Was:” einen Reporteintrag hinzu. Der Parameter psReportTitel ist der Titel, der in der Auswahlbox angezeigt wird. psReportName ist der Name des Reports, welcher bei Auswahl eines Eintrages in der Auswahlbox an den Event OnReportBuild übergeben wird.

Choice_AppendSeparator

Parameter:

Rückgabewert:

Fügt an das Ende der Auswahlbox „Was:“ einen Separator hinzu.

Choice_ClearReports

Parameter:

Rückgabewert:

Methode zum Leeren der Auswahlbox „Was:“. Nach dem Aufruf dieser Methode werden alle eingetragenen Reporte aus der Auswahlbox gelöscht.

Choice_Count

Parameter:

Rückgabewert:

Integer

Funktion, welche die aktuelle Anzahl von Einträgen in der Auswahlbox „Was:“ liefert.

Choice_DeleteReport

Parameter:

psReportName As String

Rückgabewert:

Methode, welche den über den Parameter psReportName angegebenen Report aus der Auswahlbox „Was:“ löscht.

Beispiel:

Durch den nachfolgenden Aufruf wird der Eintrag „Tabellen“ aus der Auswahlbox „Was:“ gelöscht.

cntPrintPreview.Choice_DeleteReport "GridReport"

Choice_Load

Parameter:

Rückgabewert:

Nach dem Aufruf der Methode Choice_Load wird der Event OnChoiceLoad ausgelöst. Sie können die Auswahlbox „Was:“ füllen und einzelne oder alle Einträge löschen.

Choice_PosOfName

Parameter:

psReportName As String

Rückgabewert:

Integer

Diese Funktion liefert als Ergebnis den Index des über den Parameter psReportName angegebenen Reports. Wird der Report nicht gefunden, liefert die Funktion den Wert -1 zurück.

Choice_Sel

Parameter:

psReportName As String

pbBuildReport As Boolean = true

Rückgabewert:

Über diese Methode können Sie einen Report in der Auswahlbox „Was:“ auswählen. Der Parameter psReportName gibt an, welcher Report ausgewählt werden soll. Über den Parameter pbBuildReport beeinflussen Sie die Erstellung des Reports.

Beispiel:

Durch den nachfolgenden Aufruf wird der Eintrag „Tabellen“ in der Auswahlbox „Was:“ ausgewählt und der Report erstellt:

cntPrintPreview.Choice_Sel "GridReport"

Wollen Sie nur den Eintrag auswählen ohne dass der Report erstellt wird, muss der Aufruf wie folgt aussehen:

cntPrintPreview.Choice_Sel "GridReport",False

GoTo_FirstPage

Parameter:

Rückgabewert:

Nach dem Aufruf dieser Methode wechselt die Seitenansicht zur ersten Seite im Report.

GoTo_LastPage

Parameter:

Rückgabewert:

Möchten Sie zur letzten Seite des Reports wechseln, rufen Sie diese Methode auf.

GoTo_NextPage

Parameter:

Rückgabewert:

Methode, welche die Seitenansicht zur nächsten Seite im Report wechselt.

GoTo_Page

Parameter:

piNewPage As Integer

Rückgabewert:

Benutzen Sie diese Methode, um zu einer bestimmten Seite im Report zu wechseln. Über den Parameter piNewPage geben Sie die Seite an, zu der Sie wechseln möchten. Sollte der angegebene Wert kleiner sein als die erste Seite im Report wird zur ersten Seite gewechselt. Ist der Wert größer als die max. Seitenzahl, wird zur letzten Seite gewechselt.

GoTo_PreviousPage

Parameter:

Rückgabewert:

Methode, welche die Seitenansicht zur vorherigen Seite im Report wechselt.

Print_AllPages

Parameter:

pbShowPrinterdialog As Boolean = true

Rückgabewert:

Nach dem Aufruf dieser Methode werden alle Seiten des gerade angezeigten Reports gedruckt. Über den Parameter pbShowPrinterdialog können Sie steuern, ob der Dialog „Drucken“ zur Auswahl eines Druckers angezeigt werden soll. Standardmäßig wird der Dialog angezeigt.

Print_CurrentPage

Parameter:

pbShowPrinterdialog As Boolean = true

Rückgabewert:

Zum Drucken der aktuellen Seite des gerade angezeigten Reports, wählen Sie diese Methode. Über den Parameter pbShowPrinterdialog können Sie steuern, ob der Dialog „Drucken“ zur Auswahl eines Druckers angezeigt werden soll. Standardmäßig wird der Dialog angezeigt.

Print_Page

Parameter:

piPage As Integer

pbShowPrinterdialog As Boolean = True

Rückgabewert:

Methode, die eine bestimmte Seite des Reports ausdruckt. Die zu druckende Seite wird über den Parameter piPage angegeben. Ist der übergebene Wert außerhalb der Seitenzahl des Reports, wird der Druckvorgang nicht ausgeführt.

Über den Parameter pbShowPrinterdialog können Sie steuern, ob der Dialog „Drucken“ zur Auswahl eines Druckers angezeigt werden soll. Standardmäßig wird der Dialog angezeigt.

Report

Parameter:

Rückgabewert:

CRSRReport

Möchten Sie direkt auf den aktuellen Report zugreifen, benutzen Sie diese Funktion. Sie liefert den aktuell angezeigten Report zurück.

Report_Cancel

Parameter:

Rückgabewert:

Zum Unterbrechen der Erstellung eines Reports rufen Sie diese Methode auf. Daraufhin wird die Erstellung des Reports abgebrochen und die bis dahin erstellten Seiten werden angezeigt.

Report_Modify

Parameter:

Rückgabewert:

Rufen Sie diese Methode auf, wenn Sie den Event OnReportModify auslösen wollen.

Report_Name

Parameter:

Rückgabewert:

String

Diese Funktion liefert den Namen des aktuell ausgewählten Reports. Ist zum Beispiel in der Auswahlbox „Was:“ der Eintrag „Tabellen“ ausgewählt, wird der Wert „GridReport“ als Ergebnis zurück geliefert.

Report_Refresh

Parameter:

pbForce As Boolean = False

Rückgabewert:

Benutzen Sie diese Methode, um den aktuell angezeigten Report neu zu laden. Dabei wird beachtet, ob sich die Daten des Reports geändert haben, was durch die Eigenschaft Report_RefreshNeeded referenziert wird. Hat diese Eigenschaft den Wert „True“, wird der Event onReportBuild ausgelöst und der Report neu geladen.

Über den Parameter pbForce können Sie festlegen, ob die Eigenschaft Report_RefreshNeeded beachtet werden soll. Hat der Parameter pbForce den Wert „False“, wird die Eigenschaft Report_RefreshNeeded beachtet. Ist der Wert „True“, wird der Event onReportBuild unabhängig von Report_RefreshNeeded ausgelöst.

Report_Title

Parameter:

Rückgabewert:

String

Diese Funktion liefert den Titel des aktuell ausgewählten Reports. Ist zum Beispiel in der Auswahlbox „Was:“ der Eintrag „Tabellen“ ausgewählt wird der Wert „Tabellen“ als Ergebnis zurück geliefert.

Zoom_Preview

Parameter:

psZoomMenuName As String

pbSet_lstZoomIndex As Boolean = true

Rückgabewert:

Benutzen Sie diese Methode, um die Ansicht der Preview zu vergrößern/verkleinern. Über den Parameter psZoomMenuName geben sie den Zoomwert an. Folgende Werte sind möglich:

Wert	Größe des Zooms
constRSReportString_Menu_Zoom_75	75% der Originalgröße
constRSReportString_Menu_Zoom_100	100% der Originalgröße
constRSReportString_Menu_Zoom_FullPage	passt die Ansicht so an, dass die ganze Seite angezeigt wird
constRSReportString_Menu_Zoom_PageWidth	passt die Ansicht so an, dass die Seite in ganzer Breite angezeigt wird

Über den Parameter pbSet_lstZoomIndex können Sie steuern, ob in der Auswahlbox „Ansicht“ der von Ihnen gewählte Zoomwert ausgewählt werden soll.

CRSRPageSwitch

Die Klasse CRSRPageSwitch ist von einem Canvas abgeleitet. In ihr werden drei Bereiche gezeichnet. Zwei Buttons zum Hoch- und Runterschalten und eine Seitenanzeige mit der aktuellen Seite und der Anzahl der Seiten.

Klickt man im Bereich der Seitenanzeige mit der rechten Maustaste wird ein Kontextmenü mit allen Seiten angezeigt.

Zusätzlich besteht die Möglichkeit, einen dritten Button im Bereich der Seitenanzeige darzustellen. Wird dieser angezeigt, öffnet sich mit einem Klick das Kontextmenü; nur dann, wenn darauf geklickt wird.

Properties

ShowPageSelectButton

Boolean – Gibt an, ob in der Seitenanzeige ein weiterer Button angezeigt wird.

Hat diese Eigenschaft den Wert „True“, wird im Bereich der Seitenanzeige ein weiterer Button angezeigt. Das Kontextmenü zur Seitenauswahl wird nur durch einen Klick auf diesen Button angezeigt. Ist der Wert „False“(Default), wird kein Button angezeigt und das Kontextmenü wird beim Klick in dem Bereich der Seitenanzeige eingeblendet.

ShowPopUp_LeftButtonClick

Boolean – gibt an, ob das Kontextmenü mit allen Seiten auch bei einem Klick mit der linken Maustaste angezeigt wird.

Weisen Sie der Eigenschaft den Wert „True“ zu, um das Kontextmenü mit allen Seiten auch bei einem Klick auf die linke Maustaste anzuzeigen.

Hat die Eigenschaft den Wert „False“(Default), wird das Kontextmenü nur bei einem Klick mit der rechten Maustaste angezeigt.

Events

ItemChanged

Parameter:

piIndex As Integer

Rückgabewert:

Dieser Event wird nach einem Klick des Benutzers auf die Buttons oder durch die Auswahl eines Eintrages im Kontextmenü ausgelöst. Er erhält als Parameter den Index der Seite.

Methoden

Count

Parameter:

Rückgabewert:

Integer

Liefert als Ergebnis die Anzahl der Seiten

Count

Parameter:

piCount As Integer

Rückgabewert:

Setzt die Anzahl der Seiten. Der Parameter piCount enthält die neue Anzahl an Seiten.

Index

Parameter:

Rückgabewert:

Integer

Liefert als Ergebnis den Index der aktuellen Seite.

Index

Parameter:

piIndex As Integer

Rückgabewert:

Setzt den Index der aktuellen Seite. piIndex ist der neue Wert des Index.

Nach dem Aufruf dieser Methode wird die Anzeige der Seitenzahl aktualisiert.

CRSRDoubleClickCanvas

Die Klasse CRSRDoubleClickCanvas ist von einem Canvas abgeleitet.

Sie enthält zusätzlich zu den Events eines Canvas den Event DoubleClick.

Events

DoubleClick

Parameter:

Rückgabewert:

Dieser Event wird ausgelöst wenn der Benutzer auf den Canvas mit der linken Maustaste doppelt geklickt hat – innerhalb der im System hinterlegten Zeit für einen Doppelklick.

CRSRThread

Die Klasse CRSRThread ist von der Klasse Thread abgeleitet. Sie wird von der Klasse cntPrintPreview für die Erstellung eines Reports verwendet.

Properties

eoReport

CRSRReport – Enthält ein abgeleitetes Objekt vom Typ CRSRReport, dessen Methode Build im Event Run aufgerufen wird.

Events

Run

Parameter:

Rückgabewert:

Dieser Event wird zum Starten des Thread aufgerufen. Er ruft wiederum die Methode Build der Eigenschaft eoReport und liefert nach Abschluss des Buildvorgangs (ohne Abbruch der Erstellung) über den MessageReceiver den Report an die Klasse cntPrintPreview zurück.

Methoden

Constructor

Parameter:

poReceiver As CRSRMessageReceiver

Rückgabewert:

Der Constructor erzeugt ein neues Objekt und erwartet als Parameter ein Objekt, welches als Interface den Typ CRSRMessageReceiver zur Rückgabe von Objekten und Nachrichten enthält. Hier wird es immer der Container cntPrintPreview sein.

Terminate

Parameter:

Rückgabewert:

Rufen Sie diese Methode auf, um den Buildvorgang zu unterbrechen. Diese Methode beendet den Thread und liefert über den MessageReceiver den Report zurück.

CRSRReport

Die Klasse CRSRReport ist die Hauptklasse für einen Report. Sie kann unabhängig vom Container cntPrintpreview erzeugt werden. Ihr können Seiten hinzugefügt werden, die Seitenausrichtung und die Seitenränder können geändert werden. Weiterhin enthält sie Methoden zum Drucken von einzelnen Seiten oder des gesamten Reports.

Dokumentation Print-Klassen

CRSRCheckbox CRSRImage CRSRLine CRSROval CRSRText CRSRRectangle CRSRGroup CRSRGroup CRSRThread CRSRDoubleClickCanvas CRSRPageSwitch CRSRReport cntPrintPreview CRSRPrintElement CRSRPage Window Klassenübersicht

CRSRCheckbox

CRSRImage

CRSRLine

CRSROval

CRSRText

CRSRRectangle

CRSRGroup

CRSRGroup

CRSRThread

CRSRDoubleClickCanvas

CRSRPageSwitch

CRSRReport

cntPrintPreview

CRSRPrintElement

CRSRPage

Window

Klassenübersicht