WinDocSaveName

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

Text aus CtxDocEdit-Objekt speichern

Details

• obj: Objekt ( CtxDocEdit -Objekt)
• int1:
  • Ziel des Textes:
  • _WinStreamNameText
  • _WinStreamNameFile
• int2:
  • Modus für interne und externe Texte zusätzlicher Modus für externe Texte:
  • _WinDocSaveAscii
  • _WinDocSaveRtf
  • _WinDocSaveHtml
  • _WinDocSaveOEM
  • _WinDocSaveMix
  • _WinDocSaveMark
• alpha3: Zielname
• Resultat: int Fehlerwert
• Siehe: Verwandte Befehle , WinDocSaveBin () , WinDocLoadName ()

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

In (int1) wird das Ziel des Textes definiert. Der Name des Ziels wird in (alpha3) angegeben.

Folgende Ziele können angegeben werden:

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

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

Modus für interne und externe Texte

• _WinDocSaveAscii ASCII-Text sichern
• _WinDocSaveRtf RTF-Text sichern
• _WinDocSaveHtml HTML-Format sichern
• _WinDocSaveOEM OEM-Text sichern
• _WinDocSaveMix Text mit Daten mischen
• _WinDocSaveMark Markierten Bereich sichern

zusätzlicher Modus für externe Texte

• _WinDocSaveDoc Inhalt im .doc Format sichern
• _WinDocSaveDocX Inhalt im .docx Format sichern
• _WinDocSavePdf Inhalt im PDF-Format sichern
• _WinDocSaveAuto Textformat anhand der Dateiendung automatisch erkennen

Die Parameter zum Zielformat können mit _WinDocSaveMark kombiniert werden, um einen markierten Teil innerhalb des Textes zu sichern.

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

info

_WinDocSaveMix kann nicht zusammen mit _WinDocSaveDoc , _WinDocSaveDocX oder _WinDocSavePdf 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 SaveToMemory 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:

// Dokument extern als PDF speichern
$ctxDocEdit->WinDocSaveName(_WinStreamNameFile, _WinDocSavePdf, _Sys->spPathMyDocuments + '\Updatebeschreibung.pdf');

// markierten Bereich als internes RTF-Dokument speichern
$ctxDocEdit->WinDocSaveName(_WinStreamNameText, _WinDocSaveRtf | _WinDocSaveMark, '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.