Breadcrumbs

STImgCtl – Darstellung von Dokument und Ansichtsbereich

Methode ShowToolbar

Mit dieser Methode kann die Sichtbarkeit der im Steuerelement enthaltenen Werkzeugleiste gesteuert werden.

Entsprechend des Dokumententyps und der Konfiguration durch andere Methoden sind manche Buttons gegebenenfalls gesperrt.

Für Informationen zum Button, der den Formularfeldmodus aktiviert und deaktiviert, siehe den Abschnitt zum Formularfeldmodus.

C#
void ShowToolbar(int nShow);
C++
void ShowToolbar(int nShow);

Parameter


In

Out

Mögliche

Werte

Beschreibung

nShow

✔️


0

Werkzeugleiste ausblenden

1

Werkzeugleiste einblenden

Methode ZoomIn

Mit dieser Methode wird in das angezeigte Dokument hereingezoomt. Der Zoomfaktor bleibt bei einem Dokumentenwechsel erhalten.

C#
sbyte ZoomIn();
C++
char ZoomIn();

Rückgabewert

Bedeutung

0

Hereinzoomen war nicht erfolgreich

1

Hereinzoomen war erfolgreich

Methode CanZoomIn

Mit dieser Methode kann abgefragt werden, ob ein Hereinzoomen durch ZoomIn() möglich ist.

C#
sbyte CanZoomIn();
C++
char CanZoomIn();

Rückgabewert

Bedeutung

0

Hereinzoomen ist nicht möglich

1

Hereinzoomen ist möglich

Methode ZoomOut

Mit dieser Methode wird aus dem angezeigten Dokument herausgezoomt. Der Zoomfaktor bleibt bei einem Dokumentenwechsel erhalten.

C#
sbyte ZoomOut();
C++
char ZoomOut();

Rückgabewert

Bedeutung

0

Herauszoomen war nicht erfolgreich

1

Herauszoomen war erfolgreich

Methode CanZoomOut

Mit dieser Methode wird aus dem angezeigten Dokument herausgezoomt. Der Zoomfaktor bleibt bei einem Dokumentenwechsel erhalten.

C#
sbyte CanZoomOut();
C++
char CanZoomOut();

Rückgabewert

Bedeutung

0

Herauszoomen ist nicht möglich

1

Herauszoomen ist möglich

Methode FitTo

Diese Methode ermöglicht die Einpassung des Dokuments in das Anzeigefenster.

Die Einpassung wird über eine Anpassung des Zoomfaktors umgesetzt. Dieser bleibt bei einem Dokumentenwechsel erhalten, ein Dokument mit anderen Maßen wird entsprechend gezoomt, ohne automatisch eingepasst zu werden.

C#
void FitTo(short nFormat);
C++
void FitTo(short nFormat);

Parameter


In

Out

Mögliche

Werte

Beschreibung

nFormat

✔️


0

Das Anzeigefenster wird auf die Breite des aktuellen Dokumentes gesetzt

1

Das Anzeigefenster wird auf die Höhe des aktuellen Dokumentes gesetzt

2

Seitenscrollmodus; das Dokument wird in der Höhe eingepasst. Bei mehrseitigen PDF-Dokumenten erlaubt ein Scrollbalken das Blättern

Methode GetPageDimensions

Diese Methode gibt die Größe einer Seite des geladenen Dokuments zurück. Die Werte sind auf drei Nachkommastellen gerundet. Ist einer der beiden Outputparameter ein Nullpointer, wird nur der andere belegt.

C#
int GetPageDimensions(int nPage, float* pnWidth, float* pnHeight, int nOptions);
C++
long GetPageDimensions(long nPage, float* pnWidth, float* pnHeight, long nOptions);

Parameter


In

Out

Mögliche

Werte

Beschreibung

nPage

✔️


>0

Seite, deren Größe ausgegeben werden soll

-1

Es wird die Größe der aktuell geladenen Seite zurückgegeben.

pnWidth


✔️

>0

Breite der Seite

pnHeight


✔️

>0

Höhe der Seite

nOptions

✔️

0 - 2

Einheit, in der Breite und Höhe ausgegeben werden sollen


0

Points (PDF) / Pixel (Bild)

1

Millimeter (nur gültig für PDF)

2

Inch (nur gültig für PDF)

Rückgabewert

Bedeutung

0

Methode erfolgreich ausgeführt

<0

Ein Fehler ist aufgetreten


-1

kein Dokument geladen


-2

ungültiger Input


-3

ungültige Option

Eigenschaft BorderStyle

Über diese Eigenschaft kann der Stil des Fensterrahmens des Steuerelementes gesetzt und gelesen werden.

C#
short BorderStyle;
C++
short BorderStyle;

In

Out

Mögliche

Werte

Beschreibung

✔️

✔️

0

Rahmen mit einfacher Linie

1

Dreidimensionaler Rahmen (Standard)

Eigenschaft PageCount

Über diese Eigenschaft kann die Gesamtzahl der Seiten abgefragt werden.

C#
int PageCount;
C++
long PageCount;

In

Out

Mögliche

Werte

Beschreibung


✔️

>=1

Anzahl der Seiten des Dokuments

0

kein Dokument geladen

Eigenschaft Page

Über diese Eigenschaft kann die anzuzeigende Seite gesetzt oder ihre Nummer abgefragt werden. Ist eine übergebene Seitenzahl nicht verfügbar, wird der Aufruf ignoriert.

C#
int Page;
C++
long Page;

In

Out

Mögliche

Werte

Beschreibung

✔️

✔️

>=1

<= PageCount

Aktuelle bzw. zu setzende Seite

0

kein Dokument geladen

Event UpdatePage

Dieses Event signalisiert, dass ein Seitenwechsel stattgefunden hat oder die aktuelle Seitenansicht erneuert wurde. Es wird ausgelöst, sobald sich die angezeigte Seite ändert, und gibt die neue Seitenzahl aus.

Im folgenden wird eine Beispiel-Implementation gezeigt, in der benutzerdefinierte Namen durch Platzhalter (%…%) ersetzt wurden.

C#
public class _DSTImgCtlEvents_UpdatePageEvent
{
    public short nPage;

    public _DSTImgCtlEvents_UpdatePageEvent(short nPage)
    {
        this.nPage = nPage;
    }
}

this.%COMPONENT_NAME%.UpdatePage += new AxSTIMGCTLLib._DSTImgCtlEvents_UpdatePageEventHandler(this.%CALLBACK_FUNCTION%);

private void %CALLBACK_FUNCTION%(object sender, AxSTIMGCTLLib._DSTImgCtlEvents_UpdatePageEvent e);
C++
BEGIN_EVENTSINK_MAP(%CLASS_NAME%, CDialogEx)
	ON_EVENT(%CLASS_NAME%, %COMPONENT_ID%, 2, %CALLBACK_FUNCTION%, VTS_I2)
END_EVENTSINK_MAP()
void %CALLBACK_FUNCTION%(short nPage);

Parameter

Mögliche Werte

Beschreibung

nPage

>=1

Nummer der aktuell angezeigten Seite