Variablen und Funktionen der Office Manager-Makrosprache "OmAPI"
Begriffe
Makro-Variable: Gibt eine Variable oder den Wert eines Datenfeldes zurück, ohne dass umfangreiche Operationen ablaufen. Häufig sind Formatparameter möglich.
Makro-Funktion: Führt Anweisungen aus und liefert einen Wert zurück.
Makro-Prozedur: Führt Anweisungen aus ohne einen Wert zurückzugeben, vergleichbar mit void-Funktionen in C.
Rückgabewert: Die Anweisung in geschweiften Klammern {} wird durch den Rückgabewert bzw. durch einen Leer-String ersetzt.
Sprach-Referenz
Felder der Dokumententabelle
{Doc:FieldName[,FormatParameter]}
Z. B.: Name des Dokumentes = {Doc:Name}, Projekt = {Doc:Project}.
Für den Dateinamen sollte die Variable {CurrDocFileName} verwendet werden, da diese auch die Dokumentversionen berücksichtigt.
{FieldAttribute:DocDB,FieldName,Variable,[Trennzeichen]}: erweiterte Feldeigenschaften.
Felder der Kontaktverwaltung
{Contact:FieldName[,FormatParameter]}
{FieldAttribute:CRMDB,FieldName,Variable,[Trennzeichen]}: erweiterte Feldeigenschaften.
Felder der Tätigkeiten
{Scheduler:FieldName[,FormatParameter]}
{DocArch:FieldName[,FormatParameter]}
Felder des Dokumentversions-Archivs
{DocVers:FieldName[,FormatParameter]}
Felder der Anwendungsdatenbank
{Appl:FieldName[,FormatParameter]}
Z. B.: Befehlszeile des Anwendungsprogramms = {Appl:ApplExe}
Felder der benutzerdefinierten Befehle
{ApplCmd:FieldName[,FormatParameter]}
Z. B.: Befehlszeile des Anwendungsprogramms = {ApplCmd:Cmd.ApplExe}
Felder der zusätzlichen Dateierweiterungen
{FileExt:FieldName[,FormatParameter]}
Felder der Vorlagendateien
{Template:FieldName[,FormatParameter]}
Format-Parameter
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.
Kommentarzeilen
Zeilen, die mit # beginnen, und leere Zeilen werden ignoriert. Siehe auch Sonderzeichen.
Bedingte Ausführung
{IF:Bedingung}Anweisungen{ENDIF}: Anweisung für bedingte Ausführung.
{GetFirstNotEmpty:Parameter-Liste}: gibt den ersten, nicht leeren Parameter zurück.
{GetFirstExistingFile:Parameter-Liste}: gibt den ersten Parameter zurück, der den Namen einer vorhandenen Datei enthält.
Liste aller Variablen und Funktionen
AcadArchiveUpdateAttributes
AcadComNewDwg
AcadGetAttributes
AcadGetLayoutNames
AcadSetAttributes
AcroExchGetTextFromRect
AcroExchMergeDocuments
AddDoc
AddDocEx
AddSysTask
AddToDo
AdoDestroy
AdoGetField
AdoGetFieldValues
AdoOperation
AdoRecordCount
AdoSetConnection
AdoSetField
AdoViewTable
AdminINI
Appl
ApplCmd
ArchiveDocument
AutoCaptAzureAI
AutoCaptCreate
AutoCaptCreateTxt
AutoCaptDefault
AutoCaptDestroy
AutoCaptDocumentText
AutoCaptFtiText
AutoCaptFindDate
AutoCaptFindMask
AutoCaptFirstCrspWord
AutoCaptKeywordValue
AutoCaptFtiWord
AutoCaptSelectionListFindItem
AutoCaptEInvoice
CachedDoc
Calculate
ChangeDir
Chr
CombineDocuments
ComCreateNewDocument
Contact
ContactSearch
CopyDocFile
CopyFile
CopyToClipboard
CreateDir
CreateDocFromTemplate
CreateDocVers
CreateKey
CreateKeyStr
CreateLnkFile
CSVFindRow
CSVGetCell
CurrApplExe
CurrDatabase
CurrDocFileName
CurrTableView
DatasetReport
Date
DBCheckFieldValue
DBLocate
DBOperation
DBSearch
DBSetField
DDECloseLink
DDEOpenLink
DDESendLine
DDESendMacro
DDESetExeParam
DeleteFile
Dest
Doc
DocArch
Document
DocumentSearch
DocVers
DocWriteJournal
DxfCreateFrame
ExcelGetCell
ExcelSetCell
ExecDirDlg
ExecInputQuery
ExecOpenDlg
ExecPrintDlg
ExecSaveDlg
ExecSQL
ExecSQLScalar
ExecStringDlg
ExecuteDocuments
ExecuteGPT
ExecuteMacroFile
ExecuteOCR
Exit
ExtractAttachment
ExtractDocumentText
ExtractImages
ExtractPages
FDDestroy
FDGetField
FDGetFieldValues
FDOperation
FDRecordCount
FDSetConnection
FDSetField
FDTableNames
FDViewTable
FieldAttribute
FieldInfo
FileAttr
FileConvert
FileExecuteMacro
FileExists
FileExt
FilePageCount
FileSecureTakeOwnership
FileSecureSetRights
FileSetAttr
FldTempl
Format
FtiFindMask
FtiGetFirstCrspWord
FtiGetKeywordValue
FtiGetWord
FtiUpdate
GetBackupFileName
GetControl
GetFirstExistingFile
GetFirstNotEmpty
GetPrivVar
GetPublVar
GetTempFileName
GridDocClearSelection
GridDocSelect
GridDocSelectedCount
GridSelectedCell
GUID
HelpContext
IF
IfThen
ImgCalcDensityHistogram
ImgExtractMetaWords
ImgGetBlackDotsRatio
ImgGetProperty
ImgGetTextFromRect
ImgReadBarcode
ImgWriteProperty
ImportAbort
ImportFile
IncludeMacroFile
InifileOperation
InifileReadSection
InifileReadStr
InifileWriteStr
LastAppendedDocID
LoadLanguageFile
MailGetProperty
MapiCreateEMail
MegaCreateFrame
MergeDocuments
MessageBeep
MessageDlg
MessageDlgCB
MinimizeApplication
MoveFile
OleDocumentSummaryInformation
OleMessageRegisterFilter
OleMessageRevokeFilter
OleSummaryInformation
OleUserDefinedProperties
OleSetDocumentSummaryInformation
OleSetSummaryInformation
OleSetUserDefinedProperties
OmAPI
OmApiCsvParams
OpenDatabase
OpenDlg
OpenDocument
Ord
OS
PackFiles
PasteFromClipboard
PDFAddComment
PDFAddStamp
PDFGetTextFromRect
PDFProtectDocument
ProcessMessages
RaiseError
ReadAdminIni
ReadIdentNo
ReadLnFile
ReadShortcutURL
RecordCount
RecoverDocument
RegistryReadInt
RegistryReadStr
RegistryWriteInt
RegistryWriteStr
SaveAsPDF
SaveAsWebarchive
SaveDlg
SaveLanguageFile
ScanSnap
ScriptControl
ScriptControlSetOption
SearchField
SearchGridSelection
SelectDocVersions
SelectionListFindItem
Self
SendKey
SendKeyStr
SendMouseClick
SetActiveApplication
SetComApplName
SetControl
SetPrivVar
SetPublVar
SetStayOnTop
Scheduler
ShellExecute
ShowApplication
SignDocument
Source
SplitDocument
StoreHashesOnBlockchain
StringReplace
Template
UpdateDocAttributesFromFile
Wait
WaitForApplication
WaitForFile
WinAPI
WriteLnFile
WriteStatusbar
Makro-Editor
Zugriff aus Fremdprogrammen
COM-Referenz