WinDocLoadName

obj -> WinDocLoadName(int1, int2[, alpha3]) : int

Text in CtxDocEdit-Objekt laden

Details

• obj: Objekt (CtxDocEdit-Objekt)
• int1:
  • Quelle des Textes:
  • _WinStreamNameText
  • _WinStreamNameFile
• int2:
  • Modus für interne und externe Texte zusätzlicher Modus für externe Texte:
  • _WinDocLoadAscii
  • _WinDocLoadRtf
  • _WinDocLoadHtml
  • _WinDocLoadOEM
  • _WinDocLoadMix
  • _WinDocLoadInsert
• alpha3: Name des Textes (optional)
• Resultat: int Fehlerwert
• Siehe: Verwandte Befehle , WinDocLoadBin () , WinDocSaveName ()

Mit diesem Befehl wird ein Text in ein CtxDocEdit -Objekt geladen. Der Deskriptor des Objektes wird in (obj) übergeben.

In (int1) wird die Quelle des zu ladenden Textes definiert. Der Name der Quelle wird in (alpha3) angegeben.

Folgende Quellen können angegeben werden:

• _WinStreamNameText Der Text steht in einem internen Text zur Verfügung. Der Name des Textes wird in (alpha3) übergeben.
• _WinStreamNameFile Der Text steht in einer externen Datei zur Verfügung. Der Name des Textes kann in (alpha3) übergeben werden. Ist er nicht angegeben, wird er der Eigenschaft FileName entnommen.

Der Parameter (int2) bestimmt das Format der Quelle. Folgende Konstanten können übergeben werden:

Modus für interne und externe Texte

• _WinDocLoadAscii Laden von Text im ASCII-Format.
• _WinDocLoadRtf Laden von Text im RTF-Format.
• _WinDocLoadHtml Laden von Text im HTML-Format.
• _WinDocLoadOEM Laden von Text im OEM-Format.
• _WinDocLoadMix Text mit Daten mischen.
• _WinDocLoadInsert Der zu ladende Text wird in einen bestehenden Text eingefügt.

zusätzlicher Modus für externe Texte

• _WinDocLoadDoc Word-Dateien im .doc Format laden.
• _WinDocLoadDocX Word-Dateien im .docx Format laden.
• _WinDocLoadAuto Textformat anhand der Dateiendung automatisch erkennen.

Die Parameter zum Quellenformat können mit _WinDocLoadInsert kombiniert werden, um in einen bestehenden Text den angegebenen Text einzufügen.

Der Text ersetzt den Text, der mit der Markierung ($ctxDocEdit->cpiSelLength) selektiert ist. Ist keine Markierung vorhanden, wird der Text an der aktuellen Cursorposition $ctxDocEdit->cpiSelStart eingefügt.

Bei der Kombination mit der Option _WinDocLoadMix werden beim Laden des Textes die Platzhalter durch die entsprechenden Daten ersetzt. Weitere Informationen befinden sich im Abschnitt Text und Daten mischen .

info

_WinDocLoadMix kann nicht zusammen mit _WinDocLoadDoc oder _WinDocLoadDocX angegeben werden.

Als Rückgabewert kann neben den Fehlerkonstanten aus dem Bereich der externe Dateien der Wert _ErrGeneric zurückgegeben werden, wenn ein interner Fehler aufgetreten ist. Bei der Rückgabe von _ErrOk ist kein Fehler aufgetreten.

info

Intern wird die Funktion LoadFromMemory der Text-Control-Bibliothek aufgerufen. Dabei wird die Eigenschaft LoadSaveAttribute der Bibliothek beachtet. Die Eigenschaft kann mit $ctxDocEdit->cpiLoadSaveAttribute gelesen und gesetzt werden. Nähere Informationen finden Sie auf der Hersteller-Seite des Moduls.

Beispiel:

// externes Word-Dokument laden
$ctxDocEdit->WinDocLoadName(_WinStreamNameFile, _WinDocLoadDoc, _Sys->spPathMyDocuments + '\Updatebeschreibung.doc');

// internes RTF-Dokument laden und in aktuellen Text einfügen
$ctxDocEdit->WinDocLoadName(_WinStreamNameText, _WinDocLoadRtf | _WinDocLoadInsert, 'Preise');

Mögliche Laufzeitfehler

• _ErrHdlInvalid: Bei (obj) handelt es sich nicht um ein CtxDocEdit-Objekt
• _ErrValueInvalid: Argument (int1) oder (int2) enthält ungültige Werte oder der Wert von (alpha3) ist leer und FileName ist nicht angegeben.