|
Home > Handbuch > Entwicklerhilfe > Makro-Referenz OmAPI > Formatparameter Datei und Text Formatparameter Datei und Text |
Mit dem optionalen Formatparameter können Sie Teile aus einer Variablen extrahieren: z. B. Teile eines Dateinamen, des Projektes oder einer kombinierten Datum- und Zeitvariablen.
Format-Parameter:
AsUNC: Datei im UNC-Format (z. B. "\\Server\Freigabe\Daten\Texte\Angebote\Datei.txt").
ChangeExt,ext: Dateiendung ändern (z. B. "C:\Daten\Texte\Angebote\Datei.ext").
CharToOem: Konvertiert den Text in den OEM-Zeichensatz (ASCII). Ist z. B. für ältere MegaCAD-Versionen erforderlich.
Clean: Ersetzt Zeilenumbrüche und Tabulatoren durch Leerzeichen, trimmt den Text und ersetzt mehrfache Leerzeichen durch einfache.
CleanSpaces: Entfernt mehrfache Leerzeichen sowie Leerzeichen am Zeilenanfang und -ende in mehrzeiligem Text.
CopyChar: Einzelne Zeichen der Variablen. CopyChar müssen 6 Zahlen oder '-' und 6 Zahlen folgen. Die ersten 3 Zahlen geben den Startpunkt an, die letzten 3 Zahlen die Anzahl Zeichen.
Schreiben Sie z. B. "CopyChar012003" um die Zeichen 12 bis 15 zu erhalten.
Oder "CopyChar-002002" für die beiden letzten Zeichen.
DataType: nur für Datenfelder mit Selektion Current. Der zurückgegebene Text beschreibt den Typ des Datenfeldes, z. B. "ftWideString".
DataTypeOrd: nur für Datenfelder mit Selektion Current. Ordinalwert des Datenfeldtypen (kann in verschiedenen Programmversionen unterschiedlich sein).
Date: Extrahiert den Datumsteil aus einer kombinierten Datum-, Zeitvariablen (s. a. Variable Date).
Dir: Der Dateipfad ohne Laufwerksangabe und abschließendem Backslash (z. B. "Daten\Texte\Angebote").
DirPart,n,m: Ein Teil des Dateipfades. Es werden die Verzeichnisebenen von n bis m zurückgegeben. Wenn n oder m negativ sind, erfolgt die Zählung von hinten.
Bei temporären Dateien ist die Rückgabe immer leer.
Beispiele:
- "DirPath,2,2" gibt die 2. Verzeichnisebene zurück, also "Texte" von der Datei "C:\Daten\Texte\Angebote\Datei.txt"
- "DirPart,1,2" ergibt "Daten\Texte"
- "DirPart,-1,-1" ergibt die letzte Ebene "Angebote"
- "DirPart,-1,-3" ergibt "Daten\Texte\Angebote"
- "DirPart,1,-1" ergibt alle Ebenen (von erster bis letzter), entspricht also dem Parameter Dir.
File: Der Dateiname ohne Pfad, mit Dateiendung wird zurückgegeben (z. B. "Datei.txt").
FileDir: Der Dateipfad ohne abschließendem Backslash (z. B. "C:\Daten\Texte\Angebote").
FileDrive: Die Laufwerksangabe des Dateinamen (z. B. "C:" oder "\\Server\Freigabe").
FileExt: Die Dateiendung ohne den Punkt (z. B. "txt").
FileName: Der komplette Dateiname mit Pfad und Dateiendung (z. B. "C:\Daten\Texte\Angebote\Datei.txt"). Der Parameter FileName ist die Standard-Vorgabe und braucht nicht angegeben werden. Die Rückgabe von {Doc:FileName} entspricht {Doc:FileName,FileName}
FilePath: Der Dateipfad mit abschließendem Backslash (z. B. "C:\Daten\Texte\Angebote\").
FillLeft: Füllt die Variable mit einem angegebenen Zeichen auf, bis eine vorgegebene Länge erreicht ist. FillLeft müssen 3 Zahlen und ein Zeichen folgen. Z. B.: Sie möchten die Dokument-Schlüsselnummer achtstellig mit führenden Nullen erhalten: {Doc:DocID,FillLeft0080}. "008" steht für achtstellig, die folgende "0" beschreibt das Zeichen, mit dem die Variable linksbündig gefüllt wird.
FillRight: Wie FillLeft, die Variable wird jedoch mit folgenden Zeichen aufgefüllt.
FirstChars: Gibt das erste Zeichen des Textes zurück. Bei Backslash-getrennten Texten (z. B. Attribute mit strukturierter Liste) wird das erste Zeichen jeder Ebene zurück gegeben.
Beispiel: {Format:Buchhaltung\Ausgangsrechnung,FirstChars} gibt "BA" zurück.
FirstCrspWord,Words: Gibt das zuerst vorkommende Wort aus der punktgetrennte Liste Words zurück. Dieser Parameter ist für den Import großer Dateimengen geeignet, um beispielsweise die Kategorie (Angebot, Rechnung u. a.) aus dem Dateinamen zu ermitteln.
Beispiel: {Source:FirstCrspWord,{FieldAttribute:DocDB,Category,Pickitems,.}}
Siehe auch FtiGetFirstCrspWord
IncludeTrailingBackSlash: Stellt sicher, dass der Pfadname mit einem "\" endet.
Length: Gibt die Zeichenanzahl des Textes zurück.
Line,Number: Gibt die mit Number angegebene Zeile eines mehrzeiligen Textes zurück. Negative Nummern zählen von hinten, -1 ist z.B. die letzte Zeile.
LineIE,Number: Wie Line, jedoch werden alle leeren Zeilen (auch Zeilen, die nur Leerzeichen enthalten) ignoriert.
Main: Gibt den Teil bis vor den ersten "\" zurück. {Doc:Project,Main} extrahiert z. B. das Hauptprojekt bei untergliederten Projekten.
Name: Der Dateiname ohne Pfad und ohne Dateiendung (z. B. "Datei").
NoExt: Der Dateiname mit Pfad, ohne Dateiendung (z. B. "C:\Daten\Texte\Angebote\Datei").
NoSpace: Entfernt alle Leerzeichen. Siehe auch Clean und Trim.
OemToChar: Konvertiert den OEM-Text (ASCII) in ANSI oder Unicode.
Quote: Setzt den Dateinamen bzw. Text in doppelte Anführungszeichen, wenn er Leerzeichen enthält.
QuoteEver: Setzt den Dateinamen bzw. Text immer in doppelte Anführungszeichen.
Separate,Char,Pos[,Default]: Gibt Teile des Dateinamen bzw. Textes zurück. Char gibt das Trennzeichen und Pos die Nummer des gewünschten Teils an. Als Trennzeichen ist nur ein einfaches Zeichen möglich. Der optionale Parameter Default wird als Rückgabewert verwendet, falls das Trennzeichen nicht vorhanden ist.
Tipp: für mehrere Zeichen vorher StringReplace aufrufen. Beachten Sie, dass bei Dateinamen der komplette Pfad interpretiert wird.
Siehe auch Beispiele und Formatparameter Line.
SeparateName,Char,Pos: Wie Separate, allerdings wird nur der Dateiname ohne Pfad und Endung interpretiert.
SqlEscapeGUID: Nur für Datenfeld-Variablen. Die GUID-Datenfelder haben in den unterstützten Datenbankformaten unterschiedliche Datentypen. Mit SqlEscapeGUID wird ein GUID-Feldwert für eine SQL-Abfrage formatiert, beispielsweise {doc:contactguid,sqlescapeguid}.
Time: Extrahiert den Zeitteil aus einer kombinierten Datum-, Zeitvariablen.
ToLower: Gibt den Text in Kleinbuchstaben zurück.
ToUpper: Gibt den Text in Großbuchstaben zurück.
Trim: Entfernt alle Leer- und Steuerzeichen am Anfang und Ende des Textes. Siehe auch Clean und NoSpace.
TrimLeft: Entfernt alle Leer- und Steuerzeichen am Anfang des Textes.
TrimRight: Entfernt alle Leer- und Steuerzeichen am Ende des Textes.
Validate: Entfernt alle ungültigen Zeichen aus einem kompletten Dateinamen und vereinfacht mehrfache Leerzeichen.
Validate2: Entfernt alle ungültigen Zeichen aus einem Dateinamen ohne Pfad und ohne Endung. Entfernt z. B. auch ".", "\", ":"
Validate3: Hoch kompatibler Dateiname ohne Pfad und Endung. Erlaubt nur a bis z, A bis Z, Ziffern, Unter- und Bindestriche. Ersetzt Leerzeichen durch Bindestriche, ersetzt Umlaute und Eszett durch Umschreibungen (ä=ae, ß=ss). Entfernt alle anderen Zeichen.
Values,Name: Für mehrzeiligen Text mit der Syntax "Name=Value", siehe auch Beispiele.
%...: Format-Strings %d, %u, %x, %e, %f, %g, %n, %m, %s.
Syntax: "%" [Index ":"] ["-"] [Breite] ["." Genauigkeit] Typ
Mögliche Typen:
%d: Dezimal. Wenn der Format-String einen Bezeichner für die Genauigkeit enthält, muss der resultierende String mindestens die angegebene Anzahl von Stellen aufweisen. Enthält er weniger Stellen, wird der String auf der linken Seite mit Nullen aufgefüllt.
%e: Wissenschaftliche Notation für Gleitkommawerte. Der Wert wird in einen String mit der folgenden Form umgewandelt: "-d,ddd...E+ddd". Die Gesamtzahl der Stellen im Ergebnis wird durch den Genauigkeitsbezeichner festgelegt.
%f: Fest. Das Argument muss ein Gleitkommawert sein. Der Wert wird in einen String mit der folgenden Form umgewandelt: "-ddd,ddd...". Die Anzahl der Stellen nach dem Dezimalkomma wird durch den Genauigkeitsbezeichner festgelegt. Beispiel: "%8.2f"
%g: Allgemein. Das Argument muss ein Gleitkommawert sein. Der Wert wird unter Verwendung des Formats Fest oder wissenschaftliche Notation in den kürzestmöglichen Dezimal-String umgewandelt.
%m: Währung. Das Argument muss ein Gleitkommawert sein. Der Wert wird in einen String umgewandelt, der einen Währungsbetrag darstellt. Die Steuerung der Konvertierung erfolgt mit Hilfe der Windows-Ländereinstellungen.
%n: Zahl. Das Argument muss ein Gleitkommawert sein. Der Wert wird in einen String mit der folgenden Form umgewandelt: "-d.ddd.ddd,ddd...". Das Format "n" entspricht dem Format "f", allerdings enthält der resultierende String Tausendertrennzeichen.
%s: String. Das Argument muss ein Zeichen, ein String oder ein PChar-Wert sein. Der String bzw. das Zeichen wird anstelle des Formatbezeichners eingefügt. Wenn im Format-String ein Genauigkeitsbezeichner angegeben ist, bestimmt er die maximale Länge des resultierenden Strings. Ist das Argument ein String, der diese Maximallänge überschreitet, wird der String abgeschnitten.
%u: Vorzeichenlose Dezimalzahl. Das Format "u" entspricht dem Format "d", allerdings enthält der resultierende String kein Vorzeichen.
%x: Hexadezimal. Der Wert wird in einen String umgewandelt, der aus hexadezimalen Stellen besteht. Wenn der Format-String einen Bezeichner für die Genauigkeit enthält, muss der resultierende String mindestens die angegebene Anzahl von Stellen aufweisen. Enthält er weniger Stellen, wird der String auf der linken Seite mit Nullen aufgefüllt.
Hinweis: Wenn Sie keinen oder einen falschen Parameter angeben (z. B. durch einen Schreibfehler), dann wird der Parameter ignoriert und der komplette Text bzw. Dateiname zurückgegeben.
Beispiele:
{Doc:Filename}: Es ist kein Formatparameter angegeben. Die Variable liefert den kompletten Dateinamen des Dokumentes zurück: "C:\Daten\Datei.txt".
{Doc:Filename,Name}: Die Variable liefert nur "Datei" zurück.
{Appl:ApplExe,Path}: Das Verzeichnis des Anwendungsprogramms wird zurück gegeben: "C:\Programme\Editor".
{ExecSaveDlg:Textdatei|*.txt,Name}: Der Dateiname ohne Endung, den der Benutzer im Speichern-Dialog eingegeben hat: "Datei".
{Doc:CreateDate,Date}: Liefert nur das Datum der Dokumenterstellung zurück.
{Doc:Name,CopyChar008007}: Gibt "Manager" aus "Office Manager DMS" zurück.
{Doc:Notes,Values,Name}: Gibt "Das ist mein Name" zurück, wenn in den Notizen eine Zeile "Name=Das ist mein Name" enthalten ist.
Siehe auch