Breadcrumbs

STImgCtl – Verwaltung von Dokumenten

Methode LoadDocument

Mit dieser Methode kann eine Datei von einem lokalen Laufwerk oder über eine HTTP-URL aus dem Inter- oder Intranet geladen werden.

Wird ein Dokument mit LoadDocument geladen und im Formularfeldmodus verändert, so wird bei Deaktivierung des Modus das Ursprungsdokument überschreiben. Beachten Sie dazu die Hinweise im Abschnitt zum Formularfeldmodus!

Folgende Formate werden unterstützt:

  • PDF

  • TIFF

  • BMP

  • PNG

  • EMF

  • JPG


C#
int LoadDocument(string bstrFilename);
C++
long LoadDocument(BSTR bstrFilename);

Parameter

In

Out

Mögliche

Werte

Beschreibung

bstrFilename

✔️


!= NULL

Dateipfad oder HTTP-URL

Rückgabewert

Bedeutung

0

Methode erfolgreich ausgeführt

< 0

Ein Fehler ist aufgetreten


-4

Die angegebene Datei konnte nicht geöffnet werden

Methode LoadDocument2

Mit dieser Methode kann ein PDF-Dokument geladen werden, das als Byte-Array vorliegt.

C#
int LoadDocument2(object objBinaryArray);
C++
long LoadDocument2(VARIANT varBinaryArray);

Parameter

In

Out

Mögliche

Werte

Beschreibung

objBinaryArray

✔️


0

ein Bytearray

varBinaryArray

✔️


0

ein Variant mit den Eigenschaften VT_ARRAY und VT_UI1

Rückgabewert

Bedeutung

0

Methode erfolgreich ausgeführt

< 0

Ein Fehler ist aufgetreten


-2

ungültiger Input


-4

Input konnte nicht gelesen werden

Methode GetFilename

Diese Methode gibt den Dateipfad des angezeigten Dokumentes zurück.

C#
string GetFilename();
C++
BSTR GetFilename();

Rückgabewert

Bedeutung

leerer String

Ein Fehler ist aufgetreten oder es ist kein Dokument geladen

“VARIANT”

Dokument wurde mit LoadDocument2 geladen, kein Dateipfad vorhanden

Dateipfad oder URL

Pfad oder URL des geladenen Dokuments

Methode SaveDocument

Diese Methode gibt das geänderte Dokument als Byte-Array in einem VARIANT vom Typ VT_ARRAY zurück.

Das Exportieren eines PDF-Dokuments mit SaveDocument schreibt das ganze Dokument neu. Damit werden bereits enthaltene Unterschriften ungültig.

C#
object SaveDocument();
C++
VARIANT SaveDocument();

Rückgabewert

Bedeutung

Byte-Array, Größe 0

Ein Fehler ist aufgetreten

Byte-Array, Größe > 0

Aktualisierter Inhalt des Dokuments

Methode ClearDisplay

Mit dieser Methode wird das angezeigt Dokument entfernt und die Anzeige gelöscht.

C#
void ClearDisplay();
C++
void ClearDisplay();

Eigenschaft ImageDisplayed

Über diese Eigenschaft kann abgefragt werden, ob aktuell ein Dokument angezeigt wird.

C#
int ImageDisplayed;
C++
long ImageDisplayed;

In

Out

Mögliche

Werte

Beschreibung


✔️

0

Im Anzeigefenster wird kein Dokument angezeigt

1

Im Anzeigefenster wird ein Dokument angezeigt

Eigenschaft DocumentType

Über diese Eigenschaft kann der Dokumententyp abgefragt werden.

C#
short DocumentType;
C++
short DocumentType;

In

Out

Mögliche

Werte

Beschreibung


✔️

0

BMP

1

PDF

2

EMF

3

GIF

4

JPG

5

TIF

6

PNG

7

unbekannt