Formatparameter Datei und Text

Navigation:  Entwicklerhilfe > Makro-Referenz OmAPI

Formatparameter Datei und Text

Previous pageReturn to chapter overviewNext page

Format-Parameter für Dateivariablen und Texte

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.

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,{OmDBFieldDoc: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.

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.

OemToChar: Konvertiert den OEM-Text (ASCII) in ANSI oder Unicode.

Quote: Setzt den Dateinamen in doppelte Anführungszeichen, wenn er Leerzeichen enthält.

QuoteEver: Setzt den Dateinamen 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.

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.

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 ".", "\", ":"

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

Hinweis: Wenn Sie keinen oder einen falschen Parameter angeben (z. B. durch einen Schreibfehler), dann wird immer der komplette Dateiname zurückgeliefert.

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

Makro-Referenz

Format

Formatparameter für Datum