Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Functions supported on FileMaker Server

Server   Not   MacOS   Windows   Linux   Mac & Win  

Item Details
AVAsset.AvailableMetadataFormats
Returns a list representing available metadata formats.
Mac/iOS
5.2
AVAsset.Duration
Returns the duration of a asset in seconds.
Mac/iOS
5.2
AVAsset.Framerate
Looks for first video track and reports the nominal frame rate.
Mac/iOS
5.2
AVAsset.HasProtectedContent
Queries whether the asset has protected content.
Mac/iOS
5.2
AVAsset.Image
Returns an image for the asset at or near a specified time.
Mac/iOS
5.2
AVAsset.ImageActualTime
Queries actual time for image.
Mac/iOS
6.5
AVAsset.IsComposable
Queries whether this asset can be used in compositions.
Mac/iOS
5.2
AVAsset.IsExportable
Indicates whether the asset can be exported.
Mac/iOS
5.2
AVAsset.IsPlayable
Checks whether the asset, or its URL, can be played.
Mac/iOS
5.2
AVAsset.IsReadable
Checks whether the asset’s media data can be extracted
Mac/iOS
5.2
AVAsset.Loaded
Queries load status of asset.
Mac/iOS
5.2
AVAsset.Lyrics
Queries the lyrics of the asset suitable for the current locale.
Mac/iOS
5.2
AVAsset.Metadata
Queries metadata.
Mac/iOS
5.2
AVAsset.MetadataKeys
Queries metadata keys.
Mac/iOS
5.2
AVAsset.NaturalHeight
Queries the natural height of the video.
Mac/iOS
5.2
AVAsset.NaturalWidth
Queries the natural width of the video.
Mac/iOS
5.2
AVAsset.OpenContainer
Opens a movie from a container.
Mac/iOS
5.2
AVAsset.OpenFile
Opens an asset from a file.
Mac/iOS
5.2
AVAsset.OpenURL
Opens a movie from URL.
Mac/iOS
5.2
AVAsset.PreferredRate
Queries the natural rate at which the asset is to be played.
Mac/iOS
5.2
AVAsset.PreferredVolume
Queries the preferred volume at which the audible media of asset is to be played.
Mac/iOS
5.2
AVAsset.Release
Releases the object and all memory used for it.
Mac/iOS
5.2
AVAsset.ReleaseAll
Release all asset objects.
Mac/iOS
10.2
AVAsset.RequestImageTimePrecision
Requests to use high precision for timing of images.
Mac/iOS
6.5
AVAsset.TimeCodes
Reads time codes from asset.
Mac/iOS
5.4
AVAsset.TrackCount
Queries the track count.
Mac/iOS
5.2
AVAsset.TrackInfo
Queries track details.
Mac/iOS
7.4
AVAsset.URL
Queries the URL used to open this asset.
Mac/iOS
5.2
AVAsset.WaitForLoaded
Waits for file to be loaded.
Mac/iOS
8.0
AVExport.AllExportPresets
Queries list of all supported presets.
Mac/iOS
6.1
AVExport.CancelExport
Cancels the execution of an export session.
Mac/iOS
6.1
AVExport.Duration
Queries duration of the asset.
Mac/iOS
6.1
AVExport.Error
Queries the error that occurred if the export status is Failed.
Mac/iOS
6.1
AVExport.EstimatedOutputFileLength
Queries the estimated byte size of exported file.
Mac/iOS
6.1
AVExport.ExportAsynchronously
Starts export.
Mac/iOS
6.1
AVExport.ExportSession
Creates a new export session.
Mac/iOS
6.1
AVExport.ExportSessionMerge
Creates a new export session.
Mac/iOS
6.2
AVExport.GetOutputFileType
Queries the output file type.
Mac/iOS
6.1
AVExport.GetOutputPath
Queries the current output path.
Mac/iOS
6.1
AVExport.GetOutputURL
Queries the current output URL.
Mac/iOS
6.1
AVExport.GetShouldOptimizeForNetworkUse
Queries whether video should be network optimized.
Mac/iOS
6.1
AVExport.GetTimeRange
Queries time range to export.
Mac/iOS
6.1
AVExport.List
Lists all IDs of export objects.
Mac/iOS
13.0
AVExport.OutputFileExtension
Queries preferred file extension for current export.
Mac/iOS
6.1
AVExport.PresetName
Returns the name of the preset used.
Mac/iOS
6.1
AVExport.Progress
Queries current progress.
Mac/iOS
6.1
AVExport.Release
Frees the session.
Mac/iOS
6.1
AVExport.ReleaseAll
Frees all export sessions.
Mac/iOS
10.5
AVExport.SetOutputFileType
Sets the output file type.
Mac/iOS
6.1
AVExport.SetOutputPath
Sets the output file path.
Mac/iOS
6.1
AVExport.SetOutputURL
Sets the output file URL.
Mac/iOS
6.1
AVExport.SetShouldOptimizeForNetworkUse
Whether to optimize video for network use.
Mac/iOS
6.1
AVExport.SetTimeRange
Specifies a time range to be exported from the source.
Mac/iOS
6.1
AVExport.Status
Queries status of export.
Mac/iOS
6.1
AVExport.SupportedFileTypes
Queries supported file type for this export session.
Mac/iOS
6.1
AVPlayer.List
Lists all IDs of player objects.
Mac/iOS
13.0
AVRecorder.List
Lists all IDs of recorder objects.
Mac/Win/iOS
13.0
AddToErrorLog
Adds log entry to current error log.
All
12.3
App.EffectiveUserID
Queries effective user ID.
Mac/Linux/iOS
8.0
App.Exit
Quits the current process.
All
11.1
App.GetDockIcon
Queries the dock icon.
Mac only
3.2
App.GetProcessName
Queries the name of the application.
All
3.2
App.GetProcessPath
Queries the path of the application.
All
3.5
App.MemoryUsed
Queries amount of memory used.
Mac/Win
6.5
App.ProcessID
Queries process ID.
All
8.0
App.SetProcessName
Sets the name of the current application.
Mac only
3.2
App.UserID
Queries user ID.
Mac/Linux/iOS
8.0
AppleScript.Close
Removes a Script from memory.
Mac only
1.0
AppleScript.Compile
Compiles the script and returns the Script ID.
Mac only
1.0
AppleScript.Execute
Performs a compiled Apple Script.
Mac only
1.0
AppleScript.GetPropertyName
Queries name of property with given index.
Mac only
4.2
AppleScript.GetPropertyValue
Queries property value text.
Mac only
4.2
AppleScript.LastError
Returns the last error code.
Mac only
1.0
AppleScript.LastErrorMessage
Returns the last error message.
Mac only
1.0
AppleScript.LastErrorPosition
Queries position of error in source text.
Mac only
13.2
AppleScript.List
Lists all IDs of AppleScript objects.
Mac only
13.0
AppleScript.PropertyCount
Queries the number of properties in the script.
Mac only
4.2
AppleScript.Run
The function compiles the AppleScript text and runs it.
Mac only
1.0
AppleScript.SetPropertyValue
Sets property value with new text.
Mac only
4.2
Archive.AddContainer
Adds a container value to the current archive.
All
13.1
Archive.AddFile
Add files to the current archive.
All
13.1
Archive.AddText
Add a text file to the archive.
All
13.1
Archive.BZip2Version
Queries version of bzip2 library.
All
13.2
Archive.Close
Closes the current archive.
All
13.1
Archive.Compress
Compresses files to an archive.
All
9.0
Archive.CompressContainer
Compresses one container into a new archive.
All
11.1
Archive.Content
Lists content of archive as JSON.
All
9.0
Archive.Create
Creates a new archive.
All
13.1
Archive.Extract
Extracts files in an archive.
All
9.0
Archive.ExtractFile
Extracts one file and returns as container.
All
10.4
Archive.FileList
Lists file paths in the archive.
All
9.0
Archive.GZipDecompress
Extracts content of gzip file as container.
All
11.3
Archive.LZ4Version
Queries version of lz4 library.
All
13.2
Archive.LibVersion
Queries version of LibArchive.
All
9.0
Archive.LibVersionDetails
Queries version of LibArchive.
All
9.0
Archive.SupportedFormats
Returns the list of supported formats.
All
9.0
Archive.Verify
Verifies files in an archive.
All
9.2
Archive.ZLibVersion
Queries version of zlib library.
All
13.2
Archive.ZStdVersion
Queries version of zest library.
All
13.2
Archive.lzmaVersion
Queries version of lzma library.
All
13.2
Audit.Backup
Log record.
All
8.5
Audit.Backup2
Log record.
All
8.5
Audit.BaseTableNameForID
Looks up the Audit cache for the base table name for a given table occurrence ID.
All
13.1
Audit.Changed
Log record change.
All
2.8
Audit.Changed2
Same as Audit.Changed, but here you pass the list of fields to check.
All
3.1
Audit.ClearCaches
Clears internal caches for audit functions.
All
3.1
Audit.Delete
Log record deletion.
All
2.8
Audit.Delete2
Same as Audit.Delete, but here you pass the list of fields to check.
All
3.1
Audit.FieldIDForName
Looks up the Audit cache for a field name.
All
8.2
Audit.FieldNameForID
Looks up the Audit cache for a field ID.
All
8.0
Audit.GetDateAndTimeAsNumbers
Queries state for this option.
All
12.3
Audit.GetEnabled
Queries enable status.
All
7.1
Audit.GetIgnoreCalculations
Queries whether stored calculations are audited.
All
4.4
Audit.GetIgnoreRepetitions
Queries whether repetition fields should be ignored.
All
10.3
Audit.GetIgnoreSummaryFields
Queries whether summary fields are audited.
All
5.4
Audit.GetIgnoreUnderscoreFieldNames
Queries the state of the underscore ignore setting.
All
5.3
Audit.GetIgnoredFieldNames
Queries list of ignored field names.
All
7.3
Audit.GetLogAccess
Queries whether plugin logs access.
All
4.1
Audit.GetUUIDField
Queries UUID field name.
All
7.3
Audit.Hash
Hashes the field/value.
All
11.1
Audit.SetDateAndTimeAsNumbers
Sets whether time values are stored as numbers.
All
12.3
Audit.SetEnabled
Turns audit globally on or off.
All
7.1
Audit.SetIgnoreCalculations
Set whether stored calculations are audited.
All
4.4
Audit.SetIgnoreRepetitions
Whether to ignore repetitions.
All
10.3
Audit.SetIgnoreSummaryFields
Set whether summary fields are audited.
All
5.4
Audit.SetIgnoreUnderscoreFieldNames
Sets whether to ignore all field names whose name starts with underscore character.
All
5.3
Audit.SetIgnoredFieldNames
Sets the ignored field names.
All
2.8
Audit.SetLogAccess
Sets whether access is logged.
All
4.1
Audit.SetUUIDField
Sets the UUID field name.
All
7.3
Audit.Statistics
Queries statistics for Audit functions.
All
12.1
Audit.TableIDForName
Looks up the Audit cache for a table name.
All
8.2
Audit.TableNameForID
Looks up the Audit cache for the table name for a given table occurrence ID.
All
8.0
Barcode.DrawBarcode
Draws a barcode into a PDF page.
All
3.5
Barcode.EANChecksum
Calculates checksum for EAN barcodes.
All
5.0
Barcode.Generate
Generates a barcode.
All
3.5
Barcode.GenerateJSON
Generates a barcode.
All
9.4
Barcode.GetInputMode
Queries input mode.
All
8.1
Barcode.GetOption
Queries option by index.
All
8.1
Barcode.GetPrimary
Queries primary parameter.
All
7.1
Barcode.ISBNChecksum
Calculates checksum for ISBN barcodes.
All
5.0
Barcode.LibVersion
Queries version of Zint library.
All
9.3
Barcode.LoadLibrary
Loads the zbar library.
All
11.3
Barcode.Loaded
Whether the zbar library is loaded.
All
11.3
Barcode.Modulo10Checksum
Calculate checksum with Modulo 10 recursive.
All
11.1
Barcode.Scan
Scans for barcodes in a picture.
All
11.3
Barcode.SetInputMode
Sets input mode.
All
8.1
Barcode.SetOption
Sets option by index.
All
8.1
Barcode.SetOptions
Sets options for barcode creation.
All
4.3
Barcode.SetPrimary
Sets primary parameter.
All
7.1
Barcode.UPCChecksum
Calculates checksum for UPC barcodes.
All
3.5
Barcode.WriteFile
Generates a barcode and writes to file.
All
4.3
Barcode.ZBarVersion
Queries version of zbar library.
All
11.3
BinaryFile.Append
Opens a file to append data.
All
7.3
BinaryFile.Close
Closes a file.
All
7.3
BinaryFile.Create
Creates a new file.
All
7.3
BinaryFile.EOF
Queries whether we are at the end of the current file.
All
7.3
BinaryFile.Length
Queries length of current file.
All
7.3
BinaryFile.List
Lists all IDs of binary file objects.
All
13.0
BinaryFile.Open
Opens an existing file for reading.
All
7.3
BinaryFile.Position
Queries current file position.
All
7.3
BinaryFile.ReadByte
Reads a single byte from the file.
All
7.3
BinaryFile.ReadContainer
Read some data and interpret them as container.
All
7.3
BinaryFile.ReadFloat
Reads a float value.
All
7.3
BinaryFile.ReadHex
Read data and returns as hex text.
All
7.3
BinaryFile.ReadInt
Reads an integer value.
All
7.3
BinaryFile.ReadPDF
Reads data as PDF.
All
7.3
BinaryFile.ReadText
Reads text from file.
All
7.3
BinaryFile.Seek
Moves file pointer to new position.
All
7.3
BinaryFile.WriteByte
Writes a single byte value to the file.
All
7.3
BinaryFile.WriteContainer
Writes a container value to the file.
All
7.3
BinaryFile.WriteFloat
Writes a float value.
All
7.3
BinaryFile.WriteHex
Writes hex encoded data.
All
7.3
BinaryFile.WriteInt
Writes an integer value.
All
7.3
BinaryFile.WriteText
Writes a text file with the given text.
All
7.3
Bonjour.Browse
Starts browse for given type.
Mac/Win
8.4
Bonjour.JSON
Query current results as JSON.
Mac/Win
8.4
Bonjour.Register
Register a service.
Mac/Win/iOS
8.4
Bonjour.RegisteredName
Queries registered name.
Mac/Win/iOS
8.4
CF   New in 14.1
Shorter version for FM.CF.
All
14.1
CFunction.AllocateArray
Allocates an array parameter.
All
10.3
CFunction.Call
Calls a C function.
All
10.3
CFunction.FreeArray
Free an array parameter.
All
10.3
CFunction.GetArray
Queries values of an array.
All
10.3
CFunction.GetArrayByteSize
Queries byte size of allocated array.
All
10.3
CFunction.List
Lists all IDs of function objects.
All
13.0
CFunction.Name
Queries name of the function.
All
10.3
CFunction.ParameterCount
Queries parameter count for function.
All
10.3
CFunction.ParameterType
Queries parameter type for a parameter.
All
10.3
CFunction.Release
Releases the function and all memory used for it.
All
10.3
CFunction.ReleaseAll
Frees all functions.
All
10.5
CFunction.ReturnType
Queries return type.
All
10.3
CFunction.SetArray
Sets values of an array.
All
10.3
CGImageSource.ClearProperties
Clears all properties.
Mac/iOS
9.4
CGImageSource.Count
Queries number of images in this image source.
Mac/iOS
3.4
CGImageSource.CreateWithData
Creates an image source that reads from a container.
Mac/iOS
3.4
CGImageSource.CreateWithPath
Creates an image source that reads from a location specified by a Path.
Mac/iOS
3.4
CGImageSource.CreateWithURL
Creates an image source that reads from a location specified by a URL.
Mac/iOS
3.4
CGImageSource.Export
Exports the image as container value.
Mac/iOS
9.4
CGImageSource.FileName
Queries file name of the image.
Mac/iOS
9.4
CGImageSource.HasProperty
Query whether the property exists.
Mac/iOS
9.4
CGImageSource.ImageAtIndex
Returns the image associated with the specified index in an image source.
Mac/iOS
3.4
CGImageSource.Keys
Queries the list of keys for all the properties in the image source.
Mac/iOS
3.4
CGImageSource.List
Lists all IDs of image source objects.
Mac/iOS
13.0
CGImageSource.Properties
Queries all properties as JSON.
Mac/iOS
8.3
CGImageSource.Property
Queries the value of a property.
Mac/iOS
3.4
CGImageSource.Release
Closes image source and releases memory.
Mac/iOS
3.4
CGImageSource.ReleaseAll
Frees all CGImageSource objects.
Mac/iOS
10.5
CGImageSource.SetProperty
Sets the value for a property.
Mac/iOS
9.4
CGImageSource.Status
Return the status of an image source.
Mac/iOS
3.4
CGImageSource.SupportedExportTypes
Returns an array of uniform type identifiers (UTIs) that are supported for image destinations.
Mac/iOS
9.4
CGImageSource.SupportedTypes
Returns an array of uniform type identifiers (UTIs) that are supported for image sources.
Mac/iOS
3.4
CGImageSource.ThumbnailAtIndex
Creates a thumbnail image of the image located at a specified location in an image source.
Mac/iOS
3.4
CGImageSource.Type
Queries the type of the image source.
Mac/iOS
3.4
CLibrary.List
Lists all IDs of library objects.
All
13.0
CLibrary.Load
Loads a C library.
All
10.3
CLibrary.LoadFunction
Loads a function from a library.
All
10.3
CLibrary.Name
Queries name of the library.
All
10.3
CLibrary.Release
Releases the library and all memory used for it.
All
10.3
CLibrary.ReleaseAll
Frees all libraries.
All
10.5
CLibrary.Symbols
Queries list of symbols of a library.
All
10.3
CUPS.CancelJob
Cancel a print job on the default server.
Mac only
2.5
CUPS.GetDefaultPrinterName
Get the default printer or class for the default server.
Mac only
2.5
CUPS.GetJobsAsJSON
Queries some jobs and returns JSON Array.
Mac only
10.5
CUPS.GetPrintersAsJSON
Queries list of printers as JSON.
Mac only
10.5
CUPS.LastErrorCode
Return the last IPP status code.
Mac only
2.5
CUPS.LastErrorMessage
Return the last status-message.
Mac only
2.5
CUPS.PrintData
Print a file to a printer or class on the default server.
Mac only
2.5
CUPS.PrintDataEncoding
Print a file to a printer or class on the default server.
Mac only
6.3
CUPS.PrintFile
Print a file to a printer or class on the default server.
Mac only
2.5
CURL.AWSPresignURL
Query predigend URL for Amazon Webservices.
All
11.3
CURL.AddInputFile
Adds input to file data from the container value.
All
2.7
CURL.AddInputGIF
Adds input to GIF data from the container value.
All
3.1
CURL.AddInputJPEG
Adds input to JPEG data from the container value.
All
2.7
CURL.AddInputPDF
Adds input to PDF data from the container value.
All
4.0
CURL.AddInputPNG
Adds input to PNG data from the container value.
All
2.7
CURL.AddInputText
Adds input data for this transfer to be the text you provide.
All
2.7
CURL.Cancel
Cancels a running transfer in background.
All
2.5
CURL.Check
Checks for curl events.
All
5.2
CURL.CloseDebugFile
Closes the debug output file.
All
2.6
CURL.CloseHeaderFile
Closes the header output file.
All
2.6
CURL.CloseInputFile
Closes the input file.
All
2.6
CURL.CloseOutputFile
Closes the data output file.
All
2.6
CURL.CreateDebugOutputFile
Creates output file for writing debug messages.
All
2.6
CURL.CreateHeaderOutputFile
Creates output file for writing header text.
All
2.6
CURL.CreateOutputFile
Creates output file for downloading data.
All
2.6
CURL.ErrorCode
Returns the last CURL error code.
All
2.5
CURL.ErrorMessage
Returns the last CURL error message.
All
2.5
CURL.Features
Queries features in the CURL library.
All
10.1
CURL.FileInfos
Queries file listing as JSON.
All
8.5
CURL.FormAddKeyContainer
Add a section to a multipart/formdata HTTP POST.
All
2.6
CURL.FormAddKeyContainerContentType
Add a section to a multipart/formdata HTTP POST.
All
2.6
CURL.FormAddKeyFile
Add a section to a multipart/formdata HTTP POST.
All
2.6
CURL.FormAddKeyFileContentType
Add a section to a multipart/formdata HTTP POST.
All
2.6
CURL.FormAddKeyText
Add a section to a multipart/formdata HTTP POST.
All
2.6
CURL.FormAddKeyTextContentType
Add a section to a multipart/formdata HTTP POST.
All
2.6
CURL.FormAddKeyValue
Add a section to a multipart/formdata HTTP POST.
All
2.5
CURL.FormAddKeyValueContentType
Add a section to a multipart/formdata HTTP POST.
All
2.5
CURL.FormClear
Clears current form data.
All
9.0
CURL.FormFinish
Finishes constructing a form.
All
2.5
CURL.GetActiveSocket
Receive the active socket used by this curl session.
All
8.2
CURL.GetAppConnectTime
Queries connect time.
All
2.5
CURL.GetBatchCurrentFileName
Queries current file name.
All
7.0
CURL.GetBatchCurrentFilePath
Queries current file path.
All
7.0
CURL.GetBatchDestinationPath
Queries destination path.
All
7.0
CURL.GetBatchFileNames
Queries list of file names downloaded.
All
7.0
CURL.GetCAInfo
Queries default CAInfo value.
All
12.3
CURL.GetCAPath
Queries default CAPath value.
All
12.3
CURL.GetCertInfo
Queries information on the certificate chain.
All
5.2
CURL.GetConditionUnmet
Get the number 1 if the condition provided in the previous request didn't match.
All
2.5
CURL.GetConnectTime
Queries connect time.
All
2.5
CURL.GetContentLengthDownload
Get the content-length of the download.
All
2.5
CURL.GetContentLengthUpload
Get the specified size of the upload.
All
2.5
CURL.GetContentType
Get the content-type of the downloaded object.
All
2.5
CURL.GetCookieList
Get list of all cookies cURL known (expired ones, too).
All
2.5
CURL.GetDebugLength
Queries the current length in bytes of the debug messages buffer.
All
2.5
CURL.GetDebugMessages
Returns the debug output of the transaction as text.
All
13.0
CURL.GetDebugWithData
Whether to include data in the debug log.
All
6.2
CURL.GetDebugWithProgress
Queries whether to include progress in debug messages.
All
6.3
CURL.GetDebugWithTime
Queries whether times are included in debug messages.
All
6.2
CURL.GetEffectiveMethod
Get the last used effective HTTP method.
All
10.4
CURL.GetEffectiveURL
Get the last used effective URL.
All
2.5
CURL.GetFTPEntryPath
Get a string holding the path of the entry path.
All
2.5
CURL.GetFailedEvaluate   New in 14.0
Queries expression to be run when transfer failed.
All
14.0
CURL.GetFailedFileName   New in 14.0
Queries the file name for the script to call in case of failed transfer.
All
14.0
CURL.GetFailedScriptName   New in 14.0
Queries the script name for the script to call in case of failed transfer.
All
14.0
CURL.GetFileTime
Get the remote time of the retrieved document.
All
2.5
CURL.GetFinishedEvaluate
Queries expression to be run when transfer is finished.
All
6.1
CURL.GetFinishedFileName
Queries the file name for the finished script to call.
All
5.2
CURL.GetFinishedScriptName
Queries the script name to call when transfer finished.
All
5.2
CURL.GetFormData
Queries form data as it would be sent currently.
All
8.2
CURL.GetHTTPAuthAvail
Get a bitmask indicating the authentication method(s) available.
All
2.5
CURL.GetHTTPConnectCode
Get the last received proxy response code to a CONNECT request.
All
2.5
CURL.GetHTTPVersion
Queries http version.
All
8.2
CURL.GetHeaderAsJSON
Returns headers parsed as JSON.
All
10.2
CURL.GetHeaderLength
Queries the current length in bytes of the header buffer.
All
2.5
CURL.GetHeaderSize
Get the total size of all the headers received. Measured in number of bytes.
All
2.5
CURL.GetHeaders
Returns the headers of the transaction as text.
All
13.0
CURL.GetInputAsText
Returns the input of the transaction as text.
All
2.8
CURL.GetInputLength
Queries the current length in bytes of the input buffer.
All
2.5
CURL.GetLocalIP
Queries local IP.
All
2.5
CURL.GetLocalPort
Get the local (source) port of the most recent connection done with this curl handle.
All
2.5
CURL.GetMultiOptionChunkLengthPenaltySize
Queries chunk length penalty size.
All
8.2
CURL.GetMultiOptionContentLengthPenaltySize
Queries content length penalty size.
All
8.2
CURL.GetMultiOptionMaxConcurrentStreams
Queries max connections per server.
All
10.0
CURL.GetMultiOptionMaxConnects
Queries max connects setting.
All
8.2
CURL.GetMultiOptionMaxHostConnections
Queries max host connections value.
All
8.2
CURL.GetMultiOptionMaxPipelineLength
Queries max pipeline length.
All
8.2
CURL.GetMultiOptionMaxTotalConnections
Queries max total connections value.
All
8.2
CURL.GetMultiOptionPipelining
Queries pipelining mode.
All
8.2
CURL.GetMultiRunningTransfers
Queries running transfers count.
All
8.2
CURL.GetNameLookupTime
Get the time, in seconds, it took from the start until the name resolving was completed.
All
2.5
CURL.GetNumConnects
Queries new connections count for transfer.
All
2.5
CURL.GetOSErrNo
Get the errno variable from a connect failure.
All
2.5
CURL.GetOptionConnectTo
Queries connect to list.
All
8.2
CURL.GetOptionCustomRequest
Queries current custom request value.
All
10.4
CURL.GetOptionHTTP200Aliases
Queries HTTP 200 aliases list.
All
8.2
CURL.GetOptionHTTPHeader
Queries HTTP request headers.
All
8.2
CURL.GetOptionMailRecipients
Queries mail recipients list.
All
8.2
CURL.GetOptionPostFields
Queries current post fields value.
All
10.4
CURL.GetOptionPostQuote
Queries post quote list.
All
8.2
CURL.GetOptionPreQuote
Queries pre quote list.
All
8.2
CURL.GetOptionProxyHeader
Queries proxy header request list.
All
8.2
CURL.GetOptionQuote
Queries quote list.
All
8.2
CURL.GetOptionResolve
Queries resolve list.
All
8.2
CURL.GetOptionTelnetOptions
Queries telnet options list.
All
8.2
CURL.GetOptionURL
Queries current URL value.
All
10.4
CURL.GetOptionUserName
Queries current user name value.
All
10.4
CURL.GetPreTransferTime
Get the time, in seconds, it took from the start until the file transfer is just about to begin.
All
2.5
CURL.GetPrimaryIP
Queries primary IP.
All
2.5
CURL.GetPrimaryPort
Get the destination port of the most recent connection done with this curl handle.
All
2.5
CURL.GetProgressCurrentDownload
Queries current number of bytes downloaded.
All
2.5
CURL.GetProgressCurrentUpload
Queries current number of bytes uploaded.
All
2.5
CURL.GetProgressEvaluate
Queries expression to be run when transfer makes progress.
All
6.1
CURL.GetProgressFileName
Queries progress script file name.
All
5.2
CURL.GetProgressPercent
Queries progress in percent.
All
5.2
CURL.GetProgressScriptName
Queries script name to be called for progress.
All
5.2
CURL.GetProgressTotalDownload
Queries total number of bytes to download.
All
2.5
CURL.GetProgressTotalUpload
Queries total number of bytes to upload.
All
2.5
CURL.GetProxyAuthAvail
Queries available proxy authentication methods.
All
2.5
CURL.GetProxyError
Queries proxy error code.
All
10.5
CURL.GetProxySSLVerifyResult
Queries result of proxy ssl verification.
All
8.2
CURL.GetRTSPCSEQRecv
Query RTSP sequence counter received.
All
5.2
CURL.GetRTSPClientCSEQ
Query RTSP Client sequence counter.
All
5.2
CURL.GetRTSPServerCSEQ
Query RTSP Server sequence counter.
All
5.2
CURL.GetRTSPSessionID
Query RTSP session ID.
All
5.2
CURL.GetRedirectCount
Get the total number of redirections that were actually followed.
All
2.5
CURL.GetRedirectTime
Queries redirect time.
All
2.5
CURL.GetRedirectURL
Queries redirect URL.
All
2.5
CURL.GetReferer
Queries referrer text.
All
11.2
CURL.GetRequestSize
Get the total size of the issued requests.
All
2.5
CURL.GetResponseCode
Get the last received HTTP or FTP code.
All
2.5
CURL.GetResultAsContainer
Returns the result of the transaction as container value with auto detection of type.
All
5.2
CURL.GetResultAsData
Returns the result of the transaction as data file.
All
2.5
CURL.GetResultAsEMailList
Parses result of an IMAP list query.
All
9.0
CURL.GetResultAsEmail
Queries the result of the CURL transfer and parses as email.
All
5.3
CURL.GetResultAsGIF
Returns the result of the transaction as GIF image.
All
3.1
CURL.GetResultAsJPEG
Returns the result of the transaction as JPEG image.
All
2.5
CURL.GetResultAsMime
Queries the result of the CURL transfer and parses as mime data.
All
10.0
CURL.GetResultAsPDF
Returns the result of the transaction as PDF.
All
4.0
CURL.GetResultAsPNG
Returns the result of the transaction as PNG image.
All
2.5
CURL.GetResultAsText
Returns the result of the transaction as text.
All
2.5
CURL.GetResultLength
Queries the current length in bytes of the result buffer.
All
2.5
CURL.GetRetryAfter
Returns the Retry-After retry delay.
All
10.4
CURL.GetSSLEngines
Get a linked-list of OpenSSL crypto-engines supported.
All
2.5
CURL.GetSSLVerifyResult
Get the result of the certification verification that was requested.
All
2.5
CURL.GetScheme
Queries scheme.
All
8.2
CURL.GetSizeDownload
Get the total amount of bytes that were downloaded.
All
2.5
CURL.GetSizeUpload
Get the total amount of bytes that were uploaded.
All
2.5
CURL.GetSpeedDownload
Get the average download speed that curl measured for the complete download.
All
2.5
CURL.GetSpeedUpload
Get the average upload speed that curl measured for the complete upload.
All
2.5
CURL.GetStartTransferTime
Get the time, in seconds, it took from the start until the first byte is received by libcurl.
All
2.5
CURL.GetSucceededEvaluate   New in 14.0
Queries expression to be run when transfer succeeded.
All
14.0
CURL.GetSucceededFileName   New in 14.0
Queries the file name for the script to call in case of successful transfer.
All
14.0
CURL.GetSucceededScriptName   New in 14.0
Queries the script name for the script to call in case of successful transfer.
All
14.0
CURL.GetTag
Queries the tag value.
All
5.2
CURL.GetTotalTime
Queries total time of transfer.
All
2.5
CURL.Host
Queries host value from compiling.
All
2.5
CURL.IsRunning
Checks whether a transfer is still running.
All
2.5
CURL.LibIDNVersion
Queried LibIDN version.
All
8.2
CURL.LibSSHVersion
Queries SSH library version.
All
8.2
CURL.LibSSLVersion
Returns SSL Library version.
All
2.5
CURL.List
Lists all IDs of current CURL transfers.
All
5.4
CURL.LoadLibrary
Loads a custom CURL library.
All
10.2
CURL.New
Start a new CURL easy session.
All
2.5
CURL.NumberOfRunningTransfers
Queries number of running transfers.
All
5.2
CURL.OpenInputFile
Opens file for reading data needed for upload, email sending or HTTP Post.
All
2.6
CURL.Options
Queries all CURL options set for this CURL handle.
All
12.4
CURL.Perform
Perform a file transfer.
All
2.5
CURL.PerformInBackground
Perform a file transfer in background.
All
2.5
CURL.ProcessRelativeURL
Processes an URL to come from relative URL to a new absolute URL.
All
13.4
CURL.Protocols
Queries list of supported protocols.
All
2.5
CURL.ReceiveData
Receives raw data on a connection.
All
7.2
CURL.ReceiveText
Receives raw data on a connection as text.
All
7.2
CURL.Release
End a CURL session.
All
2.5
CURL.ReleaseAll
Releases all CURL objects.
All
10.2
CURL.Reset
Resets the CURL session.
All
5.2
CURL.RunningTransfers
Queries list of running transfers.
All
5.2
CURL.SendData
Sends raw data over a connection.
All
7.2
CURL.SendText
Sends raw data with text over a connection.
All
7.2
CURL.SetBatchDestinationPath
Sets the destination path for batch downloads.
All
7.0
CURL.SetDebugWithData
Whether to include data in the debug log.
All
6.2
CURL.SetDebugWithProgress
Sets whether to include progress in debug messages.
All
6.3
CURL.SetDebugWithTime
Sets whether times are included in debug log.
All
6.2
CURL.SetFailedEvaluate   New in 14.0
Sets expression to be run when transfer failed.
All
14.0
CURL.SetFailedScript   New in 14.0
Sets which script to call when a transfer failed.
All
14.0
CURL.SetFinishedEvaluate
Sets expression to be run when transfer is finished.
All
6.1
CURL.SetInputFile
Sets input to file data from the container value.
All
2.5
CURL.SetInputGIF
Sets input to GIF data from the container value.
All
3.1
CURL.SetInputJPEG
Sets input to JPEG data from the container value.
All
2.5
CURL.SetInputPDF
Sets input to PDF data from the container value.
All
4.0
CURL.SetInputPNG
Sets input to PNG data from the container value.
All
2.5
CURL.SetInputText
Sets input data for this transfer to be the text you provide.
All
2.5
CURL.SetMultiOptionChunkLengthPenaltySize
Sets chunk length penalty size.
All
8.2
CURL.SetMultiOptionContentLengthPenaltySize
Sets content length penalty size.
All
8.2
CURL.SetMultiOptionMaxConcurrentStreams
Sets max connections per server.
All
10.0
CURL.SetMultiOptionMaxConnects
Sets max connects setting.
All
8.2
CURL.SetMultiOptionMaxHostConnections
Sets max host connections value.
All
8.2
CURL.SetMultiOptionMaxPipelineLength
Sets max pipeline length.
All
8.2
CURL.SetMultiOptionMaxTotalConnections
Sets max total connections value.
All
8.2
CURL.SetMultiOptionPipelining
Sets pipelining mode.
All
8.2
CURL.SetOptionAWSSigV4
Provides AWS V4 signature authentication on HTTP(S) header.
All
11.1
CURL.SetOptionAbstractUnixSocket
Sets path to an abstract Unix domain socket.
All
8.2
CURL.SetOptionAcceptEncoding
Enables automatic decompression of HTTP downloads.
All
7.5
CURL.SetOptionAcceptTimeoutMS
Sets time-out for accept.
All
8.2
CURL.SetOptionAddressScope
Sets the IPv6 scope_id.
All
2.5
CURL.SetOptionAppend
Whether to append file instead of overwriting it.
All
2.5
CURL.SetOptionAutoReferer
Set whether to set automatically the referrer.
All
2.5
CURL.SetOptionBufferSize
Sets the buffer size.
All
2.5
CURL.SetOptionCACacheTimeout
Sets the life-time for cached certificate stores.
All
13.0
CURL.SetOptionCAInfo
Sets a path to find certificate file.
All
2.5
CURL.SetOptionCAInfoBlob
Sets CAInfo as blob value.
All
11.3
CURL.SetOptionCAPATH
Sets the certificate directory.
All
2.5
CURL.SetOptionCRLF
Whether to convert newline characters.
All
2.5
CURL.SetOptionCRLFile
Sets the CRL file path.
All
2.5
CURL.SetOptionCertInfo
Whether to collect certificate information.
All
2.5
CURL.SetOptionConnectOnly
Connect only.
All
7.2
CURL.SetOptionConnectTimeoutMS
Sets the connection timeout in milliseconds.
All
2.5
CURL.SetOptionConnectTo
Sets the connect to list.
All
8.2
CURL.SetOptionConnectionTimeout
Sets the connection timeout in seconds.
All
2.5
CURL.SetOptionCookie
Sets the cookie for the current http transfer.
All
2.5
CURL.SetOptionCookieFile
Sets the cookie file location.
All
2.5
CURL.SetOptionCookieJar
Sets the cookie storage file.
All
2.5
CURL.SetOptionCookieList
Sets the cookie string.
All
2.5
CURL.SetOptionCookieSession
Set to 1 to mark this as a new cookie "session".
All
2.5
CURL.SetOptionCustomRequest
Sets a custom request.
All
2.5
CURL.SetOptionDNSCacheTimeout
Sets the DNS Cache Timeout in seconds.
All
2.5
CURL.SetOptionDNSInterface
Set the name of the network interface that the DNS resolver should bind to.
All
5.2
CURL.SetOptionDNSLocalIPv4
Set the local IPv4 address that the resolver should bind to.
All
5.2
CURL.SetOptionDNSLocalIPv6
Set the local IPv6 address that the resolver should bind to.
All
5.2
CURL.SetOptionDNSServers
Set the name servers to use for DNS resolution.
All
8.2
CURL.SetOptionDNSShuffleAddresses
Whether to shuffle DNS addresses.
All
8.2
CURL.SetOptionDOHSSLVerifyHost
Whether to verify the host name in the DOH (DNS-over-HTTPS) SSL certificate.
All
11.2
CURL.SetOptionDOHSSLVerifyPeer
Whether to verify the DOH SSL certificate.
All
11.2
CURL.SetOptionDOHSSLVerifyStatus
Whether to verify the DOH SSL certificate's status.
All
11.2
CURL.SetOptionDOHURL
Provides the DNS-over-HTTPS URL.
All
8.5
CURL.SetOptionDefaultProtocol
Set the protocol used when curl is given a URL without a protocol.
All
8.2
CURL.SetOptionDirListOnly
Whether to only query names in directory file listing.
All
2.5
CURL.SetOptionDisallowUserNameInURL
Disallow specifying username/login in URL.
All
8.3
CURL.SetOptionExpect100TimeoutMS
Sets Expect 100 timeout.
All
8.2
CURL.SetOptionFTPAccount
Sets the FTP account name.
All
2.5
CURL.SetOptionFTPAlternativeToUser
Whether to use alternative USER command.
All
2.5
CURL.SetOptionFTPCreateMissingDirs
Whether to create missing directories.
All
2.5
CURL.SetOptionFTPFileMethod
Which command to use for reaching a file.
All
2.5
CURL.SetOptionFTPPort
Sets the ports to use for FTP.
All
2.5
CURL.SetOptionFTPSSLAuth
Sets which SSL Authentication to use.
All
2.5
CURL.SetOptionFTPSSLCCC
If enabled, this option makes libcurl use CCC (Clear Command Channel).
All
2.5
CURL.SetOptionFTPSkipPasvIP
Whether to skip IP address for PASV.
All
2.5
CURL.SetOptionFTPUseEPRT
Whether to use EPRT command.
All
2.5
CURL.SetOptionFTPUseEPSV
Whether to use EPSV command.
All
2.5
CURL.SetOptionFTPUsePret
Whether to use PRET command.
All
2.5
CURL.SetOptionFailOnError
Whether to fail on http errors.
All
2.5
CURL.SetOptionFileOnlyMode
Disables collecting data for Result functions.
All
2.6
CURL.SetOptionFileTime
Whether to query file time.
All
2.5
CURL.SetOptionFollowLocation
Enables or disables following locations.
All
2.5
CURL.SetOptionForbidReuse
Whether to disallow reusing connections.
All
2.5
CURL.SetOptionFreshConnect
Sets whether to not reuse old connections.
All
2.5
CURL.SetOptionGSSAPIDelegation
Allow GSSAPI credential delegation.
All
8.2
CURL.SetOptionGet
Sets the transfer to be a HTTP Get.
All
2.5
CURL.SetOptionHAProxyProtocol
Whether to send an HAProxy PROXY protocol header.
All
8.2
CURL.SetOptionHTTP200Aliases
Sets list of aliases to be treated as valid HTTP 200 responses.
All
2.5
CURL.SetOptionHTTPAuth
Defines which HTTP authentication methods are used.
All
2.5
CURL.SetOptionHTTPContentDecoding
Sets how to act on content decoding.
All
2.5
CURL.SetOptionHTTPHeader
Sets the http header list.
All
2.5
CURL.SetOptionHTTPProxyTunnel
Set to 1 to make the library tunnel all operations through a given HTTP proxy.
All
2.5
CURL.SetOptionHTTPTransferDecoding
Sets how to act on transfer decoding.
All
2.5
CURL.SetOptionHTTPVersion
Sets which HTTP version is used.
All
2.5
CURL.SetOptionHappyEyeballsTimeOutMS
Sets the happy eyeballs timeout.
All
8.2
CURL.SetOptionHeader
Whether to include headers in output.
All
2.5
CURL.SetOptionHeaderOptions
Pass in a bitmask of "header options".
All
8.2
CURL.SetOptionIPResolve
Allows an application to select what kind of IP addresses to use when resolving host names.
All
2.5
CURL.SetOptionIgnoreContentLength
Whether to ignore the Content-Length header.
All
2.5
CURL.SetOptionInFileSize
Sets the file input size.
All
2.5
CURL.SetOptionInterface
This sets the interface name to use as outgoing network interface.
All
2.5
CURL.SetOptionIssuerCert
Sets the file path for the CA certificate in PEM format.
All
2.5
CURL.SetOptionIssuerCertBlob
Set issuer SSL certificate from memory blob.
All
10.3
CURL.SetOptionKRBLevel
Sets the kerberos security level for FTP.
All
2.5
CURL.SetOptionKeepSendingOnError
Sets whether to keep sending on error.
All
8.2
CURL.SetOptionKeyPassword
Sets the password for the SSL or SSH private key.
All
2.5
CURL.SetOptionLocalPort
This sets the local port number of the socket used for connection.
All
2.5
CURL.SetOptionLocalPortRange
This is the number of attempts curl should make to find a working local port number.
All
2.5
CURL.SetOptionLoginOptions
Sets login options string to use for the transfer.
All
5.4
CURL.SetOptionLowSpeedLimit
Sets the minimum required speed.
All
2.5
CURL.SetOptionLowSpeedTime
Sets how long a transfer is allowed to run with low speed.
All
2.5
CURL.SetOptionMailAuth
Sets the mail auth option.
All
2.9
CURL.SetOptionMailFrom
Sets the mail sender.
All
2.5
CURL.SetOptionMailRecipients
Sets the recipients list.
All
2.5
CURL.SetOptionMaxAgeConn
Sets the maximum connection age.
All
9.3
CURL.SetOptionMaxConnects
Sets the persistent connection cache size.
All
2.5
CURL.SetOptionMaxFileSize
Sets the maximum file size for download.
All
2.5
CURL.SetOptionMaxLifeTimeConnection
Sets maximum lifetime (since creation) allowed for reusing a connection.
All
12.4
CURL.SetOptionMaxRecvSpeed
Sets the maximum download speed.
All
2.5
CURL.SetOptionMaxRedirs
Sets the redirection limit.
All
2.5
CURL.SetOptionMaxSendSpeed
Sets the maximum sending speed.
All
2.5
CURL.SetOptionMimeOptions
Set MIME option flags.
All
12.4
CURL.SetOptionNETRCFile
Sets the full path to the netrc file.
All
2.5
CURL.SetOptionNetRC
Sets netrc file preference.
All
2.5
CURL.SetOptionNewDirectoryPerms
Sets the new directory permissions.
All
2.5
CURL.SetOptionNewFilePerms
Sets the new file permissions.
All
2.5
CURL.SetOptionNoBody
Whether to ignore the body of the download.
All
2.5
CURL.SetOptionNoProxy
Sets which hosts don't use a proxy.
All
2.5
CURL.SetOptionPassword
Sets the password for this transfer.
All
2.5
CURL.SetOptionPathAsIs
Set to pass path as it is and do not resolve dots.
All
8.2
CURL.SetOptionPinnedPublicKey
Set the public key in DER form used to validate the peer public key.
All
8.2
CURL.SetOptionPipeWait
Sets Wait/don't wait for pipe/mutex to clarify.
All
8.2
CURL.SetOptionPort
Sets the port number for the connection.
All
2.5
CURL.SetOptionPost
Sets transfer to be a HTTP Post.
All
2.5
CURL.SetOptionPostFields
Sets the post fields.
All
2.5
CURL.SetOptionPostQuote
Sets the list of FTP or SFTP commands to pass to the server after your FTP transfer request.
All
2.5
CURL.SetOptionPostRedir
Sets the redirect policy.
All
2.5
CURL.SetOptionPreProxy
Name of pre proxy to use.
All
8.2
CURL.SetOptionPreQuote
Sets the list of FTP commands to pass to the server after the transfer type is set.
All
2.5
CURL.SetOptionProtocolsString
The protocols to allow.
All
12.4
CURL.SetOptionProxy
Set HTTP proxy to use.
All
2.5
CURL.SetOptionProxyAuth
Sets which authentication methods are used.
All
2.5
CURL.SetOptionProxyCAInfo
The CApath or CAfile used to validate the proxy certificate.
All
8.2
CURL.SetOptionProxyCAInfoBlob
Sets CAInfo for proxy as blob value.
All
11.3
CURL.SetOptionProxyCAPath
Set the CApath directory used to validate the proxy certificate.
All
8.2
CURL.SetOptionProxyCRLFile
Sets CRL file for proxy.
All
8.2
CURL.SetOptionProxyHeader
Set list of headers used for proxy requests only.
All
8.2
CURL.SetOptionProxyIssuerCert
Sets the proxy issuer SSL certificate filename.
All
10.3
CURL.SetOptionProxyIssuerCertBlob
Set proxy issuer SSL certificate from memory blob.
All
10.3
CURL.SetOptionProxyKeyPassword
Sets password for the SSL private key for proxy.
All
8.2
CURL.SetOptionProxyPassword
The password to use for the transfer while connecting to Proxy.
All
2.5
CURL.SetOptionProxyPinnedPublicKey
Sets pinned public key for proxy.
All
8.2
CURL.SetOptionProxyPort
The proxy port to connect to unless it is specified in the proxy string with CURL.SetOptionProxy.
All
2.5
CURL.SetOptionProxySSLCert
Sets name of the file keeping your private SSL-certificate for proxy.
All
8.2
CURL.SetOptionProxySSLCertBlob
Sets private key for proxy cert from memory blob.
All
10.3
CURL.SetOptionProxySSLCertType
Sets type of the file keeping your SSL-certificate for proxy.
All
8.2
CURL.SetOptionProxySSLCipherList
Specify which SSL ciphers to use for proxy.
All
8.2
CURL.SetOptionProxySSLKey
Sets name of the file keeping your private SSL-key for proxy.
All
8.2
CURL.SetOptionProxySSLKeyBlob
Set private key for proxy cert from memory blob.
All
10.3
CURL.SetOptionProxySSLKeyType
Sets type of the file keeping your private SSL-key for proxy.
All
8.2
CURL.SetOptionProxySSLOptions
Enable/disable specific SSL features with a bitmask for proxy.
All
8.2
CURL.SetOptionProxySSLVerifyHost
Enable SSL Host verification.
All
8.2
CURL.SetOptionProxySSLVerifyPeer
Set if we should verify the proxy in ssl handshake.
All
8.2
CURL.SetOptionProxySSLVersion
Sets which version of SSL/TLS to attempt to use for proxy.
All
8.2
CURL.SetOptionProxyServiceName
Sets Proxy Service Name.
All
8.2
CURL.SetOptionProxyTLS13Ciphers
Specify which TLS 1.3 ciphers suites to use for proxy.
All
8.3
CURL.SetOptionProxyTLSAuthPassword
Set a password for authenticated TLS for proxy.
All
8.2
CURL.SetOptionProxyTLSAuthType
Set authentication type for authenticated TLS for proxy.
All
8.2
CURL.SetOptionProxyTLSAuthUsername
Set a username for authenticated TLS for proxy.
All
8.2
CURL.SetOptionProxyTransferMode
Whether to pass transfer mode to proxy.
All
2.5
CURL.SetOptionProxyType
Sets the type of the proxy.
All
2.5
CURL.SetOptionProxyUsername
The user name to use for the transfer while connecting to Proxy.
All
2.5
CURL.SetOptionQuickExit
Whether to allow to exit quickly.
All
13.0
CURL.SetOptionQuote
Sets the list of FTP or SFTP commands to pass to the server prior to your FTP request.
All
2.5
CURL.SetOptionRTSPClientCSEQ
Manually initialize the client RTSP CSeq for this handle.
All
8.2
CURL.SetOptionRTSPRequest
RTSP request method (OPTIONS, SETUP, PLAY, etc...)
All
8.2
CURL.SetOptionRTSPServerCSEQ
Manually initialize the server RTSP CSeq for this handle.
All
8.2
CURL.SetOptionRTSPSessionID
The RTSP session identifier.
All
8.2
CURL.SetOptionRTSPStreamURI
The RTSP stream URI.
All
8.2
CURL.SetOptionRTSPTransport
The Transport: header to use in RTSP requests.
All
8.2
CURL.SetOptionRange
Sets the range.
All
2.5
CURL.SetOptionRedirProtocolsString
Sets the protocols allowed to redirect to.
All
12.4
CURL.SetOptionReferer
Sets the referrer.
All
2.5
CURL.SetOptionRequestTarget
Set the request target, instead of extracted from the URL.
All
8.2
CURL.SetOptionResolve
Sets resolve list.
All
8.2
CURL.SetOptionResumeFrom
Sets the resume from offset.
All
2.5
CURL.SetOptionSASLAuthZID
Sets the authorisation identity (identity to act as).
All
9.4
CURL.SetOptionSASLIR
Enable/disable SASL initial response.
All
8.2
CURL.SetOptionSSHAuthTypes
Sets the SSL authentication types.
All
2.5
CURL.SetOptionSSHCompression
Enable/disable SSH compression.
All
8.2
CURL.SetOptionSSHHostPublicKeyMD5
Sets MD5 hash for public key.
All
2.5
CURL.SetOptionSSHHostPublicKeySHA256
Sets the SHA256 hash of SSH server public key.
All
12.4
CURL.SetOptionSSHKnownHosts
Sets the file path of the known_host file to use.
All
2.5
CURL.SetOptionSSHPrivateKeyfile
Sets the file path for your private key.
All
2.5
CURL.SetOptionSSHPublicKeyfile
Sets the file path for the public key file.
All
2.5
CURL.SetOptionSSLCert
Sets the file path for the certificate.
All
2.5
CURL.SetOptionSSLCertBlob
Set SSL client certificate from memory blob.
All
10.3
CURL.SetOptionSSLCertType
Sets the format of the certificate.
All
2.5
CURL.SetOptionSSLCipherList
Sets the list of ciphers to use for the SSL connection.
All
2.5
CURL.SetOptionSSLEnableALPN
Enable/disable TLS ALPN extension.
All
8.2
CURL.SetOptionSSLFalseStart
Set if we should enable TLS false start.
All
8.2
CURL.SetOptionSSLKey
Sets the file path for the private key.
All
2.5
CURL.SetOptionSSLKeyBlob
Set private key for client cert from memory blob.
All
10.3
CURL.SetOptionSSLKeyType
Sets the format of the private key.
All
2.5
CURL.SetOptionSSLOptions
Enable/disable specific SSL features with a bitmask.
All
8.2
CURL.SetOptionSSLSessionIDCache
Controls SSL session-ID caching.
All
2.5
CURL.SetOptionSSLVerifyHost
Sets whether to verify host.
All
2.5
CURL.SetOptionSSLVerifyPeer
Whether to verify the peer.
All
2.5
CURL.SetOptionSSLVerifyStatus
Set if we should verify the certificate status.
All
8.2
CURL.SetOptionSSLVersion
Sets which version of SSL/TLS to attempt to use.
All
2.5
CURL.SetOptionServerResponseTimeout
Sets the timeout for FTP responses.
All
2.5
CURL.SetOptionServiceName
Sets Service Name.
All
8.2
CURL.SetOptionSocks5Auth
Sets allowed authentication methods for SOCKS 5 proxies
All
8.2
CURL.SetOptionSocks5GSSAPINec
Sets how to run the protection mode negotiation.
All
2.5
CURL.SetOptionStreamDepends
Sets stream dependency on another CURL session.
All
8.2
CURL.SetOptionStreamDependsE
Sets exclusive stream dependency on another CURL session.
All
8.2
CURL.SetOptionStreamWeight
Set stream weight, 1 - 256.
All
8.2
CURL.SetOptionSuppressConnectHeaders
Suppress proxy CONNECT response headers from header data.
All
8.2
CURL.SetOptionTCPFastOpen
Set TCP Fast Open.
All
8.2
CURL.SetOptionTCPKeepAlive
Enable TCP keep-alive probing.
All
5.2
CURL.SetOptionTCPKeepIdle
Set TCP keep-alive idle time wait.
All
5.2
CURL.SetOptionTCPKeepInterval
Set TCP keep-alive interval.
All
5.2
CURL.SetOptionTCPNoDelay
Sets the TCP delay option.
All
2.5
CURL.SetOptionTFTPBlockSize
Specify block size to use for TFTP data transmission.
All
2.5
CURL.SetOptionTFTPNoOptions
Sets to whether not send any tftp option requests to the server.
All
8.2
CURL.SetOptionTLS13Ciphers
Specify which TLS 1.3 ciphers suites to use.
All
8.3
CURL.SetOptionTLSAuthPassword
Sets the TSL authentication password.
All
3.5
CURL.SetOptionTLSAuthType
Sets the TLS authentication type.
All
3.5
CURL.SetOptionTLSAuthUsername
Sets the TSL authentication user name.
All
3.5
CURL.SetOptionTelnetOptions
Sets a list of telnet options.
All
2.5
CURL.SetOptionTimeCondition
Sets the time
All
2.5
CURL.SetOptionTimeOut
Sets the maximum time in seconds that you allow the transfer operation to take.
All
2.5
CURL.SetOptionTimeValue
Sets the time value.
All
2.5
CURL.SetOptionTimeoutMS
Sets the transfer timeout in milliseconds.
All
2.5
CURL.SetOptionTransferEncoding
Ask for HTTP Transfer Encoding.
All
5.2
CURL.SetOptionTransferText
Whether to use ASCII mode for FTP transfer.
All
2.5
CURL.SetOptionURL
Sets the actual URL to deal with.
All
2.5
CURL.SetOptionUnixSocketPath
Set path to Unix domain socket.
All
8.2
CURL.SetOptionUnrestrictedAuth
Controls whether authentication is reused.
All
2.5
CURL.SetOptionUpkeepIntervalMS
Connection upkeep interval.
All
8.5
CURL.SetOptionUpload
Sets this transfer to be an upload.
All
2.5
CURL.SetOptionUploadBufferSize
Set preferred upload buffer size.
All
8.5
CURL.SetOptionUseSSL
Sets whether to use SSL for next transfers.
All
2.5
CURL.SetOptionUserAgent
The user agent text string.
All
2.5
CURL.SetOptionUserName
Sets the user name string for the transfer.
All
2.5
CURL.SetOptionVerbose
Whether to store log messages.
All
2.5
CURL.SetOptionWebSocketOptions
Sets WebSocket behaviour options.
All
13.0
CURL.SetOptionWildCardMatch
Enable wildcard matching.
All
5.2
CURL.SetOptionXOAuth2Bearer
The XOAUTH2 bearer token.
All
8.2
CURL.SetProgressEvaluate
Sets expression to be run when transfer makes progress.
All
6.1
CURL.SetSucceededEvaluate   New in 14.0
Sets expression to be run when transfer succeeded.
All
14.0
CURL.SetSucceededScript   New in 14.0
Sets which script to call when a transfer succeeded.
All
14.0
CURL.SetTag
Sets the tag value.
All
5.2
CURL.SetupAWS
Setup CURL to transfer to Amazon Webservices.
All
7.2
CURL.SetupOAuth
Setups an OAuth signed transfer.
All
8.3
CURL.Upkeep
Perform any connection upkeep checks.
All
8.5
CURL.UseSystemCertificates
Read certificate from system and installs them in CURL session,.
Mac/Win
7.2
CURL.Version
Queries curl version string.
All
2.5
CURL.WebSocketReceive
Receive WebSocket data.
All
13.0
CURL.WebSocketSend
Send the specific message fragment over an established WebSocket connection.
All
13.0
ClearErrors
Clears error counter.
All
12.2
ClearRegistration
Clears registration details stored with StoreRegistration.
All
3.0
CompileDate
Returns the date the plug-in was compiled.
All
1.0
CompileTime
The time of day that the plug-in was compiled.
All
1.0
Container.Compress
Compresses a container value.
All
5.3
Container.DecodeFromBase64
Decodes data from base64 text into a container value.
All
4.4
Container.DecodeFromHex
Decodes data from hex text into a container value.
All
6.5
Container.Decompress
Decompresses a container value.
All
5.3
Container.Deserialize
Restores a serialized container value.
All
5.2
Container.Export
Writes selected data content from a container to a file path.
All
1.6
Container.ExtractStream
Extracts a single frame and returns as new container value.
All
4.3
Container.GetBase64
Returns the base 64 encoded value of the container.
All
1.4
Container.GetCount
Counts the number of types in a container field.
All
1.4
Container.GetDataURL
Returns the complete Data url for an image stored in a container field.
All
1.4
Container.GetHeight
Returns the Height of the image in pixels.
All
1.3
Container.GetHex
Returns the hex encoded value of the container.
All
6.5
Container.GetName
Queries the path list from a container.
All
3.0
Container.GetResolution
Queries the DPI settings stored in a container.
All
4.2
Container.GetSize
Returns the size of the container.
All
1.4
Container.GetText
Returns the text value of the container data.
All
7.2
Container.GetTotalSize
Returns the size of the whole container in bytes.
All
1.3
Container.GetType
Returns the type at the given index (zero based).
All
1.4
Container.GetTypeSize
Returns the size of the indicated object type in container field.
All
1.3
Container.GetTypes
Returns the list of objects in the container field.
All
1.3
Container.GetWidth
Returns the Width of the image in pixels.
All
1.3
Container.IdentifyData   New in 14.0
Checks file type from the data.
All
14.0
Container.IsCompressed
Queries whether container is compressed.
All
7.5
Container.ReadArchive
Reads an archived container.
All
4.4
Container.ReadFile
Reads a file with the given path.
All
6.4
Container.ReadImage
Reads and convert image.
Mac/Win/iOS
8.4
Container.ReadImageFile
Reads and convert image file.
Mac/Win/iOS
11.2
Container.Remove
Removes a stream from container value.
All
3.3
Container.Rename
Renames the file path in a container value.
All
3.0
Container.RenameStream
Renames a stream in a container.
All
4.3
Container.Serialize
Serialized a container as a text.
All
5.2
Container.WriteArchive
Writes an archive with container value.
All
4.4
Container.WriteFile
Writes a file with the given container.
All
6.4
CoreImage.Detect
Detects core image features.
Mac/iOS
7.4
CoreML.Add2DArrayParameter
Adds a 2D array parameter.
Mac/iOS
10.2
CoreML.AddArrayParameter
Adds an array parameter.
Mac/iOS
7.4
CoreML.AddDoubleParameter
Adds a double parameter.
Mac/iOS
7.4
CoreML.AddImageParameter
Adds an image parameter.
Mac/iOS
7.4
CoreML.AddIntegerParameter
Adds an integer parameter.
Mac/iOS
7.4
CoreML.AddTextParameter
Adds a text parameter.
Mac/iOS
7.4
CoreML.AddUndefinedParameter
Adds an undefined parameter.
Mac/iOS
7.4
CoreML.Available
Whether CoreML is available.
Mac/iOS
7.4
CoreML.Clear
Clears all parameters.
Mac/iOS
7.4
CoreML.CompileModel
Compiles a model file.
Mac/iOS
7.4
CoreML.Description
Queries the description of the model.
Mac/iOS
7.4
CoreML.GetUsesCPUOnly
Queries whether to use CPU only.
Mac/iOS
7.4
CoreML.List
Lists all IDs of CoreML objects.
Mac/iOS
13.0
CoreML.OpenModel
Opens a compiled model file.
Mac/iOS
7.4
CoreML.PredictionFromFeatures
Runs model with set parameters.
Mac/iOS
7.4
CoreML.Release
Releases a model.
Mac/iOS
7.4
CoreML.ReleaseAll
Releases all models.
Mac/iOS
10.5
CoreML.ResultImage
Queries result image.
Mac/iOS
7.4
CoreML.SetUsesCPUOnly
Sets whether to use CPU only.
Mac/iOS
7.4
CoreML.Update
Updates a model.
Mac/iOS
10.0
DNSLookup.Address
Queries the address.
All
6.0
DNSLookup.AddressCount
Queries number of addresses.
All
6.0
DNSLookup.Alias
Queries the alias.
All
6.0
DNSLookup.AliasCount
Queries number of aliases.
All
6.0
DNSLookup.List
Lists all IDs of DNSLookup objects.
All
13.0
DNSLookup.LookupHostByAddress
Queries the domain name for an IP.
All
6.0
DNSLookup.LookupHostByName
Queries the IP for domain.
All
6.0
DNSLookup.Name
Queries the name found.
All
6.0
DNSLookup.Release
Releases a DNS Lookup reference.
All
6.0
DNSLookup.ReleaseAll
Releases all DNS Lookup references.
All
10.5
Dictionary.AddDictionary
Adds entries from other dictionary to current one.
All
11.1
Dictionary.AddSQL
Adds values to a dictionary via SQL.
All
5.1
Dictionary.AddSQLRecord
Adds values from a record to dictionary via SQL.
All
7.4
Dictionary.AddSQLRecords
Adds values from a record to dictionary via SQL.
All
7.4
Dictionary.Clear
Clears the dictionary content.
All
5.0
Dictionary.Clone
Creates a copy of the dictionary.
All
6.1
Dictionary.Count
Returns number of keys in the dictionary.
All
5.0
Dictionary.Create
Creates a new dictionary.
All
5.0
Dictionary.CreateNamed
Creates a new dictionary with desired key.
All
8.1
Dictionary.Deserialize
Restores a serialized dictionary.
All
5.2
Dictionary.FromJSON
Creates dictionary from JSON.
All
11.1
Dictionary.HasKey
Checks if the given key exists in dictionary.
All
5.0
Dictionary.KeyAtIndex
Returns key with given index.
All
5.0
Dictionary.Keys
Returns list with all keys.
All
5.0
Dictionary.KeysWithPostfix
Returns list with all keys matching postfix.
All
11.4
Dictionary.KeysWithPrefix
Returns list with all keys matching prefix.
All
11.4
Dictionary.List
Returns list of all dictionary IDs.
All
5.2
Dictionary.Lookup
Looks up value for the key.
All
12.1
Dictionary.Release
Releases dictionary and all memory used.
All
5.0
Dictionary.ReleaseAll
Releases all dictionaries.
All
10.5
Dictionary.RemoveKey
Removes value with given key.
All
5.0
Dictionary.Serialize
Serialized a dictionary as a text.
All
5.2
Dictionary.SetList
Fills dictionary with keys and values form a list.
All
6.2
Dictionary.SetQuickList
Fills dictionary with keys and values form a quick list.
All
7.1
Dictionary.SetValueForKey
Stores value for given key.
All
5.0
Dictionary.SetVariables
Creates variables with given keys and values from dictionary.
All
5.1
Dictionary.ToJSON
Returns JSON representation of dictionary for data exchange.
All
6.1
Dictionary.ToMatrix
Converts dictionary to a matrix.
All
13.2
Dictionary.ToText
Returns text representation of dictionary for data exchange.
All
6.1
Dictionary.ToXML
Returns XML representation of dictionary for data exchange.
All
6.1
Dictionary.ValueForKey
Queries value for the key.
All
5.0
Dictionary.ValueTypeForKey
Queries data type of the value for the key.
All
5.1
Dictionary.Values
Returns list with all values as text.
All
5.1
DirectoryWatcher.AddDirectory
Adds a directory to watch.
Win only
7.1
DirectoryWatcher.ChangeCount
Queries the change count.
Win only
7.1
DirectoryWatcher.Create
Creates a new directory watcher.
Win only
7.1
DirectoryWatcher.NextChange
Queries next change in queue.
Win only
7.1
DirectoryWatcher.Release
Releases directory watcher.
Win only
7.1
DirectoryWatcher.ReleaseAll
Releases all directory watchers.
Win only
7.4
DirectoryWatcher.TotalChangeCount
Queries the total number of changes seen.
Win only
12.4
DynaPDF.ActivateAltFontList
Activates or deactivates an alternate font list that was created by DynaPDF.CreateAltFontList.
All
12.0
DynaPDF.AddActionToObj
Adds an action to a PDF object.
All
6.4
DynaPDF.AddAnnotToPage
Adds an annotation to a page.
All
7.0
DynaPDF.AddBookmark
Adds a bookmark to the global outline tree of the document.
All
4.0
DynaPDF.AddBookmarkEx
Adds a bookmark to the global outline tree of the document.
All
4.0
DynaPDF.AddButtonImage
Add/Set a form field button image.
All
10.2
DynaPDF.AddButtonImageEx2
Add/Set a form field button image.
All
11.5
DynaPDF.AddContinueText
Prints a single text line and moves the text cursor to the next line.
All
3.1
DynaPDF.AddDPartNode
Creates a DPart Node.
All
13.3
DynaPDF.AddDeviceNProcessColorants
Adds DeviceN process colorants.
All
7.4
DynaPDF.AddDeviceNSeparations
Adds DeviceN separations.
All
7.4
DynaPDF.AddFieldToFormAction
Adds a field to a form action.
All
13.3
DynaPDF.AddFontSearchPath
Adds a search path to the list of available font search paths.
All
4.1
DynaPDF.AddJavaScript
Adds a global JavaScript to the PDF file.
All
13.2
DynaPDF.AddOutputIntent
Represents the destination color space for which a PDF file was created.
All
4.4
DynaPDF.AddOutputIntentEx
Adds an ICC profile to the PDF file like AddOutputIntent but accepts a file as a container.
All
4.4
DynaPDF.AddValToChoiceField
Adds a value to a choice field.
All
4.2
DynaPDF.AllowPageBreak
Defines how to handle page breaks.
All
4.2
DynaPDF.AppendImagePage
Adds new page to the PDF with given image.
All
6.3
DynaPDF.AppendImagePages
Adds new pages to the PDF with given image paths.
All
6.3
DynaPDF.AppendPage
This function appends an empty page to the document.
All
3.1
DynaPDF.ApplyShading
Applies a shading.
All
10.2
DynaPDF.AssociateEmbFile
Associates an embedded file with a PDF object.
All
6.0
DynaPDF.AttachFile
Attaches a file to the document.
All
6.0
DynaPDF.AttachFileContainer
Attaches a data from container to the document.
All
6.0
DynaPDF.AttachFileText
Attaches a file to the document.
All
6.0
DynaPDF.BeginContinueText
This function prepares the output of multiple text lines with DynaPDF.AddContinueText.
All
3.1
DynaPDF.BeginLayer
The function opens a layer in the current open page or template.
All
5.0
DynaPDF.BeginPattern
This function creates a new tiling pattern.
All
5.0
DynaPDF.BeginTemplate
The function creates a template and opens it so that arbitrary contents can be drawn into it.
All
5.0
DynaPDF.Bezier123
Draws a bezier path.
All
4.0
DynaPDF.Bezier13
This function paints a Bézier curve with one control point.
All
4.0
DynaPDF.Bezier23
The third supported Bézier curve type paints also a curve with one control point.
All
4.0
DynaPDF.CMYK
Calculates color value for CMYK.
All
4.0
DynaPDF.ChangeAnnotName
Changes or deletes the optional unique name of an annotation.
All
5.0
DynaPDF.ChangeAnnotPos
Changes the position and size of an annotation.
All
5.0
DynaPDF.ChangeBookmark
Changes an existing bookmark.
All
4.0
DynaPDF.ChangeFont
This function changes or sets the font to the one of the parameter FontHandle.
All
3.1
DynaPDF.ChangeFontEx
Changes or sets the font to the one of the parameter Handle.
All
11.2
DynaPDF.ChangeFontSize
This function changes the font size of the current font.
All
3.1
DynaPDF.ChangeFontStyle
This function changes the style of the current font.
All
3.1
DynaPDF.ChangeFontStyleEx
The function changes the font style of a font like DynaPDF.ChangeFontStyle but it accepts also font styles like 2 (bold) or 1 (italic).
All
3.1
DynaPDF.ChangeJavaScript
Replaces a global JavaScript with a new one.
All
13.2
DynaPDF.ChangeJavaScriptAction
Replaces the script of a JavaScript action with a new one.
All
13.2
DynaPDF.ChangeJavaScriptName
Changes the name of a global JavaScript.
All
13.2
DynaPDF.ChangeLinkAnnot
Changes the link of a file link or web link annotation.
All
5.0
DynaPDF.ChangeNamedDest
Changes the name of a named destination.
All
13.1
DynaPDF.ChangeOCGName
Changes the name of an Optional Content Group (OCG).
All
11.3
DynaPDF.ChangeSeparationColor
Changes the color of a separation color space.
All
7.2
DynaPDF.CheckConformance
Converts a PDF file to a specific PDF standard according to the parameter Type.
All
4.4
DynaPDF.CheckFieldNames
Checks all currently defined interactive form fields for invalid duplicate field names.
All
8.5
DynaPDF.CircleAnnot
Draws a circle annotation on the current open page.
All
5.0
DynaPDF.Clear
Starts a new PDF in memory or at the given path.
All
3.0
DynaPDF.ClipPath
This function marks the current path as clipping path.
All
3.2
DynaPDF.CloseImportFile
Closes the current import PDF.
All
3.0
DynaPDF.ClosePath
Closes current path.
All
3.2
DynaPDF.CloseTag
Closes the current open tag
All
13.2
DynaPDF.ConvertColors
Converts colors to gray.
All
9.2
DynaPDF.ConvertStyledText
Converts styled text to formatted text.
All
6.5
DynaPDF.CreateAltFontList
Creates an alternate font list, that can be filled with data by DynaPDF.SetAltFonts().
All
12.0
DynaPDF.CreateAnnotAP
Creates a user defined appearance stream for an annotation.
All
13.3
DynaPDF.CreateAxialShading
Creates an axial sharing.
All
10.2
DynaPDF.CreateButton
Creates a push button.
All
6.4
DynaPDF.CreateCheckBox
This function creates a check box.
All
4.1
DynaPDF.CreateComboBox
Creates a combo box.
All
4.2
DynaPDF.CreateDPartRoot
Creates the DPartRoot dictionary.
All
13.3
DynaPDF.CreateDeviceNColorSpace
Creates a DeviceN color space.
All
7.4
DynaPDF.CreateGeospatialMeasure
Creates a geospatial measure dictionary.
All
13.5
DynaPDF.CreateGoToAction
Creates a go-to action.
All
10.0
DynaPDF.CreateGoToActionEx
Creates a go-to action which uses a named destination to open the target page.
All
10.0
DynaPDF.CreateGoToEAction   New in 14.1
Creates an embedded GoTo action.
All
14.1
DynaPDF.CreateGoToRAction
Creates a go-to-remote action.
All
10.0
DynaPDF.CreateGoToRActionEx
Creates a go-to-remote action.
All
10.0
DynaPDF.CreateGroupField
Creates a group field. A group field is a simple array of fields which can be used to separate fields into several groups.
All
4.2
DynaPDF.CreateICCBasedColorSpace
Creates an ICC-based color space.
All
13.0
DynaPDF.CreateICCBasedColorSpaceContainer
Creates an ICC-based color space based on a container.
All
13.0
DynaPDF.CreateJSAction
Creates a JavaScript action.
All
6.4
DynaPDF.CreateListBox
This function creates a list box.
All
4.2
DynaPDF.CreateNamedDest
The function creates a named destination that can be accessed from external PDF files.
All
4.4
DynaPDF.CreateOCG
Creates an Optional Content Group (OCG) also called layer.
All
11.5
DynaPDF.CreateRadialShading
Creates radial sharing.
All
10.2
DynaPDF.CreateRadioButton
Creates a radio button field.
All
4.2
DynaPDF.CreateResetAction
Creates a reset action.
All
13.3
DynaPDF.CreateSeparationCS
Creates a Separation color space.
All
7.4
DynaPDF.CreateSigField
Creates an empty signature field which can be used to digitally sign the PDF file.
All
4.2
DynaPDF.CreateSigFieldAP
Creates a signature appearance template in the exact size of the base signature field.
All
4.2
DynaPDF.CreateStructureTree
Creates a global structure tree that is required to create Tagged PDF files.
All
4.4
DynaPDF.CreateStructureTreeEx
Creates the global structure tree as described at CreateStructureTree.
All
13.1
DynaPDF.CreateSubmitAction
Creates a submit action.
All
13.3
DynaPDF.CreateTextField
This function creates a text field.
All
4.1
DynaPDF.CreateXFAStream
Creates an XFA stream and adds it to the global XFA resource array.
All
9.5
DynaPDF.DeleteAcroForm
The function deletes a maybe existing Interactive Form.
All
5.0
DynaPDF.DeleteActionFromObjEx
This function deletes an action from a PDF object.
All
5.0
DynaPDF.DeleteAltFontList
Deletes an alternate font list that was created by DynaPDF.CreateAltFontList.
All
12.0
DynaPDF.DeleteAnnotation
Deletes an annotation.
All
5.0
DynaPDF.DeleteBookmark
Deletes a bookmark.
All
4.0
DynaPDF.DeleteDPartNode
The deletes a dpart node.
All
13.4
DynaPDF.DeleteEmbeddedFile
The function deletes an embedded file.
All
5.0
DynaPDF.DeleteField
This function deletes an interactive form field.
All
5.0
DynaPDF.DeleteFieldEx
Deletes a field by name.
All
5.0
DynaPDF.DeleteJavaScripts
Deletes all global JavaScripts.
All
5.0
DynaPDF.DeleteNamedDest
Deletes a named destination or all.
All
11.3
DynaPDF.DeletePage
Deletes a given page in the current working PDF.
All
3.4
DynaPDF.DeletePageLabels
Deletes all page labels contained in the current open document, if any.
All
5.0
DynaPDF.DeleteSeparationInfo
Deletes the separation of the current open page.
All
5.0
DynaPDF.DeleteTemplate
Deletes a template.
All
5.0
DynaPDF.DeleteTemplateEx
Deletes a template by using an index instead of a template handle.
All
5.0
DynaPDF.DeleteWatermark
Delete a watermark template.
All
13.3
DynaPDF.DeleteXFAForm
Deletes a maybe existing XFA form (XML based form) if any.
All
5.0
DynaPDF.DrawArc
This function draws an arc by using a start and end angle.
All
3.1
DynaPDF.DrawArcEx
This function draws an elliptical arc.
All
3.1
DynaPDF.DrawChord
This function draws an elliptical chord (a region bounded by the intersection of an ellipse and a line segment, called a secant).
All
3.1
DynaPDF.DrawCircle
This function draws a circle.
All
3.1
DynaPDF.DrawNGon
Draws a n-gon.
All
10.5
DynaPDF.DrawPie
The function draws a pie-shaped wedge bounded by the intersection of an ellipse and two angles.
All
3.1
DynaPDF.EditPage
This function prepares a page for editing.
All
3.1
DynaPDF.EditTemplate
Prepares a template for editing.
All
5.1
DynaPDF.EditTemplate2
Opens a template for editing.
All
5.1
DynaPDF.Ellipse
Draws an ellipse.
All
5.0
DynaPDF.EnableEncryption
Enables encryption for next save command.
All
3.4
DynaPDF.EndLayer
Closes a layer that was opened by DynaPDF.BeginLayer.
All
5.0
DynaPDF.EndPage
This function closes an open page that was opened by AppendPage or EditPage.
All
3.1
DynaPDF.EndPattern
Closes an open pattern.
All
5.0
DynaPDF.EndTemplate
This function closes an open template.
All
7.0
DynaPDF.ExchangeBookmarks
This function exchanges two bookmarks.
All
4.0
DynaPDF.ExchangePages
The function exchanges two pages.
All
4.0
DynaPDF.ExtractDocumentText
Extracts the text of all pages.
All
6.0
DynaPDF.ExtractText
Extracts the text of the page PageNum.
All
8.0
DynaPDF.FileAttachAnnot
Inserts a file attachment annotation on the current open page.
All
5.0
DynaPDF.FileAttachAnnotEx
Inserts a file attachment annotation on the current open page.
All
8.0
DynaPDF.FindBookmark
Searches for a bookmark in the document outline tree.
All
4.0
DynaPDF.FindEmbeddedFile
Searches for the embedded file Name and returns the handle of it when it can be found.
All
6.3
DynaPDF.FindField
This function searches for an interactive form field by using the fully qualified field name.
All
4.0
DynaPDF.FindLinkAnnot
Searches for a file link or web link annotation.
All
5.0
DynaPDF.FindNextBookmark
Searches the next bookmark.
All
4.0
DynaPDF.FindPattern
Searches for a text.
All
3.4
DynaPDF.FindText
Searches a text and returns position details.
All
4.1
DynaPDF.FlattenAnnotOrField
Draws an annotation or form field on the current open page.
All
10.0
DynaPDF.FlattenAnnots
Flatten annotations.
All
4.2
DynaPDF.FlattenForm
Flatten forms.
All
4.2
DynaPDF.FlushPages
The function writes the pages in memory to the PDF file.
All
3.3
DynaPDF.FlushPagesEx
Writes the pages in memory to the PDF file exactly like DynaPDF.FlushPages.
All
10.3
DynaPDF.FontInfo
Retrieves the most important properties of a font.
All
5.1
DynaPDF.FreeTextAnnot
Creates a Free Text annotation.
All
5.0
DynaPDF.GeneratePreview
Adds a preview picture to a PDF container.
All
4.0
DynaPDF.GetActionCount
Returns the number of actions contained in a document.
All
13.2
DynaPDF.GetActionsAsJSON   New in 14.1
Queries all action as JSON array.
All
14.1
DynaPDF.GetAnnotCount
Returns the number of annotations currently used in the document.
All
5.0
DynaPDF.GetAnnotFlags
Returns the default flags used for newly created annotations.
All
5.0
DynaPDF.GetAnnotType
Returns the type of a specific annotation.
All
5.0
DynaPDF.GetAnnotation
Queries details about an annotation.
All
5.0
DynaPDF.GetAnnotationAsJSON
Queries one annotation as JSON object.
All
10.5
DynaPDF.GetAnnotationsAsJSON
Queries all annotations as JSON array.
All
10.5
DynaPDF.GetAscent
Returns the ascender of the active font.
All
5.0
DynaPDF.GetBBox
Queries bound box values of current page.
All
6.4
DynaPDF.GetBookmark
Returns the properties of a bookmark.
All
4.0
DynaPDF.GetBookmarkCount
Returns the number of bookmarks defined in the document.
All
4.0
DynaPDF.GetBookmarksAsJSON
Queries all bookmarks as JSON array.
All
10.5
DynaPDF.GetBorderStyle
Returns the global border style which is used for newly created Interactive Form fields.
All
4.2
DynaPDF.GetCMapCount
Returns the number of available CMap files.
All
5.0
DynaPDF.GetCharacterSpacing
Returns the current character spacing.
All
4.2
DynaPDF.GetCheckBoxChar
Returns the character used for newly created check boxes.
All
4.4
DynaPDF.GetCheckBoxCharEx
Returns character index of the font ZapfDingbats that is used to display the on state of the check box.
All
4.4
DynaPDF.GetCheckBoxDefState
Returns the default state of a check box.
All
4.4
DynaPDF.GetColorSpace
The function returns the active color space.
All
3.3
DynaPDF.GetColorSpaceAsJSON
Queries one color space as JSON object.
All
10.5
DynaPDF.GetColorSpaceCount
Returns the number of color space objects which are used in the current document.
All
5.0
DynaPDF.GetColorSpaceInfo
Queries details on a colorspace.
All
6.4
DynaPDF.GetColorSpacesAsJSON
Queries all color spaces as JSON array.
All
10.5
DynaPDF.GetCompressionFilter
The function returns the standard compression filter for images.
All
3.1
DynaPDF.GetCompressionLevel
Returns the active compression level.
All
4.0
DynaPDF.GetContent
Queries content stream of the currently open page or template.
All
7.0
DynaPDF.GetDefaultBarcodeParameters
Queries default barcode parameters.
All
10.5
DynaPDF.GetDescent
Returns the descender of the active font.
All
10.5
DynaPDF.GetDocInfo
The function retrieves a document info entry as text from current PDF.
All
3.0
DynaPDF.GetDocInfoAsJSON
Queries all document information as JSON array.
All
10.5
DynaPDF.GetDocInfoCount
Returns the number of document info entries defined in the document.
All
5.0
DynaPDF.GetDocUsesTransparency
Checks whether this document uses transparency.
All
8.2
DynaPDF.GetDrawDirection
The function returns the actual draw direction for closed vector graphics such as rectangles, circles, ellipses and so on.
All
3.2
DynaPDF.GetDynaPDFVersion
Returns the version string of DynaPDF library.
All
4.2
DynaPDF.GetEmbeddedFile
Retrieves the details of an embedded file.
All
4.3
DynaPDF.GetEmbeddedFileAsContainer
Returns an embedded file as a container.
All
4.3
DynaPDF.GetEmbeddedFileAsJSON
Queries one embedded file as JSON object.
All
10.5
DynaPDF.GetEmbeddedFileCount
Returns the number of embedded files available in the PDF file.
All
4.3
DynaPDF.GetEmbeddedFilesAsJSON
Queries all embedded files as JSON array.
All
10.5
DynaPDF.GetFTextHeight
The function measures the height of a formatted text block.
All
3.1
DynaPDF.GetFTextHeightEx
The function measures the height of a formatted text block.
All
3.1
DynaPDF.GetField
Returns the most important properties of a field.
All
4.0
DynaPDF.GetFieldAsJSON
Queries one form fields as JSON object.
All
10.5
DynaPDF.GetFieldBackColor
The function returns the default background color used for newly created interactive form fields.
All
4.0
DynaPDF.GetFieldBorderColor
Returns the default border color used for newly created interactive form fields.
All
4.0
DynaPDF.GetFieldBorderStyle
Returns the border style of a specific form field.
All
4.0
DynaPDF.GetFieldBorderWidth
Returns the line width of the border of a field.
All
4.0
DynaPDF.GetFieldChoiceValue
Retrieves a choice value of a combo or list box.
All
4.0
DynaPDF.GetFieldColor
Retrieves a specific color of an interactive form field.
All
4.0
DynaPDF.GetFieldCount
The function returns the number of fields contained in the document.
All
4.0
DynaPDF.GetFieldExpValCount
The function returns the number of values/export values which are defined for a field.
All
4.0
DynaPDF.GetFieldExpValue
Retrieves the export value(s) of a check box, list box, or combo box.
All
4.0
DynaPDF.GetFieldExpValueEx
Enumerates the choice values of a combo box, list box, or radio button.
All
4.0
DynaPDF.GetFieldFlags
Returns the flags of a specific interactive form field.
All
4.0
DynaPDF.GetFieldGroupType
Returns the base type of a field group.
All
4.0
DynaPDF.GetFieldHighlightMode
Returns the highlight mode of buttons, checkboxes, and signature fields.
All
4.0
DynaPDF.GetFieldIndex
Returns the page index or tab order of the field.
All
4.0
DynaPDF.GetFieldMapName
Retrieves the mapping name of a specific form field if set.
All
4.0
DynaPDF.GetFieldName
Retrieves the name of a specific interactive form field.
All
4.0
DynaPDF.GetFieldOrientation
Returns the orientation of a field.
All
4.0
DynaPDF.GetFieldTextAlign
The function returns the text alignment of a text field or button field.
All
4.0
DynaPDF.GetFieldTextColor
Returns the default text color used for newly created fields.
All
4.0
DynaPDF.GetFieldToolTip
Retrieves a pointer to the tool tip string of a specific interactive form field.
All
4.0
DynaPDF.GetFieldType
Returns the field type.
All
4.0
DynaPDF.GetFieldsAsJSON
Queries all form fields as JSON array.
All
10.5
DynaPDF.GetFontAsJSON
Queries one font within the PDF as JSON object.
All
10.5
DynaPDF.GetFontCount
Returns the number of fonts which are used in the document.
All
4.4
DynaPDF.GetFontOrigin
Returns the current font origin.
All
4.4
DynaPDF.GetFontSelMode
Returns the current font selection mode.
All
4.4
DynaPDF.GetFontSize
Queries the font size of the active font.
All
12.3
DynaPDF.GetFontWeight
Returns the weight that will be used to emulate a bold font style.
All
4.4
DynaPDF.GetFontsAsJSON
Queries all fonts within the PDF as JSON array.
All
10.5
DynaPDF.GetFullyQualifiedFieldName   New in 14.0
Returns the fully qualified name of a field.
All
14.0
DynaPDF.GetGStateFlags
Returns the current graphics state flags.
All
5.3
DynaPDF.GetImage
Queries image properties or content.
All
6.4
DynaPDF.GetImageContainerCount
Queries number of images in an image container.
All
12.4
DynaPDF.GetImageCount
Queries number of images in PDF.
All
6.4
DynaPDF.GetImageFileCount
The function returns the number of images contained in a multi-page image.
All
12.4
DynaPDF.GetImportDocInfo
The function retrieves a document info entry as text from import PDF.
All
3.0
DynaPDF.GetImportDocInfoAsJSON
Queries all document information from import file as JSON array.
All
10.5
DynaPDF.GetImportFlags
The function returns the current import flags used to import PDF files.
All
4.1
DynaPDF.GetImportFlags2
Queries the import flags.
All
4.3
DynaPDF.GetImportOrientation
Queries orientation for input page.
All
3.5
DynaPDF.GetImportPDFVersion
The function returns the minor PDF version number of an external PDF file.
All
3.1
DynaPDF.GetImportPageBounds
Queries page size for an import PDF page.
All
3.0
DynaPDF.GetImportPageCount
Queries number of pages in the current opened import PDF.
All
3.0
DynaPDF.GetInDocInfoCount
Queries number of document info in import file.
All
5.0
DynaPDF.GetInFieldCount
Returns the number of top level fields included in the currently opened import file.
All
4.0
DynaPDF.GetInIsCollection
Whether the currently opened import file is a portable collection.
All
4.2
DynaPDF.GetInIsEncrypted
Whether the currently opened import file is encrypted.
All
4.2
DynaPDF.GetInIsSigned
Whether a PDF file contains a digital signature.
All
4.2
DynaPDF.GetInIsTaggedPDF
Whether the currently open import file is a Tagged PDF file.
All
11.4
DynaPDF.GetInIsTrapped
Queries value of the Trapped key in the current open import file.
All
4.2
DynaPDF.GetInIsXFAForm
Queries whether the current open import file contains an XFA form.
All
4.2
DynaPDF.GetInMetadata
Queries input PDF metadata.
All
5.2
DynaPDF.GetInPDFVersionEx
Retrieves the version information of the currently open import file.
All
11.5
DynaPDF.GetInPrintSettings
Retrieves the print settings of the current open import file.
All
5.1
DynaPDF.GetInRepairMode
Queries whether the current open import file was opened in repair or normal mode.
All
4.2
DynaPDF.GetIsFixedPitch
Queries whether the active font is a fixed pitch font or 0 if the font is a variable pitch font.
All
4.2
DynaPDF.GetIsTaggingEnabled
Queries whether tagging is enabled.
All
4.2
DynaPDF.GetJPEGQuality
Queries the JPEG compression quality.
All
3.1
DynaPDF.GetJavaScript
Returns a global JavaScript as string.
All
13.2
DynaPDF.GetJavaScriptAction
Returns the script of a JavaScript Action as string.
All
13.2
DynaPDF.GetJavaScriptCount
Returns the number of global JavaScripts contained in a document.
All
5.0
DynaPDF.GetJavaScriptName
Returns the name of a global JavaScript.
All
13.2
DynaPDF.GetLanguage
Returns the language identifier of the document as an ISO 3166 language tag or IANA tag, or "" if not set.
All
5.2
DynaPDF.GetLastErrorMessage
The function returns the last error message as text or empty text if no error occurred.
All
3.0
DynaPDF.GetLastTextOffset
Returns current text offset for WriteFText.
All
13.3
DynaPDF.GetLastTextPosX
Return the horizontal end position of the last drawn text.
All
3.1
DynaPDF.GetLastTextPosY
Return the vertical end position of the last drawn text.
All
3.1
DynaPDF.GetLeading
The function returns the current leading.
All
3.1
DynaPDF.GetLineWidth
Queries the line width.
All
3.3
DynaPDF.GetLinkHighlightMode
Returns the current highlight mode used for newly created annotations.
All
7.0
DynaPDF.GetLogMetafileSize
Queries bounding rectangle from EMF file.
Win only
7.3
DynaPDF.GetLogMetafileSizeEx
Queries bounding rectangle from EMF file inside container.
Win only
7.3
DynaPDF.GetMetaConvFlags
Queries meta file conversion flags.
Win only
7.3
DynaPDF.GetMetadata
Queries metadata from PDF.
All
5.2
DynaPDF.GetNeedAppearance
Returns true if the global NeedAppearance flag of the AcroForm is set.
All
13.2
DynaPDF.GetOCG
Returns properties for layer.
All
9.1
DynaPDF.GetOCGContUsage
Queres properties of a layer.
All
9.1
DynaPDF.GetOCGCount
Returns the number of OCGs or layers which are available in document.
All
9.1
DynaPDF.GetOCGUsageUserName
Returns the layer name.
All
9.1
DynaPDF.GetOpacity
Returns the opacity value used to draw the visible appearance of an annotation (requires Acrobat 5 or higher).
All
4.2
DynaPDF.GetOrientation
Queries orientation of current page.
All
3.5
DynaPDF.GetOutputIntent
Returns an output intent as well as the properties of it.
All
5.2
DynaPDF.GetOutputIntentCount
Returns the number of available output intents.
All
5.2
DynaPDF.GetPDFVersion
The function returns the version of the output PDF file.
All
3.1
DynaPDF.GetPDFVersionEx
Retrieves the major and minor version of the PDF document as well as the underlying PDF standard, if any.
All
11.5
DynaPDF.GetPageAnnotCount
Returns the number of annotations which are used by a page.
All
5.0
DynaPDF.GetPageAnnotation
Queries details about an annotation on current open page.
All
5.0
DynaPDF.GetPageBBox
Queries page size for a PDF page.
All
3.0
DynaPDF.GetPageBreakExpression
Queries current page break expression.
All
11.0
DynaPDF.GetPageCoords
Queries the current coordinate system.
All
3.3
DynaPDF.GetPageCount
Queries number of pages in the current PDF.
All
3.0
DynaPDF.GetPageField
Returns the most important properties of a field on a page.
All
13.0
DynaPDF.GetPageFieldAnnotation
Returns the most important properties of an annotation field on a page.
All
13.0
DynaPDF.GetPageFieldCount
Returns the number of fields used by a page.
All
5.0
DynaPDF.GetPageHeight
The function returns the height of the currently open page.
All
3.1
DynaPDF.GetPageLabel
Retrieves the properties of a page label.
All
5.0
DynaPDF.GetPageLabelCount
Returns the number of page labels defined in the document.
All
5.0
DynaPDF.GetPageLayout
The function returns the page layout that is used when opening the document with Adobe's Acrobat.
All
3.1
DynaPDF.GetPageMode
The function returns the page mode that is used when opening the document with Adobe's Acrobat.
All
3.1
DynaPDF.GetPageNum
Returns the page number of the currently open page.
All
5.0
DynaPDF.GetPageWidth
The function returns the width of the currently open page.
All
3.1
DynaPDF.GetPrintSettings
Retrieves the currently defined print settings of the document.
All
5.1
DynaPDF.GetReplaceICCProfile
Queries file path for a ICC replace profile.
All
6.1
DynaPDF.GetReplaceICCProfileData
Queries file path for a ICC replace profile.
All
7.5
DynaPDF.GetReplaceICCProfilesCounter
Queries counter for ReplaceICCProfile callback.
All
6.1
DynaPDF.GetResolution
Queries the resolution for images.
All
3.1
DynaPDF.GetSaveNewImageFormat
Queries the SaveNewImageFormat properties.
All
3.1
DynaPDF.GetSpaceWidthFactor
Queries the space width factor.
All
12.1
DynaPDF.GetTabLen
Queries tab length.
All
13.2
DynaPDF.GetTemplCount
Returns the number of templates used by a page.
All
5.1
DynaPDF.GetTemplHeight
Returns the height of a template.
All
5.0
DynaPDF.GetTemplWidth
Returns the width of a template.
All
5.0
DynaPDF.GetTextDrawMode
Queries text draw mode.
All
6.0
DynaPDF.GetTextFieldDefaultValue
The function returns the default value of a text field.
All
4.0
DynaPDF.GetTextFieldValue
The function returns the value of a text field.
All
4.0
DynaPDF.GetTextRise
Queries the current text rise used to output text.
All
4.2
DynaPDF.GetTextScaling
Queries the current value of horizontal text scaling.
All
4.2
DynaPDF.GetTextWidth
Computes the width of a text string.
All
5.0
DynaPDF.GetTransparentColor
Returns the transparent color value that is used for newly inserted images.
All
5.0
DynaPDF.GetTrapped
Returns the trapped key of the document.
All
5.0
DynaPDF.GetUseExactPwd
Queries if exact password is needed to unlock PDF.
All
5.0
DynaPDF.GetUseGlobalImpFiles
Queries if global import files are used.
All
5.0
DynaPDF.GetUseStdFonts
Queries whether the 14 standard fonts are enabled.
All
4.2
DynaPDF.GetUseSystemFonts
Queries whether system fonts are used.
All
4.2
DynaPDF.GetUseTransparency
The property specifies whether images should get a transparent background.
All
3.1
DynaPDF.GetUseVisibleCoords
Queries whether DynaPDF should consider the crop box to calculate the position of an object.
All
5.0
DynaPDF.GetUserRights
Queries user rights.
All
9.5
DynaPDF.GetUserUnit
The function returns the user unit of the current open page.
All
3.4
DynaPDF.GetUsesTransparency
Checks whether a page or the entire document uses transparency.
All
8.2
DynaPDF.GetViewerPreferences
Queries viewer preferences.
All
9.2
DynaPDF.GetWMFDefExtent
Retrieves the default size which is used to convert non-portable WMF files to EMF.
Win only
7.3
DynaPDF.GetWMFPixelPerInch
Returns the default pixels per inch of the y-axis which are used to convert portable WMF files to EMF.
Win only
7.3
DynaPDF.GetWordSpacing
Returns the current word spacing.
All
4.2
DynaPDF.GetXFAStream
Returns an XFA stream.
All
6.5
DynaPDF.GetXFAStreamCount
Returns the number of available XFA streams.
All
6.5
DynaPDF.HaveDPartRoot
Checks whether the PDF file in memory contains a DPartRoot dictionary.
All
13.3
DynaPDF.HaveOpenDocument
Whether we have a working document.
All
7.1
DynaPDF.HaveOpenPage
Checks whether a page is open.
All
7.1
DynaPDF.HavePro
Queries whether this is a Pro license.
All
12.4
DynaPDF.HighlightAnnot
Creates a Highlight annotation.
All
5.0
DynaPDF.HighlightPattern
Searches a text and adds highlights for it.
All
3.5
DynaPDF.ImportEncryptionSettings
Imports the encryption settings from the currently open import file.
All
7.0
DynaPDF.ImportPDFFile
Imports all pages from a file.
All
3.0
DynaPDF.ImportPDFPage
Imports a page from the import PDF and appends it to the current working PDF.
All
3.0
DynaPDF.ImportPageAsTemplate
Imports a page and creates a template which you can place on new PDF pages.
All
3.3
DynaPDF.InitColorManagement
Enables color management for render functions.
All
5.3
DynaPDF.InitColorManagementEx
Initializes color management.
All
6.0
DynaPDF.Initialize
Initializes the DynaPDF functions in the MBS Plugin.
All
3.0
DynaPDF.InsertBarcode
Inserts a barcode to the current open page.
All
10.5
DynaPDF.InsertBookmark
Inserts a bookmark in an existing outline tree.
All
4.0
DynaPDF.InsertBookmarkEx
Inserts a bookmark in an existing outline tree.
All
4.0
DynaPDF.InsertImage
The function inserts an image from a container.
All
3.1
DynaPDF.InsertImageFile
The function inserts an image from a file.
All
3.1
DynaPDF.InsertMetafile
Inserts metafile as vector graphics.
Win only
7.3
DynaPDF.InsertMetafileEx
Inserts metafile as vector graphics.
Win only
7.3
DynaPDF.IsColorPage
Checks whether a page is a color page or if all graphic elements of the page use black & white only.
All
5.0
DynaPDF.IsEmptyPage
Checks whether a page is empty.
All
5.0
DynaPDF.IsInitialized
Checks if DynaPDF library has been initialized.
All
4.2
DynaPDF.Lab
Calculates color value for LAB.
All
11.0
DynaPDF.LineAnnot
Creates a line annotation.
All
5.0
DynaPDF.LineTo
The function draws a path from the current position up to the specified point.
All
3.1
DynaPDF.List
Lists all IDs of current DynaPDF contexts.
All
8.1
DynaPDF.LockLayer
Adds a layer to the list of locked layers.
All
5.0
DynaPDF.MarkTemplateAsWatermark
Marks template as watermark.
All
13.3
DynaPDF.MovePage
The function moves a page to another position in the document.
All
4.3
DynaPDF.MoveTo
The function moves the current position to the point specified by PosX, PosY.
All
3.1
DynaPDF.New
Creates a new DynaPDF instance.
All
3.5
DynaPDF.OpenOutputFile
The function opens the output file into which the PDF file should be written.
All
3.3
DynaPDF.OpenOutputFileEncrypted
The function opens the output file into which the PDF file should be written.
All
6.4
DynaPDF.OpenPDFFromContainer
Opens a PDF for importing from a container.
All
3.0
DynaPDF.OpenPDFFromFile
Opens a PDF for importing from a file.
All
3.0
DynaPDF.OpenTag
Opens the specified tag so that contents can be written into it.
All
13.2
DynaPDF.OpenTagEx
Opens a new tag.
All
13.3
DynaPDF.Optimize
Optimizes PDF.
All
6.0
DynaPDF.PageLinkEx
Adds a page link to the current open page.
All
7.0
DynaPDF.PageStatistics
Queries the page statistics.
All
3.0
DynaPDF.ParseContent
Runs the content parser.
All
4.0
DynaPDF.Parser.ChangeAltFont   New in 14.0
Changes alternative font to use.
All
14.0
DynaPDF.Parser.Create   New in 14.0
Creates the parser object.
All
14.0
DynaPDF.Parser.DeleteText   New in 14.0
Deletes text in the area.
All
14.0
DynaPDF.Parser.ExtractText   New in 14.0
Extracts text from parser.
All
14.0
DynaPDF.Parser.FindText   New in 14.0
Finds text using the parser.
All
14.0
DynaPDF.Parser.Line   New in 14.0
Queries the index of the found line.
All
14.0
DynaPDF.Parser.ParsePage   New in 14.0
Parses a page.
All
14.0
DynaPDF.Parser.ReplaceSelText   New in 14.0
Replaces text on the page.
All
14.0
DynaPDF.Parser.Reset   New in 14.0
Resets the parser.
All
14.0
DynaPDF.Parser.SelectionBBox   New in 14.0
Computes the bounding box of the current selection.
All
14.0
DynaPDF.Parser.SelectionText   New in 14.1
Retrieves the text and text length of the current selection or found text.
All
14.1
DynaPDF.Parser.SetAltFont   New in 14.0
Sets the alternative font.
All
14.0
DynaPDF.Parser.TextMatrix   New in 14.0
Text matrix pre-calculated in user space.
All
14.0
DynaPDF.Parser.WriteToPage   New in 14.0
Writes changes back to the page.
All
14.0
DynaPDF.PlaceSigFieldValidateIcon
Places the validation icon within a signature field to the wished position.
All
10.2
DynaPDF.PlaceTemplate
The function places a template on a page, another open template, or pattern.
All
3.3
DynaPDF.PlaceTemplateEx
The function places a template on a page, another open template, or pattern.
All
3.3
DynaPDF.Print
Prints the PDF file that is currently in memory.
Win only
5.4
DynaPDF.Print.FormNames
Queries list of form names.
Win only
11.5
DynaPDF.Print.GetSetting
Queries a printer setting.
Win only
11.4
DynaPDF.Print.SetSetting
Sets a print setting.
Win only
11.4
DynaPDF.RGB
Calculates color value for RGB.
All
4.0
DynaPDF.ReadImageFormat
The function retrieves the most important properties of an image file.
All
3.1
DynaPDF.ReadImageResolution
The function retrieves the horizontal and vertical resolution of an image file.
All
3.1
DynaPDF.Rectangle
This function draws a rectangle.
All
3.1
DynaPDF.Release
Releases a PDF reference.
All
3.5
DynaPDF.ReleaseAll
Frees all DynaPDF objects.
All
10.5
DynaPDF.RenameSpotColor
Renames a spot color.
All
7.2
DynaPDF.RenderPDFFile
Renders whole PDF file in current PDF to an image.
All
5.0
DynaPDF.RenderPDFFileEx
Renders whole PDF file in current PDF to an image.
All
8.0
DynaPDF.RenderPage
Renders a page in current PDF to an image.
All
3.0
DynaPDF.ReplaceImage
Replaces an image with another image.
All
7.5
DynaPDF.ReplacePattern
Replaces a text with a new text.
All
3.4
DynaPDF.ResetAnnotAP
Forces a rebuild of the appearance stream of the specified annotation.
All
10.3
DynaPDF.ResetEncryptionSettings
Resets the encryption settings which were imported from an external PDF file so that the PDF file in memory can be saved unencrypted.
All
7.0
DynaPDF.RestoreGraphicState
The function restores a previously saved graphics state.
All
3.1
DynaPDF.RotateCoords
The function skews the coordinate system and sets the coordinate origin to the point OriginX, OriginY.
All
3.2
DynaPDF.RotateTemplate
Rotates a template.
All
7.0
DynaPDF.RoundRect
The function draws a rectangle with rounded corners.
All
3.1
DynaPDF.RoundRectEx
The function draws a rectangle with elliptical corners.
All
3.1
DynaPDF.Save
Saves the current PDF to a container value which you can assign to a container field.
All
3.0
DynaPDF.SaveAndSignFile
Saves and signs the current PDF.
All
3.3
DynaPDF.SaveAndSignFileExt
Saves and signs the current PDF.
All
11.0
DynaPDF.SaveAndSignFileExt1
Saves and signs the current PDF.
All
13.1
DynaPDF.SaveAndSignFileExt2
Step 2 to save and sign a PDF manually.
All
13.1
DynaPDF.SaveAndSignFileWinCrypt
Saves and signs the current PDF with dialog to pick certificate.
Win only
10.1
DynaPDF.SaveGraphicState
The function saves the current graphics state.
All
3.1
DynaPDF.ScaleCoords
The function scales the coordinate system by applying a transformation matrix.
All
3.2
DynaPDF.SetAlpha
Sets alpha for drawings.
All
3.1
DynaPDF.SetAltFonts
Fills an alternate font list created by DynaPDF.CreateAltFontList with data.
All
12.0
DynaPDF.SetAnnotBorderStyle
Sets or changes the border style of an annotation.
All
5.0
DynaPDF.SetAnnotBorderWidth
Sets or changes the border width of an annotation.
All
5.0
DynaPDF.SetAnnotColor
Sets or changes the color of an annotation.
All
5.0
DynaPDF.SetAnnotDate
Sets or changes the creation or modification date of an annotation.
All
5.0
DynaPDF.SetAnnotFlags
Sets the default flags used for new annotations.
All
5.0
DynaPDF.SetAnnotFlagsEx
Sets or changes the flags of an annotation.
All
5.0
DynaPDF.SetAnnotHighlightMode
Sets or changes the highlight mode of a link annotation.
All
5.0
DynaPDF.SetAnnotIcon
Sets or changes the icon of a text annotation.
All
5.0
DynaPDF.SetAnnotLineEndStyle
Sets or changes the line end styles of a Line or PolyLine Annotation.
All
5.0
DynaPDF.SetAnnotOpacity
Changes the opacity of a markup annotation.
All
6.0
DynaPDF.SetAnnotOpenState
Sets the open state of a markup or PopUp annotation.
All
5.0
DynaPDF.SetAnnotString
Sets, changes, or deletes a string of an annotation.
All
5.0
DynaPDF.SetAnnotSubject
Sets or changes the optional subject string of an annotation.
All
5.0
DynaPDF.SetBBox
Sets a specific bounding box of the current open PDF page.
All
4.0
DynaPDF.SetBookmarkDest
Sets or changes the destination of a bookmark.
All
4.0
DynaPDF.SetBookmarkStyle
Sets the bookmark style.
All
4.0
DynaPDF.SetBorderStyle
Set the global border style which is used for newly created form fields.
All
4.2
DynaPDF.SetCMapDir
The function sets a search path from which external CMap files can be loaded.
All
4.2
DynaPDF.SetCharacterSpacing
Sets the current character spacing.
All
4.2
DynaPDF.SetCheckBoxChar
Sets the character which should be used for newly created check boxes.
All
4.4
DynaPDF.SetCheckBoxDefState
Changes the default state of a check box.
All
4.4
DynaPDF.SetCheckBoxState
Changes the state of a check box.
All
4.4
DynaPDF.SetColorSpace
The function activates a device color space in the graphics state.
All
3.3
DynaPDF.SetCompressionFilter
The function sets the compression filter which is used to compress images.
All
3.1
DynaPDF.SetCompressionLevel
Sets the current compression level.
All
4.0
DynaPDF.SetContent
Replaces the content stream of the currently open page or template with a new one.
All
7.0
DynaPDF.SetDateTimeFormat
Sets field to use date format.
All
12.3
DynaPDF.SetDocInfo
The function sets or changes a document info entry.
All
3.0
DynaPDF.SetDocInfoEx
Sets a document information.
All
8.2
DynaPDF.SetDrawDirection
The function sets the draw direction of closed vector graphics such as rectangles, ellipses, triangles and so on.
All
3.2
DynaPDF.SetExtColorSpace
Activates an extended color space in the graphics state.
All
7.4
DynaPDF.SetExtFillColorSpace
Activates an extended color space for fillings in the graphics state.
All
7.4
DynaPDF.SetExtStrokeColorSpace
Activates an extended color space for strokes in the graphics state.
All
7.4
DynaPDF.SetFieldBBox
Changes the bounding box of a field.
All
4.0
DynaPDF.SetFieldBackColor
Sets field background color.
All
4.0
DynaPDF.SetFieldBorderColor
Sets the border color used for newly created interactive form fields and annotations.
All
4.0
DynaPDF.SetFieldBorderStyle
Changes the border style of a specific Interactive Form field.
All
4.0
DynaPDF.SetFieldBorderWidth
Changes the border width of a field.
All
4.0
DynaPDF.SetFieldColor
Sets a specific color of an interactive form field.
All
4.0
DynaPDF.SetFieldDate
Sets or changes the creation or modification date of a field.
All
5.0
DynaPDF.SetFieldExpValue
Changes the choice values of a combo or list box, or to change the state and export value of check box.
All
4.0
DynaPDF.SetFieldExpValueEx
Marks a choice value of a combo or list box as selected or unselected.
All
4.0
DynaPDF.SetFieldFlags
The function sets the flags of a specific interactive form field.
All
4.0
DynaPDF.SetFieldFont
Sets or changes the font of a form field.
All
5.1
DynaPDF.SetFieldFontEx
Sets or replaces the font of a field.
All
5.1
DynaPDF.SetFieldFontSize
The function changes the font size of a specific field. A value of 0.0 is used as auto size. The optimal font size is then calculated by DynaPDF.
All
4.0
DynaPDF.SetFieldHighlightMode
Changes the highlight mode of a specific field.
All
4.0
DynaPDF.SetFieldIndex
Sets the tab order of interactive form fields.
All
4.0
DynaPDF.SetFieldMapName
Sets or changes the mapping name of a field.
All
4.0
DynaPDF.SetFieldName
Changes the name of an interactive form field.
All
4.0
DynaPDF.SetFieldOrientation
The function sets or changes the orientation of a field.
All
4.0
DynaPDF.SetFieldTextAlign
The function set or changes the text alignment of a text or button field.
All
4.0
DynaPDF.SetFieldTextColor
The function sets the text color which is used for newly created interactive form fields.
All
4.0
DynaPDF.SetFieldToolTip
The function set or changes the tool tip or description string of an interactive form field.
All
4.0
DynaPDF.SetFillColor
The function sets the current fill color as an array of float values.
All
3.1
DynaPDF.SetFillColorValue
The function sets the current fill color.
All
11.0
DynaPDF.SetFloatPrecision
The function changes the output precision of text and vector coordinates.
All
6.5
DynaPDF.SetFont
The function loads a font that can be used for text output and interactive form fields.
All
3.1
DynaPDF.SetFontEx
Loads a font that can be used for text output and interactive form fields.
All
3.1
DynaPDF.SetFontOrigin
Sets the current font origin that is used to position text strings.
All
4.4
DynaPDF.SetFontSearchOrder
Changes the font search order.
All
4.4
DynaPDF.SetFontSelMode
Changes the font selection mode.
All
4.4
DynaPDF.SetFontWeight
Changes the font weight.
All
4.4
DynaPDF.SetGStateFlags
Sets optional flags affecting the graphics state, coordinate handling, as well as color and image conversion rules.
All
5.3
DynaPDF.SetImportFlags
The function sets optional flags to control the import of external PDF files.
All
4.1
DynaPDF.SetImportFlags2
Sets optional flags to control the import of external PDF files.
All
4.3
DynaPDF.SetJPEGQuality
Sets the quality of JPEG compressed images in percent if JPEG compression is used.
All
3.1
DynaPDF.SetLanguage
Specifies the language of the document.
All
4.4
DynaPDF.SetLeading
Sets text leading.
All
3.1
DynaPDF.SetLineJoinStyle
Sets a new line join.
All
4.0
DynaPDF.SetLineWidth
The function sets the line width used to stroke paths.
All
3.3
DynaPDF.SetLinkHighlightMode
Sets the highlight mode that is used by link annotations.
All
7.0
DynaPDF.SetMetaConvFlags
Sets the metadata conversion flag.
Win only
7.3
DynaPDF.SetMetadata
The function sets or replaces the XMP metadata stream of a specific object.
All
5.2
DynaPDF.SetMiterLimit
Sets the miter limit.
All
4.0
DynaPDF.SetNeedAppearance
Sets need appearance flag.
All
13.2
DynaPDF.SetNumberFormat
Limits textfield to only accept numbers.
All
6.4
DynaPDF.SetOCGState
Changes the visibility state of an OCG or layer.
All
9.1
DynaPDF.SetOpacity
Sets the opacity value which is used to render the appearance of a text annotation.
All
4.2
DynaPDF.SetOrientation
Changes the orientation of the page.
All
3.5
DynaPDF.SetOrientationEx
Changes the orientation of the page.
All
3.5
DynaPDF.SetPDFVersion
Sets the PDF version.
All
3.1
DynaPDF.SetPageBBox
Sets or changes the bounding box of a page.
All
8.2
DynaPDF.SetPageBreakExpression
Sets page break expression.
All
11.0
DynaPDF.SetPageCoords
Sets the coordinate system origin.
All
3.3
DynaPDF.SetPageFormat
The function sets a predefined page or paper format.
All
3.3
DynaPDF.SetPageHeight
Sets page height.
All
3.1
DynaPDF.SetPageLayout
The function sets the page layout that is used when opening the document with Adobe's Acrobat.
All
3.1
DynaPDF.SetPageMode
The function sets the page mode that is used when opening the document with Adobe's Acrobat.
All
3.1
DynaPDF.SetPageWidth
Sets page width.
All
3.1
DynaPDF.SetPrintSettings
Adds preferred print settings to the PDF file.
All
5.1
DynaPDF.SetRenderingIntent
Set function sets the rendering intent of an image.
All
12.4
DynaPDF.SetReplaceICCProfile
Sets the replace ICC profile path.
All
6.1
DynaPDF.SetReplaceICCProfileData
Sets the replace ICC profile data.
All
7.5
DynaPDF.SetResolution
Sets the image resolution.
All
3.1
DynaPDF.SetSaveNewImageFormat
Whether to recompress images.
All
3.1
DynaPDF.SetSeparationInfo
Sets the separation info of the current open page.
All
7.4
DynaPDF.SetSpaceWidthFactor
Sets space width factor.
All
12.1
DynaPDF.SetStrokeColor
The function sets the current stroke color as an list of values.
All
3.1
DynaPDF.SetStrokeColorValue
The function sets the current stroke color.
All
11.0
DynaPDF.SetTabLen
Sets tab length.
All
13.2
DynaPDF.SetTemplBBox
Sets or changes a bounding box of a template.
All
12.3
DynaPDF.SetTextDrawMode
Sets text draw mode.
All
6.0
DynaPDF.SetTextFieldValue
The function sets or changes the value and default value of a text field.
All
4.1
DynaPDF.SetTextFieldValueEx
The function changes or sets the value of a text field.
All
4.1
DynaPDF.SetTextRect
The function defines the output rectangle that is used to output formatted text by the function DynaPDF.WriteFText.
All
3.1
DynaPDF.SetTextRise
Sets the text rise.
All
4.2
DynaPDF.SetTextScaling
Sets scaling for text.
All
4.2
DynaPDF.SetTransparentColor
Sets the transparent color which is used for newly inserted images.
All
5.0
DynaPDF.SetTrapped
Sets the trapped key of the document.
All
5.0
DynaPDF.SetUseExactPwd
Whether to require exact passwords.
All
5.0
DynaPDF.SetUseGlobalImpFiles
Sets whether to use global import file.
All
5.0
DynaPDF.SetUseStdFonts
The function can be used to disable the 14 standard fonts temporarily.
All
4.2
DynaPDF.SetUseSystemFonts
The property specifies whether the system fonts should be automatically loaded.
All
4.2
DynaPDF.SetUseTransparency
Whether to use transparency color.
All
3.1
DynaPDF.SetUseVisibleCoords
Whether DynaPDF should consider the crop box to calculate to position of an object.
All
5.0
DynaPDF.SetUserUnit
The function sets the user unit of the current open page.
All
3.4
DynaPDF.SetViewerPreferences
Sets viewer preferences.
All
9.2
DynaPDF.SetWMFDefExtent
Sets the default pixels per inch of the y-axis which are used to convert portable WMF files to EMF.
Win only
7.3
DynaPDF.SetWMFPixelPerInch
Sets the default pixels per inch of the y-axis which are used to convert portable WMF files to EMF.
Win only
7.3
DynaPDF.SetWordSpacing
Sets the word spacing.
All
4.2
DynaPDF.SetXFAStream
Replaces the contents of an XFA stream with new contents.
All
9.5
DynaPDF.ShowDifferences
Shows differences on two PDF pages by adding highlight annotations.
All
5.3
DynaPDF.SkewCoords
The function skews the coordinate system and sets the coordinate origin to the point OriginX, OriginY.
All
3.2
DynaPDF.SquareAnnot
Draws a square annotation on the current open page.
All
5.0
DynaPDF.StampAnnot
Creates a stamp annotation.
All
5.0
DynaPDF.StrokePath
The function strokes the current path without closing it.
All
3.1
DynaPDF.SysFontInfo
Returns the most important properties of a system font.
All
5.1
DynaPDF.SysFontInfoAsJSON
Queries all system fonts as JSON array.
All
10.5
DynaPDF.Table.AddColumn
Adds a column on the left or right side of the table.
All
3.5
DynaPDF.Table.AddRow
Adds a new row to the table.
All
3.5
DynaPDF.Table.AddRows
Adds new rows to the table.
All
3.5
DynaPDF.Table.ClearColumn
Deletes the content in the specified column in all rows.
All
3.5
DynaPDF.Table.ClearContent
Deletes the specified object types from the table.
All
3.5
DynaPDF.Table.ClearRow
The function deletes the content in the specified row.
All
3.5
DynaPDF.Table.Create
Creates a new table object.
All
3.5
DynaPDF.Table.DeleteCol
Deletes a column from the table.
All
3.5
DynaPDF.Table.DeleteRow
Deletes a row from the table.
All
3.5
DynaPDF.Table.DeleteRows
Deletes all rows from the table.
All
3.5
DynaPDF.Table.Draw
Draws the table on the specified position.
All
3.5
DynaPDF.Table.GetFirstRow
Queres first row drawn.
All
3.5
DynaPDF.Table.GetNextHeight
Calculates the height of the table.
All
3.5
DynaPDF.Table.GetNextHeightRow
Calculates the height of the table.
All
3.5
DynaPDF.Table.GetNextRow
Queres next row to be drawn.
All
3.5
DynaPDF.Table.GetNumCols
Queries number of columns in table.
All
3.5
DynaPDF.Table.GetNumRows
Queries number of rows in table.
All
3.5
DynaPDF.Table.GetPDF
Returns the reference to the PDF.
All
3.5
DynaPDF.Table.GetTableHeight
Returns the full height of the table.
All
3.5
DynaPDF.Table.GetTableWidth
Returns the width of the table.
All
3.5
DynaPDF.Table.HaveMore
Checks whether all rows where drawn.
All
3.5
DynaPDF.Table.List
Lists all IDs of table objects.
All
13.0
DynaPDF.Table.Release
Releases the PDF table.
All
3.5
DynaPDF.Table.SetBorderWidth
Sets or changes the border width.
All
3.5
DynaPDF.Table.SetBoxProperty
Sets or changes the border width, cell spacing, or cell padding.
All
3.5
DynaPDF.Table.SetCellAction
Adds an action to a cell.
All
9.1
DynaPDF.Table.SetCellImage
Inserts an image horizontally and vertically aligned as specified.
All
3.5
DynaPDF.Table.SetCellImageEx
Inserts an image from container.
All
3.5
DynaPDF.Table.SetCellOrientation
Sets the cell orientation.
All
3.5
DynaPDF.Table.SetCellPadding
Sets or changes the cell padding.
All
3.5
DynaPDF.Table.SetCellSpacing
Sets or changes the cell spacing.
All
3.5
DynaPDF.Table.SetCellStyledText
Inserts the specified styled text into the cell.
All
11.1
DynaPDF.Table.SetCellTable
Inserts a sub table into the specified cell.
All
3.5
DynaPDF.Table.SetCellTemplate
Inserts a template into the specified cell.
All
3.5
DynaPDF.Table.SetCellText
Inserts the specified text into the cell.
All
3.5
DynaPDF.Table.SetColWidth
The function changes the width of a column.
All
3.5
DynaPDF.Table.SetColor
Sets or changes the specified color as well as the corresponding device color space.
All
3.5
DynaPDF.Table.SetColorFloat
Sets or changes the specified color and color space.
All
3.5
DynaPDF.Table.SetFlags
The function sets various flags.
All
3.5
DynaPDF.Table.SetFont
Sets the font that is used to output text.
All
3.5
DynaPDF.Table.SetFontSelMode
The function sets or changes the font selection mode.
All
3.5
DynaPDF.Table.SetFontSize
Sets or changes the font size.
All
3.5
DynaPDF.Table.SetGridWidth
Sets the grid width.
All
3.5
DynaPDF.Table.SetPDF
Changes the PDF instance that is associated with the table.
All
3.5
DynaPDF.Table.SetRGBColor
Sets RGB color.
All
3.5
DynaPDF.Table.SetRowHeight
Changes the row height.
All
3.5
DynaPDF.Table.SetTableWidth
Changes the width of the table.
All
3.5
DynaPDF.TestGlyphs
Checks whether all glyphs of the text are available in the current font.
All
13.0
DynaPDF.TextAnnot
Creates a text annotation.
All
5.0
DynaPDF.TranslateCoords
The function translates the coordinate system to the new origin OriginX, OriginY.
All
3.2
DynaPDF.Triangle
The function draws a triangle.
All
3.2
DynaPDF.UnLockLayer
Removes a layer from the list of locked layers.
All
5.0
DynaPDF.Uninitialize
Uninitializes DynaPDF library.
All
10.1
DynaPDF.WatermarkAnnot
Creates a Watermark annotation.
All
7.0
DynaPDF.WriteDemoText
Writes a demo text like the DynaPDF demo watermark.
All
5.0
DynaPDF.WriteFText
Writes text on current page with formatting commands.
All
3.1
DynaPDF.WriteFTextEx
Writes text on current page with formatting commands.
All
3.1
DynaPDF.WriteFTextExRotated
Writes text on current page with formatting commands.
All
7.4
DynaPDF.WriteStyledText
Writes styled text on current page.
All
6.5
DynaPDF.WriteStyledTextEx
Writes styled text on current page.
All
6.5
DynaPDF.WriteStyledTextExRotated
Writes styled text on current page.
All
7.4
DynaPDF.WriteText
Writes text on current page.
All
3.1
ECKey.BuiltInCurves
Queries built in curves.
All
5.4
ECKey.CanSign
Indicates if an ECKey can be used for signing.
All
10.2
ECKey.Description
Returns an user readable description text for the current key.
All
5.4
ECKey.Duplicate
Creates a copy of the key.
All
5.4
ECKey.Generate
Generates a new pair of private and public keys.
All
5.4
ECKey.List
Lists all IDs of key objects.
All
13.0
ECKey.PrivateKey
Queries the private key.
All
5.4
ECKey.PublicKey
Queries the public key.
All
5.4
ECKey.ReadPrivateKey
Reads a private key from text.
All
5.4
ECKey.ReadPublicKey
Reads a public key from text.
All
5.4
ECKey.Release
Releases the key.
All
5.4
ECKey.ReleaseAll
Frees all Key objects.
All
10.5
ECKey.Sign
Signs the given data.
All
5.4
ECKey.Size
Queries the size of the key in bytes.
All
5.4
ECKey.Valid
Verifies that a private and/or public key is valid.
All
10.2
ECKey.Verify
Verifies the digital signature.
All
5.4
Email.Verify
Verifies if an email is valid.
All
3.3
EmailParser.Address
Queries an address value.
All
5.3
EmailParser.AddressCount
Queries number of addresses.
All
5.3
EmailParser.AttachedEmails
Queries email IDs for embedded emails.
All
9.4
EmailParser.Attachment
Queries an attachment property.
All
5.3
EmailParser.AttachmentCount
Queries number of attachments.
All
5.3
EmailParser.Free
Frees the email parser.
All
5.3
EmailParser.HTMLText
Queries html text of email.
All
5.3
EmailParser.HTMLToPlainText
Converts HTML to plain text.
All
5.3
EmailParser.HasHeader
Checks if header exists.
All
7.4
EmailParser.Hash
Returns a SHA512 hash for the email source parsed.
All
5.4
EmailParser.Header
Queries a header entry.
All
5.3
EmailParser.HeaderCount
Queries number of header entries.
All
5.3
EmailParser.HeaderValue
Queries header value by header name.
All
7.4
EmailParser.Inline
Queries an inline graphics property.
All
5.3
EmailParser.InlineCount
Queries number of inline images.
All
5.3
EmailParser.List
Lists all email parser reference numbers.
All
5.3
EmailParser.MessageID
Queries the message ID of the email.
All
5.3
EmailParser.Parse
Parses an email.
All
5.3
EmailParser.ParseContainer
Parses an email stored in container.
All
6.3
EmailParser.ParseFile
Parses an email from a file.
All
5.3
EmailParser.PlainText
Queries plain text of email.
All
5.3
EmailParser.ProcessImageReferences
Processes image references in HTML.
All
6.3
EmailParser.ReceiveDate
Queries the date and time of the email.
All
6.4
EmailParser.SentDate
Queries the date and time of the email.
All
5.4
EmailParser.Source
Returns the source of the email as we parsed it.
All
5.4
EmailParser.SourceWithoutAttachments
Returns the source of the email without attachments.
All
5.4
EmailParser.Subject
Queries the subject line of the email.
All
5.3
EmailParser.WriteAttachment
Writes an attachment to a file path.
All
5.3
EmailParser.WriteInline
Writes an inline graphics to a file path.
All
5.3
Encryption.Cipher
Encrypts or decrypts of a value.
All
4.1
Encryption.CipherNames
Queries list of all ciphers.
All
8.5
Encryption.DigestNames
Queries list of all digest algorithms.
All
8.5
EnvironmentVariables.ClearValue
Clears a variable by removing it from the environment.
All
5.1
EnvironmentVariables.Count
Queries number of environment variables.
All
5.1
EnvironmentVariables.Name
Queries name of environment variable with given index.
All
5.1
EnvironmentVariables.Names
Queries list of environment variable names.
All
5.1
EnvironmentVariables.SetValue
Sets an environment variable.
All
5.1
EnvironmentVariables.Value
Queries value of an environment variable.
All
5.1
ErrorLog
Queries error log.
All
12.3
FM.Argument
Query an argument passed to FileMaker from command line.
All
5.1
FM.ArgumentCount
Queries number of arguments.
All
5.1
FM.Beep
Beeps.
Mac/Win
8.2
FM.CF
Calls a custom function given the name with FileMaker values.
All
11.3
FM.CF.Parameter
Queries function parameter.
All
11.3
FM.CompareTables
Compare two tables.
All
9.3
FM.CurrentLayoutID
Queries ID of current running FileMaker layout.
All
10.2
FM.CurrentLayoutName
Queries name of current layout.
All
10.2
FM.CurrentScriptID
Queries ID of current running FileMaker script.
All
5.1
FM.CurrentScriptName
Queries name of current script.
All
5.1
FM.CurrentThreadID
Queries current thread ID.
All
5.1
FM.DataType
Returns data type of argument.
All
6.1
FM.DeleteRecord
Deletes an existing record in a table in one line.
All
6.0
FM.DeleteRecords
Deletes existing records in a table in one line.
All
6.0
FM.ErrorMessage
Queries an error message for a FileMaker error.
All
11.3
FM.Evaluate
Similar to FileMaker's built-in Evaluate.
All
1.3
FM.ExecuteFileSQL
Execute the SQL Statement against a FileMaker database.
All
3.5
FM.ExecuteFileSQLOnIdle
Executes a SQL command at idle time.
All
6.5
FM.ExecuteFileSQLValue
Execute the SQL Statement against a FileMaker database.
All
12.0
FM.ExecuteSQL.LastError
Queries the last error code from an SQL call
All
1.2
FM.ExecuteSQL.LastErrorMessage
Queries the last error message from an SQL call
All
3.0
FM.ExecuteSQL.LastSQL
Queries last SQL command.
All
7.4
FM.GetSQLBatchMode
Queries turbo level for sending SQL in chunks.
All
6.4
FM.InitMessageFilter
Initializes COM message filter.
Win only
8.3
FM.InsertOrUpdateRecord
Inserts or updates a record in a table in one line.
All
6.0
FM.InsertOrUpdateRecord2
Inserts or updates a record in a table in one line.
All
6.1
FM.InsertOrUpdateRecord3
Inserts or updates a record in a table in one line.
All
6.1
FM.InsertOrUpdateRecord4
Inserts or updates a record in a table in one line.
All
11.2
FM.InsertOrUpdateRecord5
Inserts or updates a record in a table in one line.
All
11.2
FM.InsertOrUpdateRecordQuery
Insert or updates a lot of records queried from a database.
All
8.4
FM.InsertRecord
Inserts a new record in a table in one line.
All
5.1
FM.InsertRecordCSV
Inserts records based on CSV text.
All
7.4
FM.InsertRecordQuery
Inserts a lot of records queried from a database.
All
5.1
FM.InsertRecordQueryIgnoreDuplicates
Inserts a lot of records queried from a database.
All
6.0
FM.InsertRecordTSV
Inserts records based on tab/return separated text.
All
5.3
FM.IsMainThread
Checks if current thread is main thread.
All
5.1
FM.LayoutIDForLayoutName
Queries the ID for layout with given name.
All
10.2
FM.LayoutNameForLayoutID
Queries layout name for a layout ID.
All
10.2
FM.LayoutNames
Queries list of layout names in current file.
All
10.2
FM.Loop
Universal function to run a loop with evaluate.
All
8.2
FM.MainThreadID
Queries main thread ID.
All
5.1
FM.NULL
Returns a null value.
All
5.1
FM.QueryBaseTableNames
Queries the base table names of all files currently open.
All
3.1
FM.QueryFieldsForBaseTableName
Queries the field names of all fields in the given table.
All
3.1
FM.QueryFieldsForTableName
Queries the field names of all fields in the given table.
All
3.1
FM.QueryTableNames
Queries the table names of all files currently open.
All
3.1
FM.SQL.Avg
Calculates average value in a record set.
All
9.1
FM.SQL.CSV
Queries text of SQL result for CSV export.
All
7.0
FM.SQL.Execute
Execute the SQL Statement against a FileMaker database.
All
5.1
FM.SQL.Field
Queries field value for given position in result.
All
5.1
FM.SQL.FieldCount
Queries number of fields.
All
5.1
FM.SQL.FieldType
Queries field type for given position in result.
All
5.1
FM.SQL.InsertRecords
Inserts records in FileMaker database from records in memory.
All
6.4
FM.SQL.InsertRecordsToSQL
Inserts records in SQL database from records in memory.
All
6.4
FM.SQL.JSONColumn
Returns a column as JSON array.
All
10.5
FM.SQL.JSONRecord
Returns a row as JSON object.
All
8.1
FM.SQL.JSONRecords
Returns rows as JSON array.
All
8.1
FM.SQL.List
Lists all IDs of current FM.SQL objects.
All
12.5
FM.SQL.Max
Queries max value in a record set.
All
9.1
FM.SQL.Min
Queries min value in a record set.
All
9.1
FM.SQL.Release
Releases memory used for the SQL result.
All
5.1
FM.SQL.ReleaseAll
Release all FMSQL objects.
All
10.5
FM.SQL.RowCount
Queries number of rows in the result.
All
5.1
FM.SQL.Sum
Calculates sum value in a record set.
All
9.1
FM.SQL.Text
Queries text of SQL result.
All
7.0
FM.SQL.ToMatrix   New in 14.0
Copies from result set to a Matrix.
All
14.0
FM.SQL.XMLRecord
Returns a row as XML object.
All
10.3
FM.SQL.XMLRecords
Returns rows as XML.
All
10.3
FM.ScriptIDForScriptName
Queries the ID for script with given name.
All
5.1
FM.ScriptNameForScriptID
Queries script name for a script ID.
All
5.1
FM.ScriptNames
Queries list of script names in current file.
All
5.1
FM.SetSQLBatchMode
Sets turbo level for sending SQL in chunks.
All
6.4
FM.SetThreadName
Sets a new name for a thread.
All
6.0
FM.StopScriptIdle
Stops any idle timer.
Mac/Win/Linux
5.0
FM.TableStatistics
Queries statistics on a table.
All
8.2
FM.TextWithDataType
Returns a new value with given type annotation.
All
13.1
FM.UpdateRecord
Update an existing record in a table in one line.
All
6.0
FM.UpdateRecord2
Updates existing records in a table in one line.
All
8.0
FM.UpdateRecord3
Updates existing records in a table in one line.
All
8.0
FM.UpdateRecords
Updates existing records in a table in one line.
All
6.0
FM.UpdateRecords2
Updates existing records in a table in one line.
All
8.0
FM.UpdateRecords3
Updates existing records in a table in one line.
All
8.0
FM.ValueListIDForValueListName
Queries the ID for value list with given name.
All
12.0
FM.ValueListNameForValueListID
Queries value list name for a value list ID.
All
12.0
FM.ValueListNames
Queries list of value list names in current file.
All
12.0
FM.VariableAdd
Adds a value to a given variable atomically.
All
8.3
FM.VariableAppend
Appends text to a variable.
All
9.5
FM.VariableClear
Destroys a variable that was declared with FM.VariableSet.
All
1.2
FM.VariableClearAll
Clears all variables.
All
5.2
FM.VariableExists
Checks if a variable with that name exists.
All
4.0
FM.VariableGet
Retrieves the value of named variable that was declared using FM.VariableSet.
All
1.2
FM.VariableList
Returns list of all variables names and values.
All
4.0
FM.VariableLookup
Retrieves the value of named variable that was declared using FM.VariableSet.
All
12.3
FM.VariableNames
Queries list of all variable names.
All
8.0
FM.VariableReset
Resets the list of variables.
All
4.0
FM.VariableSet
Stores a named variable that can be retrieved later using FM.VariableGet.
All
1.2
FSEvents.Create
Creates a new FSEvents monitor.
Mac only
5.4
FSEvents.CreateRelativeToDevice
Creates a new FSEvents monitor relative to a device.
Mac only
6.0
FSEvents.CurrentEventId
Queries current event ID for system.
Mac only
5.4
FSEvents.Description
Queries description event for this FSEvents object.
Mac only
5.4
FSEvents.DeviceBeingWatched
Queries device ID of device watched.
Mac only
6.0
FSEvents.DeviceID
Queries the DeviceID for a disk.
Mac only
6.0
FSEvents.EventCount
Queries number of events in queue.
Mac only
5.4
FSEvents.FlushASync
Flushes events asynchronously.
Mac only
5.4
FSEvents.FlushSync
Flushes events synchronously.
Mac only
5.4
FSEvents.GetEvaluate
Queries string to evaluate.
Mac only
6.2
FSEvents.GetExclusionPaths
Queries list of exclusion paths.
Mac only
6.0
FSEvents.HasNextEvent
Checks if there is a pending event in the queue.
Mac only
5.4
FSEvents.LastEventIdForDeviceBeforeTime
Queries event ID for a given time on a device.
Mac only
6.0
FSEvents.LatestEventId
Queries latest Event ID for this stream.
Mac only
5.4
FSEvents.List
Lists all IDs of file system event objects.
Mac only
13.0
FSEvents.NextEvent
Queries next event in queue.
Mac only
5.4
FSEvents.PathsBeingWatched
Queries the paths being watched.
Mac only
5.4
FSEvents.Release
Releases the FSEvents object.
Mac only
5.4
FSEvents.ReleaseAll
Frees all FSEvents objects.
Mac only
10.5
FSEvents.SetExclusionPaths
Sets directories to be filtered from the EventStream.
Mac only
6.0
FSEvents.Show
Shows details for this FSEvents object on console.
Mac only
5.4
FSEvents.Start
Starts FSEvents monitor.
Mac only
5.4
FSEvents.Started
Queries if FSEvents monitor is started.
Mac only
5.4
FSEvents.Stop
Stops FSEvent monitor.
Mac only
5.4
FSEvents.UUIDForDevice
Gets the UUID associated with a device.
Mac only
6.0
Files.AccessDate
Queries the access date of the file or folder.
All
2.9
Files.AddedToDirectoryDate
Queries the date of the file or folder when it was added to parent folder.
Mac only
6.4
Files.AppPath
Returns the path to the main executable for this FileMaker solution.
All
2.7
Files.AudioCoverArt
Loads audio file and returns cover art.
Mac/Win
12.1
Files.AudioTags
Queries audio tags for audio file.
Mac/Win
9.4
Files.CanOpenFile
Checks if plugin can read file.
All
5.4
Files.CopyFile
Copies files and folders without user interface.
All
2.8
Files.CopyFiles
Copies multiple files in parallel.
Mac/iOS
10.0
Files.CreateAlias
Creates an alias or link file.
Mac/Win/iOS
8.4
Files.CreateBookmark
Creates a bookmark from a file path.
Mac/iOS
3.1
Files.CreateDirectory
Creates a directory.
All
2.7
Files.CreationDate
Queries the creation date of the file or folder.
All
2.9
Files.Delete
Deletes a file directly without moving it to trash.
All
3.3
Files.DeleteFolder
Deletes a file or folder directly without moving to trash.
All
4.2
Files.DeleteLater
Deletes file later.
All
13.3
Files.DirectoryExists
Checks whether a directory exists with the given path.
All
2.7
Files.DiskInfo
Queries information about a volume.
All
5.0
Files.EvictUbiquitousItem
Removes local copy of a cloud file.
Mac/iOS
13.4
Files.FileDisplayName
Queries the display name of the file or folder.
All
2.9
Files.FileExists
Checks whether a file exists with the given path.
All
2.7
Files.FileExtension
Queries the file extension of the given path.
All
5.2
Files.FileInfo
Queries some file information.
Mac/Win/iOS
4.3
Files.FileKind
Queries the file kind string.
Mac/Win
2.9
Files.FileName
Queries the file name of the given path.
All
2.9
Files.FileNameWithoutExtension
Queries file name without extension.
All
11.1
Files.FileSize
Queries file size.
All
2.7
Files.FileUTITypes
Queries uniform type identifiers for this file.
Mac only
2.9
Files.FolderSize
Calculate sizes of folder.
All
6.2
Files.GetComment
Queries Finder's file comment.
Mac only
6.2
Files.GetFinderLabel
Queries the label of the file or folder.
Mac only
6.2
Files.GetNodeID
Queries the NodeID fo the file or folder.
Mac/Win
3.1
Files.GetPathFromNodeID
Finds the file or folder for the given NodeID on the given volume.
Mac/Win
3.1
Files.GetPosixPermissions
Queries posix file permissions.
Mac/Linux/iOS
4.3
Files.GetTagNames
Queries names of the tags assigned to the file/folder.
Mac only
3.5
Files.IdentifyData   New in 14.0
Checks file type from the data.
All
14.0
Files.IsApplication
Checks whether the file path points to an application.
Mac/iOS
13.5
Files.IsExcludedFromBackup
Queries file extension visibility state of a file or folder.
Mac only
12.0
Files.IsFileExtensionHidden
Queries file extension visibility state of a file or folder.
Mac only
12.0
Files.IsHidden
Queries hidden state of a file or folder.
Mac/Win
7.1
Files.IsPackage
Checks whether the file path points to a package.
Mac/iOS
13.5
Files.IsReadOnly
Queries read only flag for a file or folder.
Win only
12.5
Files.ItemExists
Checks whether a item exists with the given path.
All
2.7
Files.List
Queries list of file names in folder.
All
2.8
Files.ListAsJSON
Queries list of file names in folder as JSON.
All
10.5
Files.ListRecursive
Queries list of paths in folder.
All
4.1
Files.ListVolumes
Lists mounted volumes.
Mac/Win
6.5
Files.ModificationDate
Queries the modification date of the file or folder.
All
2.9
Files.Mount
Mounts a network share.
Mac/Win/Linux
5.1
Files.MountPath
Queries mount path for a volume.
Mac/Win
8.3
Files.MoveFile
Moves a file or folder without user interface.
All
2.8
Files.MoveToTrash
Deletes an item by moving it to trash without user interface.
All
2.8
Files.ReadAndWriteFile
Reads a file and writes it elsewhere.
All
11.1
Files.ReadFile
Reads a file with the given path.
All
3.5
Files.ReadJPEG
Reads a JPEG file from the file system.
All
4.3
Files.ReadPDF
Reads a PDF file from the file system.
All
4.3
Files.ReadPNG
Reads a PNG file from the file system.
All
4.3
Files.RenameFile
Renames a file or folder without user interface.
All
2.8
Files.ResolveAlias
Resolves an alias file.
Mac/Win/iOS
8.4
Files.ResolveBookmark
Resolves a bookmark.
Mac/iOS
3.1
Files.SetAudioTags
Sets audio tags for audio file.
Mac/Win/Linux
9.4
Files.SetComment
Sets the file comment.
Mac only
6.2
Files.SetCreationDate
Sets the file creation date.
Mac/Win/iOS
7.2
Files.SetExcludedFromBackup
Sets file backup exclusion of a file or folder.
Mac only
12.0
Files.SetFileExtensionHidden
Sets the hidden state for the file extension of a file or folder.
Mac only
12.0
Files.SetFinderLabel
Sets the Finder label.
Mac only
6.2
Files.SetHidden
Sets the hidden state for a file or folder.
Mac/Win
7.1
Files.SetModificationDate
Sets the file modification date.
All
7.2
Files.SetPosixPermissions
Sets posix file permissions.
Mac/Linux/iOS
4.3
Files.SetReadOnly
Sets the read only flag for a file or folder.
Win only
12.5
Files.SetTagNames
Sets the tags for a file/folder.
Mac only
3.5
Files.StandardizePath
Standardized a path.
All
10.3
Files.StartDownloadingUbiquitousItem
Starts download of a cloud hosted file.
Mac/iOS
13.4
Files.UbiquitousItemStatus
Queres status of a ubiquitous item.
Mac/iOS
13.4
Files.Unmount
Unmount a volume.
Mac/Win/Linux
5.1
Files.WriteFile
Writes a file with the given data.
All
3.5
Folders.Applications
Queries path to applications folder.
Mac/Win/iOS
4.3
Folders.LocalFonts
Queries path to local font folder.
Mac only
4.3
Folders.LocalPreferences
Queries path to local preferences folder.
Mac/Win/iOS
4.3
Folders.SharedDocuments
Queries path to shared documents folder.
All
4.3
Folders.System
Queries system folder.
Mac/Win/iOS
4.3
Folders.SystemFonts
Queries path to system font folder.
Mac/Win
4.3
Folders.SystemTemporary
Queries temporary folder.
All
4.3
Folders.UserTemporary
Queries temporary folder.
All
6.2
Folders.Windows
Queries path to windows folder.
Win only
4.3
Font.CalculateTextFits
Queries how many characters would fit in a space.
Mac/Win/iOS
8.4
Font.CalculateTextHeight
Calculates height of text.
Mac/Win/iOS
8.4
Font.CalculateTextWidth
Calculates width of text.
Mac/Win/iOS
6.5
FontManager.FontFile
Queries the native file path to a font file.
Mac only
6.2
FontManager.ImageWithSystemSymbolName
Queries SF Symbol font for characters and returns them as image.
Mac/iOS
10.5
FontManager.ListFontFamilies
Queries a list of font families.
Mac/Win/iOS
5.1
FontManager.ListFonts
Queries list of all fonts or list of fonts of a family.
Mac/Win
5.1
GMImage.AdaptiveThreshold
Local adaptive threshold image.
All
2.0
GMImage.AddNoise
Add noise to image with specified noise type.
All
2.0
GMImage.AddNoiseChannel
Add noise to image with specified noise type.
All
2.0
GMImage.AddPathArcAbs
Draw a single arc segment.
All
4.1
GMImage.AddPathArcRel
Draw a single arc segment.
All
4.1
GMImage.AddPathClosePath
Closes subpath.
All
4.1
GMImage.AddPathCurvetoAbs
Draw a single curve.
All
4.1
GMImage.AddPathCurvetoRel
Draw a single curve.
All
4.1
GMImage.AddPathLinetoAbs
Draw to a single point.
All
4.1
GMImage.AddPathLinetoHorizontalAbs
Draws a horizontal line from the current point (cpx, cpy) to (x, cpy).
All
4.1
GMImage.AddPathLinetoHorizontalRel
Draws a horizontal line from the current point (cpx, cpy) to (x, cpy).
All
4.1
GMImage.AddPathLinetoRel
Draw to a single point.
All
4.1
GMImage.AddPathLinetoVerticalAbs
Draws a vertical line from the current point (cpx, cpy) to (cpx, y).
All
4.1
GMImage.AddPathLinetoVerticalRel
Draws a vertical line from the current point (cpx, cpy) to (cpx, y).
All
4.1
GMImage.AddPathMovetoAbs
Simple moveto with absolute coordinate.
All
4.1
GMImage.AddPathMovetoRel
Simple moveto with relative coordinate.
All
4.1
GMImage.AddPathQuadraticCurvetoAbs
Draw a single curve.
All
4.1
GMImage.AddPathQuadraticCurvetoRel
Draw a single curve.
All
4.1
GMImage.AddPathSmoothCurvetoAbs
Adds a smooth curve to path.
All
4.1
GMImage.AddPathSmoothCurvetoRel
Draw a single curve.
All
4.1
GMImage.AddPathSmoothQuadraticCurvetoAbs
Adds smooth quadratic curve to relative point to current path.
All
4.1
GMImage.AddPathSmoothQuadraticCurvetoRel
Adds smooth quadratic curve to relative point to current path.
All
4.1
GMImage.Affine
Applies an affine transformation.
All
4.1
GMImage.Annotate
Annotate image (draw text on image).
All
2.0
GMImage.AutoOrient
Orient image to be right-side up based on its current orientation attribute.
All
9.0
GMImage.AveragePixelValue
Calculates the average pixel value.
All
3.0
GMImage.BaseColumns
Returns the base image width (before transformations).
All
2.0
GMImage.BaseFilename
Returns the Base image filename (before transformations)
All
2.0
GMImage.BaseRows
Returns the base image height (before transformations)
All
2.0
GMImage.Blur
Blur image with specified blur factor.
All
2.0
GMImage.BlurChannel
Blur image with specified blur factor.
All
2.0
GMImage.Border
Border image (add border to image).
All
2.0
GMImage.BoundingBox
Returns smallest bounding box enclosing non-border pixels.
All
2.0
GMImage.Channel
Extract channel from image.
All
2.0
GMImage.Charcoal
Charcoal effect image (looks like charcoal sketch).
All
2.0
GMImage.Chop
Chop image (remove vertical or horizontal subregion of image).
All
2.0
GMImage.ClipMask
Associate a clip mask with the image.
All
2.0
GMImage.ClipPath
Select a drawing clip path matching name.
All
4.1
GMImage.Coders
Lists all coders as JSON.
All
8.4
GMImage.Colorize
Colorize image with pen color, using specified percent opacity.
All
2.0
GMImage.ColorizeRGB
Colorize image with pen color, using specified percent opacity for red, green, and blue quantums.
All
2.0
GMImage.Columns
Returns the Image width.
All
2.0
GMImage.Compare
Compares current image with another image.
All
2.0
GMImage.Composite
Compose an image onto another at specified offset and using specified algorithm.
All
2.0
GMImage.CompositeXY
Compose an image onto another at specified offset and using specified algorithm.
All
2.0
GMImage.Contrast
Contrast image (enhance intensity differences in image).
All
2.0
GMImage.Copy
Creates a copy of the picture.
All
2.0
GMImage.CopyChannel
Copies one channel from one image into channel of other image.
All
7.3
GMImage.Crop
Crop image (subregion of original image).
All
2.0
GMImage.CycleColormap
Cycle image colormap.
All
2.0
GMImage.Describe
Describes an image by printing its attributes.
All
13.3
GMImage.Despeckle
Despeckle image (reduce speckle noise).
All
2.0
GMImage.Directory
Returns the directory string.
All
2.0
GMImage.DrawArc
Draws an arc.
All
3.0
GMImage.DrawCircle
Draws a circle.
All
3.0
GMImage.DrawEllipse
Draw an ellipse.
All
3.0
GMImage.DrawLine
Draws a line.
All
3.0
GMImage.DrawPath
Draw on image using vector path.
All
4.1
GMImage.DrawRectangle
Draws a rectangle.
All
3.0
GMImage.DrawRoundRectangle
Draw a rounded rectangle.
All
3.0
GMImage.Edge
Edge image (hilight edges in image)
All
2.0
GMImage.Emboss
Emboss image (hilight edges with 3D effect).
All
2.0
GMImage.Enhance
Enhance image (minimize noise)
All
2.0
GMImage.Equalize
Equalize image (histogram equalization)
All
2.0
GMImage.Erase
Erase image to current "background color"
All
2.0
GMImage.ExifThumbnail
Extracts an embedded thumbnail in EXIF data.
All
10.1
GMImage.Extent
Extends image size.
All
9.0
GMImage.FillPattern
Sets the pattern to use while filling drawn objects.
All
2.0
GMImage.FindColorInColumn
Locates first pixel in the column with given color.
All
5.0
GMImage.FindColorInRow
Locates first pixel in the row with given color.
All
5.0
GMImage.Flip
Flip image (reflect each scanline in the vertical direction)
All
2.0
GMImage.FloodFillColor
Flood-fill color across pixels.
All
2.0
GMImage.FloodFillColorXY
Flood-fill color across pixels starting at target-pixel and stopping at pixels matching specified border color.
All
2.0
GMImage.FloodFillOpacity
Floodfill pixels matching color (within fuzz factor) of target pixel(x,y) with replacement opacity value using method.
All
2.0
GMImage.FloodFillTexture
Flood-fill texture across pixels.
All
2.0
GMImage.FloodFillTextureXY
Flood-fill texture across pixels.
All
2.0
GMImage.Flop
Flop image (reflect each scanline in the horizontal direction)
All
2.0
GMImage.FontMap
Queries current font map in use.
All
10.1
GMImage.FontTypeMetrics
Queries space needed for text.
All
7.3
GMImage.Format
Long image format description.
All
2.0
GMImage.Frame
Frame image.
All
2.0
GMImage.Free
Releases the image from memory.
All
8.4
GMImage.FreeAll
Destroys all images.
All
8.4
GMImage.Gamma
Gamma correct image.
All
2.0
GMImage.GaussianBlur
Gaussian blur image.
All
2.0
GMImage.GaussianBlurChannel
Gaussian blur image.
All
2.0
GMImage.Geometry
Preferred size of the image when encoding.
All
2.0
GMImage.GetAdjoin
Get adjoin value. Join images into a single multi-image file
All
2.0
GMImage.GetAnimationDelay
Queries the animation delay.
All
2.0
GMImage.GetAnimationIterations
Queries the Number of iterations to loop an animation (e.g. Netscape loop extension) for.
All
2.0
GMImage.GetAntiAlias
Returns whether to Anti-alias Postscript and TrueType fonts (default true)
All
2.0
GMImage.GetAttribute
Query a named attribute.
All
2.0
GMImage.GetAttributeNames
Queries names of all attributes.
All
9.2
GMImage.GetAttributesJSON
Queries all attributes as JSON.
All
9.2
GMImage.GetBackgroundColor
Queries the Image background color.
All
2.0
GMImage.GetBackgroundTexture
Queries the Name of texture image to tile onto the image background.
All
2.0
GMImage.GetBorderColor
Queries the Image border color.
All
2.0
GMImage.GetBoxColor
Queries the Text bounding-box base color (default none).
All
2.0
GMImage.GetChannelDepth
Obtain modulus channel depth
All
2.0
GMImage.GetClassType
Queries the Image class.
All
2.0
GMImage.GetClipMask
Queries clip mask image.
All
7.3
GMImage.GetColorFuzz
Queries the color fuzz. Colors within this distance are considered equal
All
2.0
GMImage.GetColorMapSize
Queries the Colormap size (number of colormap entries)
All
2.0
GMImage.GetColorSpace
Queries the Image Color Space
All
2.0
GMImage.GetComment
Queries the comment.
All
2.0
GMImage.GetCompose
Queries the Composition operator to be used when composition is implicitly used (such as for image flattening).
All
2.0
GMImage.GetCompressType
Queries the compression type.
All
2.0
GMImage.GetDebug
Queries whether printing of debug messages from ImageMagick is enabled.
All
2.0
GMImage.GetDefineSet
Queries a define value.
All
2.0
GMImage.GetDefineValue
Queries a value.
All
2.0
GMImage.GetDensity
Queries the Vertical and horizontal resolution in pixels of the image.
All
2.0
GMImage.GetDepth
Queries the Image depth (bits allocated to red/green/blue components)
All
2.0
GMImage.GetEXIFOrientation
Queries orientation from EXIF.
All
6.5
GMImage.GetEndian
Queries the Endianness (little like Intel or big like SPARC) for image formats which support endian-specific options.
All
2.0
GMImage.GetFileName
Queries the Image file name.
All
2.0
GMImage.GetFileSize
Returns the number of bytes of the image on disk
All
2.0
GMImage.GetFillColor
Queries the Color to use when filling drawn objects.
All
2.0
GMImage.GetFillRule
Queries the rule to use when filling drawn objects
All
2.0
GMImage.GetFilterType
Queries the Filter to use when resizing image
All
2.0
GMImage.GetFont
Queries the Text rendering font.
All
2.0
GMImage.GetFontFamily
Queries font family.
All
10.4
GMImage.GetFontPointsize
Queries the Font point size.
All
2.0
GMImage.GetFontStretch
Queries font stretch.
All
10.4
GMImage.GetFontStyle
Queries font style.
All
10.4
GMImage.GetFontWeight
Queries font weight.
All
10.4
GMImage.GetGamma
Gamma level of the image
All
2.0
GMImage.GetGifDisposeMethod
Queries the GIF disposal method.
All
2.0
GMImage.GetHeight
Returns the image height.
All
2.0
GMImage.GetICCColorProfile
Queries the ICC color profile.
All
2.0
GMImage.GetIPTCProfile
Queries the IPTC profile.
All
2.0
GMImage.GetIPTCProfileValues
Queries list with all IPTC values found.
All
6.2
GMImage.GetInterlaceType
Queries the interlace type.
All
2.0
GMImage.GetIsValid
Does object contain valid image?
All
2.0
GMImage.GetJPEGAsBase64
Returns the picture in JPEG format as a base64 encoded string.
All
3.0
GMImage.GetJPEGAsHex
Returns the picture in JPEG format as a hex encoded string.
All
3.0
GMImage.GetLabel
Queries the image label.
All
2.0
GMImage.GetLineWidth
Queries the Stroke width for drawing vector objects (default one)
All
2.0
GMImage.GetMagick
Queries the File type magick identifier.
All
2.0
GMImage.GetMatte
Queries the image supports transparency (matte channel)
All
2.0
GMImage.GetMatteColor
Queries the Transparent color.
All
2.0
GMImage.GetModulusDepth
Queries the image modulus depth.
All
2.0
GMImage.GetMonochrome
Queries the monochrome flag. Transform image to black and white
All
2.0
GMImage.GetOrientation
Queries the image orientation.
All
2.0
GMImage.GetPNGAsBase64
Returns the picture in PNG format as a base64 encoded string.
All
3.0
GMImage.GetPNGAsHex
Returns the picture in PNG format as a hex encoded string.
All
3.0
GMImage.GetPage
Queries the Preferred size and location of an image canvas.
All
2.0
GMImage.GetPixelColor
Get pixel color at location x & y.
All
2.0
GMImage.GetProfile
Retrieve a named profile from the image.
All
2.0
GMImage.GetQuality
Queries the JPEG/MIFF/PNG compression level (default 75).
All
2.0
GMImage.GetQuantizeColorSpace
Gets the Colorspace to quantize in.
All
2.0
GMImage.GetQuantizeColors
Queries the Maximum number of colors to quantize to.
All
2.0
GMImage.GetQuantizeDither
Queries whether to dither image during quantization (default true).
All
2.0
GMImage.GetQuantizeTreeDepth
Queries the Quantization tree-depth.
All
2.0
GMImage.GetQuiet
Queries quiet setting.
All
9.0
GMImage.GetRenderingIntent
Queries the type of rendering intent.
All
2.0
GMImage.GetResolutionUnits
Queries which units are used for image resolution.
All
2.0
GMImage.GetScene
Gets the image scene number
All
2.0
GMImage.GetSize
Queries the Width and height of a raw image.
All
2.0
GMImage.GetStrokeAntiAlias
Whether stroke anti-aliasing is enabled.
All
2.0
GMImage.GetStrokeColor
Queries the Color to use when drawing object outlines.
All
2.0
GMImage.GetStrokeDashArray
Queries the pattern of dashes and gaps used to stroke paths.
All
4.2
GMImage.GetStrokeDashOffset
Gets the stroke dash offset.
All
2.0
GMImage.GetStrokeLineCap
Specify the shape to be used at the end of open subpaths when they are stroked.
All
2.0
GMImage.GetStrokeLineJoin
Specify the shape to be used at the corners of paths (or other vector shapes) when they are stroked.
All
2.0
GMImage.GetStrokeMiterLimit
Gets the miter limit.
All
2.0
GMImage.GetStrokeWidth
Gets the Stroke width for drawing vector objects (default one)
All
2.0
GMImage.GetSubImage
Queries which image of an image sequence is currently used.
All
2.0
GMImage.GetSubRange
Gets the Number of images relative to the base image
All
2.0
GMImage.GetTextEncoding
Queries the text encoding.
All
2.0
GMImage.GetTileName
Queries the Tile name.
All
2.0
GMImage.GetType
Image representation type.
All
2.0
GMImage.GetVerbose
Queries whether to print detailed information about the image
All
2.0
GMImage.GetView
Queries the FlashPix viewing parameters.
All
2.0
GMImage.GetWidth
Returns the Image width.
All
2.0
GMImage.GetXMP
Query XMP data.
All
6.3
GMImage.GetZPL
Queries image as ZPL hex image.
All
10.3
GMImage.GetcolorMap
Queries an entry in the color map.
All
2.0
GMImage.Hash
Calculates a hash of the image.
All
9.4
GMImage.ImageCount
Queries number of open images.
All
5.0
GMImage.Implode
Implode image (special effect).
All
2.0
GMImage.InvertChannel
Inverts an image.
All
8.4
GMImage.IsGray
Checks whether all pixels are gray.
All
8.3
GMImage.IsLoggingEnabled
Checks whether logging is enabled.
All
11.1
GMImage.Level
Level image.
All
2.0
GMImage.LevelChannel
Level image channel.
All
2.0
GMImage.List
Lists all IDs of images in memory.
All
8.1
GMImage.ListTypeInfo
Writes type list file.
All
10.4
GMImage.MagickVersion
Queries the version text of the GraphicsMagick library.
All
10.4
GMImage.Magnify
Magnify image by integral size.
All
2.0
GMImage.Map
Remap image colors with closest color from reference image.
All
2.0
GMImage.MatteFloodfill
Floodfill designated area with replacement opacity value.
All
2.0
GMImage.MeanErrorPerPixel
The mean error per pixel computed when an image is color reduced.
All
2.0
GMImage.MedianFilter
Filter image by replacing each pixel component with the median color in a circular neighborhood.
All
2.0
GMImage.Minify
Reduce image by integral size.
All
2.0
GMImage.Modulate
Modulate percent hue, saturation, and brightness of an image.
All
2.0
GMImage.MontageGeometry
Tile size and offset within an image montage.
All
2.0
GMImage.MotionBlur
Motion blur image with specified blur factor.
All
2.0
GMImage.MultiplyChannel
Multiplies all values in a channel.
All
5.0
GMImage.Negate
Negate colors in image.
All
2.0
GMImage.New
Construct a blank image canvas of specified size and color.
All
2.0
GMImage.NewFromBase64
Loads a picture from base64 encoded data.
All
3.0
GMImage.NewFromContainer
Loads a picture from the given container.
All
2.0
GMImage.NewFromFile
Loads a picture file.
All
2.0
GMImage.NewFromHex
Loads a picture from hex encoded data.
All
3.0
GMImage.NewImagesFromContainer
Loads a picture from the given container.
All
5.1
GMImage.NewImagesFromFile
Loads a picture file with several files.
All
5.1
GMImage.Normalize
Normalize image (increase contrast by normalizing the pixel values to span the full range of color values)
All
2.0
GMImage.NormalizedMaxError
The normalized max error per pixel computed when an image is color reduced.
All
2.0
GMImage.NormalizedMeanError
The normalized mean error per pixel computed when an image is color reduced.
All
2.0
GMImage.OilPaint
Oilpaint image (image looks like oil painting)
All
2.0
GMImage.Opacity
Set or attenuate the opacity channel in the image.
All
2.0
GMImage.Opaque
Change color of opaque pixel to specified pen color.
All
2.0
GMImage.Ping
Pings an image to query metadata.
All
10.3
GMImage.PingContainer
Pings an image to query metadata.
All
10.3
GMImage.PopClipPath
Pop (terminate) clip path definition started by GMImage.PushClipPath.
All
4.1
GMImage.PurgeTemporaryFiles
Asks GraphicsMagick to purge all temp files.
All
5.0
GMImage.PushClipPath
Push (create) clip path definition with new name.
All
4.1
GMImage.Quantize
Quantize image (reduce number of colors).
All
2.0
GMImage.QuantumDepth
Queries quantum depth of GraphicsMagick.
All
8.3
GMImage.Raise
Raise image (lighten or darken the edges of an image to give a 3-D raised or lowered effect)
All
2.0
GMImage.RandomThreshold
Random threshold image.
All
2.0
GMImage.RandomThresholdChannel
Random threshold image.
All
2.0
GMImage.Read
Read single image frame into current object.
All
8.3
GMImage.ReadContainer
Read single image frame into current object.
All
10.2
GMImage.ReduceNoise
Reduce noise in image using a noise peak elimination filter.
All
2.0
GMImage.Release
Releases the image from memory.
All
2.0
GMImage.ReleaseAll
Destroys all images.
All
7.0
GMImage.Repage
Resets the image page canvas and position.
All
9.0
GMImage.ReplaceColor
Replaces a color with another color value for the whole image.
All
4.3
GMImage.Resize
Resize image, specifying geometry, filter, and blur.
All
9.0
GMImage.Roll
Roll image (rolls image vertically and horizontally) by specified number of columnms and rows)
All
2.0
GMImage.Rollxy
Roll image (rolls image vertically and horizontally) by specified number of columnms and rows)
All
2.0
GMImage.Rotate
Rotate image by specified number of degrees.
All
2.0
GMImage.Rotating
Set rotation to use when drawing.
All
4.1
GMImage.Rows
Returns the image height.
All
2.0
GMImage.Sample
Resize image by using pixel sampling algorithm.
All
2.0
GMImage.Scale
Resize image by using simple ratio algorithm.
All
2.0
GMImage.Scaling
Apply scaling in x and y direction while drawing objects.
All
4.1
GMImage.Segment
Segments the image.
All
2.0
GMImage.SetAdjoin
Set adjoin value. Join images into a single multi-image file
All
2.0
GMImage.SetAnimationDelay
Sets the animation delay.
All
2.0
GMImage.SetAnimationIterations
Sets the Number of iterations to loop an animation (e.g. Netscape loop extension) for.
All
2.0
GMImage.SetAntiAlias
Sets whether to Anti-alias Postscript and TrueType fonts (default true)
All
2.0
GMImage.SetAttribute
Set a named attribute.
All
2.0
GMImage.SetBackgroundColor
Sets the Image background color.
All
2.0
GMImage.SetBackgroundTexture
Sets the Name of texture image to tile onto the image background
All
2.0
GMImage.SetBorderColor
Sets the Image border color.
All
2.0
GMImage.SetBoxColor
Text bounding-box base color (default none).
All
2.0
GMImage.SetClassType
Sets the Image class.
All
2.0
GMImage.SetColorFuzz
Sets the color fuzz.
All
2.0
GMImage.SetColorMapSize
Sets the Colormap size (number of colormap entries)
All
2.0
GMImage.SetColorSpace
Sets the Image Color Space.
All
2.0
GMImage.SetComment
Sets the image comment.
All
2.0
GMImage.SetCompose
Sets the Composition operator to be used when composition is implicitly used (such as for image flattening).
All
2.0
GMImage.SetCompressType
Sets the compression type.
All
2.0
GMImage.SetDebug
Enables printing of debug messages from ImageMagick
All
2.0
GMImage.SetDefineSet
Sets a define value.
All
2.0
GMImage.SetDefineValue
Sets a value.
All
2.0
GMImage.SetDensity
Sets the Vertical and horizontal resolution in pixels of the image.
All
2.0
GMImage.SetDepth
Sets the Image depth (bits allocated to red/green/blue components)
All
2.0
GMImage.SetEXIFOrientation
Sets orientation for EXIF.
All
6.5
GMImage.SetEndian
Sets the Endianness (little like Intel or big like SPARC) for image formats which support endian-specific options.
All
2.0
GMImage.SetFileName
Sets the Image file name.
All
2.0
GMImage.SetFillColor
Sets the Color to use when filling drawn objects.
All
2.0
GMImage.SetFillRule
Sets the rule to use when filling drawn objects
All
2.0
GMImage.SetFilterType
Sets the Filter to use when resizing image.
All
2.0
GMImage.SetFont
Sets the Text rendering font.
All
2.0
GMImage.SetFontFamily
Set font family to use.
All
10.4
GMImage.SetFontPointsize
Sets the font point size.
All
2.0
GMImage.SetFontStretch
Set font stretch.
All
10.4
GMImage.SetFontStyle
Set font style.
All
10.4
GMImage.SetFontWeight
Sets font weight.
All
10.4
GMImage.SetGifDisposeMethod
Sets the GIF disposal method.
All
2.0
GMImage.SetICCColorProfile
Sets the ICC color profile.
All
2.0
GMImage.SetIPTCProfile
Sets the IPTC profile.
All
2.0
GMImage.SetInterlaceType
Sets the interlace type.
All
2.0
GMImage.SetIsValid
Sets whether the object contain a valid image.
All
2.0
GMImage.SetLabel
Sets the image label.
All
2.0
GMImage.SetLineWidth
Sets the Stroke width for drawing vector objects (default one)
All
2.0
GMImage.SetLogEventMask
Set log event mask.
All
11.1
GMImage.SetMagick
Sets the File type magick identifier (.e.g "GIF")
All
2.0
GMImage.SetMatte
Sets whether image supports transparency (matte channel)
All
2.0
GMImage.SetMatteColor
Sets the Transparent color.
All
2.0
GMImage.SetModulusDepth
Sets the Image modulus depth.
All
2.0
GMImage.SetMonochrome
If set, transform image to black and white.
All
2.0
GMImage.SetOrientation
Sets the image orientation.
All
2.0
GMImage.SetPage
Sets the Preferred size and location of an image canvas.
All
2.0
GMImage.SetPixelColor
set pixel color at location x & y.
All
2.0
GMImage.SetProfile
Add or remove a named profile to/from the image.
All
2.0
GMImage.SetQuality
Sets the JPEG/MIFF/PNG compression level (default 75).
All
2.0
GMImage.SetQuantizeColorSpace
Sets the Colorspace to quantize in.
All
2.0
GMImage.SetQuantizeColors
Sets the Maximum number of colors to quantize to
All
2.0
GMImage.SetQuantizeDither
Sets whether to dither image during quantization (default true).
All
2.0
GMImage.SetQuantizeTreeDepth
Sets the Quantization tree-depth.
All
2.0
GMImage.SetQuiet
Sets quiet setting.
All
9.0
GMImage.SetRenderingIntent
Sets the type of rendering intent
All
2.0
GMImage.SetResolutionUnits
Sets which units are used for image resolution.
All
2.0
GMImage.SetScene
Sets the image scene number
All
2.0
GMImage.SetSize
Sets the Width and height of a raw image
All
2.0
GMImage.SetStrokeAntiAlias
Enables/disables stroke anti-aliasing.
All
2.0
GMImage.SetStrokeColor
Sets the Color to use when drawing object outlines.
All
2.0
GMImage.SetStrokeDashArray
Specify the pattern of dashes and gaps used to stroke paths.
All
4.2
GMImage.SetStrokeDashOffset
Sets the stroke dash offset.
All
2.0
GMImage.SetStrokeLineCap
Specify the shape to be used at the end of open subpaths when they are stroked.
All
2.0
GMImage.SetStrokeLineJoin
Specify the shape to be used at the corners of paths (or other vector shapes) when they are stroked.
All
2.0
GMImage.SetStrokeMiterLimit
Sets the miter limit.
All
2.0
GMImage.SetStrokeWidth
Sets the Stroke width for drawing vector objects (default one)
All
2.0
GMImage.SetSubImage
Selects which image of an image sequence is currently used.
All
2.0
GMImage.SetSubRange
Sets the Number of images relative to the base image
All
2.0
GMImage.SetTextEncoding
Sets the Annotation text encoding (e.g. "UTF-16")
All
2.0
GMImage.SetTileName
Sets the Tile name.
All
2.0
GMImage.SetType
Sets the Image representation type.
All
2.0
GMImage.SetVerbose
Sets whether to print detailed information about the image.
All
2.0
GMImage.SetView
Sets the FlashPix viewing parameters.
All
2.0
GMImage.SetXMP
Sets the XMP data.
All
6.3
GMImage.SetchannelDepth
Set modulus channel depth
All
2.0
GMImage.SetcolorMap
Sets an entry in the color map.
All
2.0
GMImage.Shade
Shade image using distant light source.
All
2.0
GMImage.Sharpen
Sharpen pixels in image.
All
2.0
GMImage.SharpenChannel
Sharpen pixels in image
All
2.0
GMImage.Shave
Shave pixels from image edges.
All
2.0
GMImage.Shear
Shear image (create parallelogram by sliding image by X or Y axis).
All
2.0
GMImage.Signature
Image signature. Set force to 1 in order to re-calculate the signature regardless of whether the image data has been modified.
All
2.0
GMImage.SkewX
Apply Skew in X direction.
All
4.1
GMImage.SkewY
Apply Skew in Y direction.
All
4.1
GMImage.Solarize
Solarize image (similar to effect seen when exposing a photographic film to light during the development process).
All
2.0
GMImage.Spread
Spread pixels randomly within image by specified ammount.
All
2.0
GMImage.Statistics   New in 14.1
Calculate statistics for an image.
All
14.1
GMImage.Stegano
Add a digital watermark to the image (based on second image)
All
2.0
GMImage.Stereo
Create an image which appears in stereo when viewed with red-blue glasses (Red image on left, blue on right)
All
2.0
GMImage.Strip
Remove all profiles and text attributes from the image.
All
3.5
GMImage.StrokePattern
Sets the pattern image to use while stroking object outlines.
All
2.0
GMImage.Swirl
Swirl image (image pixels are rotated by degrees).
All
2.0
GMImage.Texture
Channel a texture on image background.
All
2.0
GMImage.Threshold
Threshold image channels (below threshold becomes black, above threshold becomes white).
All
2.0
GMImage.TotalColors
Number of colors in the image
All
2.0
GMImage.Transform
Transform image based on image and crop geometries.
All
2.0
GMImage.TransformOrigin
Origin of coordinate system to use when annotating with text or drawing.
All
2.0
GMImage.TransformReset
Reset transformation parameters to default.
All
2.0
GMImage.TransformRotation
Rotation to use when annotating with text or drawing.
All
2.0
GMImage.TransformScale
Scale to use when annotating with text or drawing.
All
2.0
GMImage.TransformSkewX
Skew to use in X axis when annotating with text or drawing.
All
2.0
GMImage.TransformSkewY
Skew to use in Y axis when annotating with text or drawing.
All
2.0
GMImage.Translation
Apply coordinate translation.
All
4.1
GMImage.Transparent
Add matte image to image, setting pixels matching color to transparent
All
2.0
GMImage.Trim
Trim edges that are the background color from the image.
All
2.0
GMImage.Unsharpmask
Replace image with a sharpened version of the original image using the unsharp mask algorithm.
All
2.0
GMImage.UnsharpmaskChannel
Replace image with a sharpened version of the original image using the unsharp mask algorithm.
All
2.0
GMImage.Wave
Map image pixels to a sine wave:
All
2.0
GMImage.WriteImages
Writes several images to disk.
All
3.4
GMImage.WriteToBMPContainer
Writes the picture in BMP format to a container object which you can store in a container field.
All
2.4
GMImage.WriteToContainer
Writes images as is into a container.
All
9.3
GMImage.WriteToFile
Write single image frame to a file.
All
2.0
GMImage.WriteToGIFContainer
Writes the picture in GIF format to a container value which you can store in a container field.
All
2.4
GMImage.WriteToJPEGContainer
Writes the picture in JPEG format to a container value which you can store in a container field.
All
2.0
GMImage.WriteToPDFContainer
Writes the picture in PDF format to a container value which you can store in a container field.
All
7.4
GMImage.WriteToPNGContainer
Writes the picture in PNG format to a container value which you can store in a container field.
All
2.0
GMImage.WriteToTiffContainer
Writes the picture in TIFF format to a container value which you can store in a container field.
All
4.4
GMImage.WriteToWebPContainer
Writes the picture in WebP format to a container value which you can store in a container field.
All
13.2
GMImage.XResolution
Returns the x resolution of the image.
All
2.0
GMImage.YResolution
Returns the y resolution of the image.
All
2.0
GMImage.Zoom
Zoom image to specified size.
All
2.0
GZipFile.Compress
Compresses a file.
All
4.2
GZipFile.Decompress
Decompresses a file.
All
4.2
HadErrors
Queries error counter.
All
12.2
Hash.CRC32
Calculates 32bit CRC value.
All
8.3
Hash.Digest
Calculates a hash of a value.
All
4.1
Hash.DigestFile
Calculates a hash of a file.
All
9.2
Hash.MD5
Calculated MD5 hash of given text.
All
2.7
Hash.MD5.HMAC
Returns the a MD5 HMAC based on the key and the data string.
All
4.0
Hash.PBKDF2.HMAC
Returns the PBKDF2 hash value of the data, first applying the salt value and using the specified hashAlgorithm.
All
3.3
Hash.RandomHexString
Creates a random hex string.
All
3.3
Hash.RandomString
Creates a random string.
All
3.1
Hash.SHA1
Calculated SHA-1 hash of given text.
All
3.1
Hash.SHA1.HMAC
Returns the a SHA1 HMAC based on the key and the data string.
All
3.1
Hash.SHA256
Calculated SHA-256 hash of given text.
All
3.1
Hash.SHA256.HMAC
Returns the a SHA256 HMAC based on the key and the data string.
All
3.1
Hash.SHA512
Calculated SHA-512 hash of given text.
All
2.7
Hash.SHA512.HMAC
Returns the a SHA512 HMAC based on the key and the data string.
All
4.0
IBAN.CalcCheckSum
Calculates the checksum.
All
11.1
IBAN.Compact
Formats the IBAN for compact view.
All
11.1
IBAN.Countries
Queries list of country codes.
All
11.1
IBAN.Example
Queries example IBAN for country.
All
11.1
IBAN.Format
Formats the IBAN for printing.
All
11.1
IBAN.IsValid
Checks whether an IBAN is valid.
All
11.1
IBAN.RegEx
Queries regular expression for country.
All
11.1
Icon.ClearIcon
Clears the custom icon for the file or directory at the specified path.
Mac only
2.7
Icon.GetIcon
Queries the Finder icon for the file or folder with the given path.
Mac/Win
2.3
Icon.GetIconWithQuickLook
Queries the Finder icon for the file or folder with the given path.
Mac/Win
2.3
Icon.SetIcon
Sets the icon for the file or directory at the specified path.
Mac only
2.7
ImageView.List
Lists all IDs of image view objects.
Mac/iOS
13.0
Is64bit
Checks if platform is 64bit or 32bit.
All
5.0
IsClient
Checks if plugin is running on a client.
All
4.3
IsError
Checks whether last plugin function returned error.
All
3.4
IsIOS
Whether we run on iOS.
All
6.1
IsIOSDevice
Queries whether run on iOS device.
All
8.0
IsIOSSimulator
Queries whether run on iOS simulator.
All
8.0
IsLinux
Whether we run on Linux.
All
6.1
IsMacOS
Whether we run on Mac.
All
6.1
IsMobile
Whether plugin runs on a mobile target.
All
7.2
IsRegistered
Queries if plugin is registered with Complete key.
All
3.0
IsRuntime
Checks if plugin is running on a runtime.
All
4.3
IsServer
Checks if plugin is running on a server.
All
4.3
IsWindows
Whether we run on Windows.
All
6.1
JS.AddFileMakerEvaluateFunction
Adds an Evaluate function.
All
10.0
JS.AddFileMakerRunScriptFunction
Adds a function to start scripts from JavaScript.
All
10.0
JS.AddFileMakerSQLFunction
Defines a SQL Evaluate function for JavaScript.
All
10.0
JS.AddFunction
Adds a global function defined as a text string.
All
10.0
JS.CF
Calls a global function given the name with FileMaker values.
All
11.3
JS.CallFunction
Calls a global function given the name with JSON data.
All
10.0
JS.CallFunctionValues
Calls a global function given the name with FileMaker values.
All
11.3
JS.Evaluate
Evaluates a JavaScript expression.
All
10.0
JS.EvaluateToString
Evaluates a JavaScript expression.
All
10.0
JS.GetGlobalProperty
Queries global property.
All
10.0
JS.GetGlobalPropertyValue
Queries global property.
All
10.0
JS.InitModules
Installs Duktape module loading.
All
11.2
JS.List
Lists all JavaScript object references.
All
11.3
JS.New
Creates a new JavaScript engine instance.
All
10.0
JS.Now
Queries current time as double value.
All
10.1
JS.ObjectCount
Queries global object counter.
All
10.1
JS.Release
Frees the JavaScript engine.
All
10.0
JS.ReleaseAll
Release all JavaScript environments.
All
10.5
JS.SetGlobalProperty
Sets a global property.
All
10.0
JS.SetGlobalPropertyValue
Sets a global property.
All
10.0
JS.StringCount
Queries global string counter.
All
10.1
JS.TimeToDateComponents
Converts time to date components.
All
10.1
JS.TimeToUTCDate
Converts time value to timestamp.
All
10.1
JS.UTCDateToTime
Converts date to time value.
All
10.1
JSON.AddArrayToArray
Adds an array to an existing array.
All
10.2
JSON.AddBooleanToObject
Adds a boolean value to an array.
All
6.0
JSON.AddFalseToObject
Adds a new entry to the object with the given name and a boolean false value.
All
2.7
JSON.AddItemToArray
Adds an item to an array.
All
2.7
JSON.AddItemToObject
Adds a new entry to the object with the given name and value.
All
2.7
JSON.AddNullToObject
Adds a new entry to the object with the given name and a null value.
All
2.7
JSON.AddNumberToArray
Adds a number to an array.
All
4.3
JSON.AddNumberToObject
Adds a new entry to the object with the given name and value.
All
2.7
JSON.AddStringToArray
Adds a string to an array.
All
4.3
JSON.AddStringToObject
Adds a new entry to the object with the given name and value.
All
2.7
JSON.AddTrueToObject
Adds a new entry to the object with the given name and a boolean true value.
All
2.7
JSON.AddValueToArray   New in 14.1
Adds a value to an array.
All
14.1
JSON.AddValueToObject   New in 14.1
Adds a new entry to the object with the given name and value.
All
14.1
JSON.Clone
Creates a clone of the json.
All
6.1
JSON.Colorize
Formats a JSON string with color.
All
8.2
JSON.Compact
Returns compact unformatted JSON for the given JSON text.
All
2.7
JSON.CreateArray
Creates new array.
All
2.7
JSON.CreateArrayRef
Creates empty array reference.
All
6.0
JSON.CreateBool
Creates boolean JSON node.
All
2.7
JSON.CreateBoolean
Creates a boolean node with given value.
All
6.0
JSON.CreateDoubleArray
Creates a new JSON with a double array with given values.
All
2.7
JSON.CreateFalse
Creates a boolean node with false value.
All
2.7
JSON.CreateIntegerArray
Creates a new JSON with an integer array with given values.
All
4.3
JSON.CreateNull
Creates a new NULL entry.
All
2.7
JSON.CreateNumber
Creates a new JSON encoded number.
All
2.7
JSON.CreateObject
Creates a new empty object node.
All
2.7
JSON.CreateObjectRef
Creates empty object reference.
All
6.0
JSON.CreateString
Creates a string node with given text.
All
2.7
JSON.CreateStringArray
Creates a new JSON with a string array with given values.
All
2.7
JSON.CreateStringArrayWithList
Creates a new JSON with a string array with given values.
All
4.1
JSON.CreateTrue
Creates a boolean node with true value.
All
2.7
JSON.CreateValue
Creates a new value.
All
9.0
JSON.DeleteItemFromArray
Deletes an item from an array.
All
2.7
JSON.DeleteItemFromObject
Deletes item from an object.
All
2.7
JSON.EqualContent
Checks if two JSON are equal in content.
All
10.0
JSON.Equals
Checks if two JSON are equal.
All
9.0
JSON.FilterObjectArray
Filters JSON object array to find matching entries.
All
13.3
JSON.FindValueInArray
Queries index of value in array.
All
9.0
JSON.FindValueInObjectArray
Queries index of value in object array.
All
9.0
JSON.Flatten
Flattens a json object or array to a single depth object of key-value pairs.
All
13.5
JSON.Format
Returns pretty printed JSON for the given JSON text.
All
4.4
JSON.GetArrayItem
Queries entry from array with given index.
All
2.7
JSON.GetArrayItems
Queries entries from JSON array.
All
10.4
JSON.GetArrayItemsAsList
Queries a list of all array entries.
All
4.2
JSON.GetArrayItemsAsQuickList
Queries array values as QuickList.
All
13.3
JSON.GetArrayPathItems
Queries value from JSON path in array of objects.
All
7.1
JSON.GetArraySize
Queries the number of array entries.
All
2.7
JSON.GetBooleanValue
Queries boolean value for JSON.
All
10.3
JSON.GetDoubleValue
Queries a floating point value of the JSON node.
All
2.7
JSON.GetIntegerValue
Queries integer value of the JSON node.
All
2.7
JSON.GetObjectItem
Queries named item from an object.
All
2.7
JSON.GetObjectItemTree
Queries named item from an object tree.
All
3.2
JSON.GetObjectItemTreeRef
Queries named item from an object tree.
All
6.0
JSON.GetObjectName
Queries name of item in an object.
All
4.0
JSON.GetObjectNameList
Queries names of items in an object.
All
4.0
JSON.GetObjectSize
Queries the number of object items.
All
4.0
JSON.GetPathItem
Queries value from JSON path.
All
6.1
JSON.GetStringValue
Queries string value of the JSON node.
All
2.7
JSON.GetType
Queries type of json object.
All
2.7
JSON.GetValue
Queries the value of the json.
All
6.1
JSON.Import
Imports JSON and creates tables, fields and records.
All
5.4
JSON.Import.Cancel
Cancels current import.
All
5.4
JSON.Import.ErrorCount
Queries error counter.
All
9.3
JSON.Import.Errors
Queries list of error messages.
All
9.3
JSON.Import.Status
Queries status of xml import.
All
5.4
JSON.Import.Todo
Queries how many items are to be done for XML import.
All
5.4
JSON.Import.Total
Queries total items to be imported.
All
5.4
JSON.Import.Work
Performs import.
All
5.4
JSON.IsValid
Checks if JSON text is valid.
All
6.3
JSON.JSONPatch.ApplyPatch   New in 14.0
Applies a patch to a json document.
All
14.0
JSON.JSONPatch.FromDiff   New in 14.0
Create a JSON Patch from a diff of two json documents.
All
14.0
JSON.List
Lists all IDs of current JSON objects.
All
12.5
JSON.MergePatch.ApplyPatch   New in 14.0
Applies a merge patch to a json document.
All
14.0
JSON.MergePatch.FromDiff   New in 14.0
Create a JSON Merge Patch from a diff of two json documents.
All
14.0
JSON.Parse
Parses JSON text and return reference number.
All
6.0
JSON.Query
Performs a JSON Path query.
All
13.5
JSON.Release
Frees a json reference number.
All
6.0
JSON.ReleaseAll
Releases all JSON objects.
All
6.0
JSON.Replace
Searches for all values that match the JSONPath expression and replaces them with the specified value.
All
13.5
JSON.ReplaceItemInArray
Replaces an item in an array with new item.
All
4.3
JSON.ReplaceItemInObject
Replaces an item in an object with new item.
All
4.3
JSON.Search
Performs a JMESPath query.
All
13.5
JSON.SetPathItem
Sets a value in a JSON hierarchy.
All
6.1
JSON.Sort
Sorts the JSON array/object.
All
9.3
JSON.SortWithEvaluate
Sorts the JSON array/object using an expression to evaluate.
All
10.2
JSON.Text
Queries JSON as text.
All
13.0
JSON.ToHTML
Converts JSON to HTML.
All
8.2
JSON.ToXML
Converts JSON to XML.
All
10.3
JSON.Unflatten
Unflattens that object back to the original json.
All
13.5
Java.CallObjectMethod
Calls a method on an object.
Mac/Win/Linux
6.5
Java.CallStaticMethod
Calls a static method on a class.
Mac/Win/Linux
6.5
Java.DefineClass
Defines a class.
Mac/Win/Linux
10.3
Java.FindClass
Checks if a class is available.
Mac/Win/Linux
10.3
Java.GetContainerFileName
Query container file name to use.
Mac/Win/Linux
6.5
Java.GetObjectField
Queries a field on an object.
Mac/Win/Linux
6.5
Java.GetStaticField
Queries a static field on a class.
Mac/Win/Linux
6.5
Java.Initialize
Initializes JavaVM.
Mac/Win/Linux
6.5
Java.Initialized
Checks whether Java VM is initialized.
Mac/Win/Linux
6.5
Java.List
Lists all IDs of java objects.
Mac/Win/Linux
13.0
Java.NewClassObject
Creates a new object and invokes constructor.
Mac/Win/Linux
6.5
Java.ObjectClassName
Queries name of class of an java object.
Mac/Win/Linux
6.5
Java.Release
Releases an object reference.
Mac/Win/Linux
6.5
Java.ReleaseAll
Releases all java objects.
Mac/Win/Linux
6.5
Java.SetContainerFileName
Sets the container file name to use for next containers.
Mac/Win/Linux
6.5
Java.SetObjectField
Sets a field on an object.
Mac/Win/Linux
6.5
Java.SetStaticField
Sets a static field on a class.
Mac/Win/Linux
6.5
JavaScript.Available
Checks whether the JavaScriptCore library is loaded.
All
13.1
JavaScript.CF
Calls a global function given the name with FileMaker values.
All
12.2
JavaScript.CallFunction
Calls a global function given the name with FileMaker values.
All
12.2
JavaScript.CheckScriptSyntax
Checks script syntax.
All
5.4
JavaScript.EvaluateScript
Evaluate a string of JavaScript code.
All
5.4
JavaScript.GetProperty
Queries property value as text.
All
5.4
JavaScript.GetPropertyJSON
Queries property value as JSON.
All
12.2
JavaScript.HasProperty
Checks if a property is defined.
All
5.4
JavaScript.List
Lists all IDs of javascript environment objects.
All
13.0
JavaScript.LoadLibrary
Loads the JavaScriptCore library.
All
13.1
JavaScript.New
Creates a new javascript context.
All
5.4
JavaScript.RegisterEvaluateFunction
Registers evaluate function.
All
5.4
JavaScript.RegisterFunction
Registers a javascript function.
All
5.4
JavaScript.RegisterRunScriptFunction
Registers a run script function.
All
5.4
JavaScript.RegisterSQLQueryFunction
Registers a SQLQuery function.
All
5.4
JavaScript.Release
Releases a javascript context.
All
5.4
JavaScript.ReleaseAll
Release all JavaScript environments.
All
10.5
JavaScript.SetProperty
Sets property value.
All
5.4
JavaScript.SetPropertyJSON
Sets property value using JSON.
All
12.2
LCMS.ProfileInfo
Queries profile information for an ICC Profile.
All
4.0
LDAP.AddJSON
Adds an entry to a tree.
Mac/Win/Linux
8.0
LDAP.Bind
Authenticates a client to the LDAP server.
Mac/Win/Linux
6.0
LDAP.Connect
Initializes an LDAP connection.
Mac/Win/Linux
6.0
LDAP.Delete
Removes a leaf entry from the directory tree.
Mac/Win/Linux
6.0
LDAP.GetBinaryKeys
Queries which attributes should be handled as binary data.
Mac/Win/Linux
12.5
LDAP.GetNetworkTimeOut
Queries network timeout value.
Mac/Linux
6.0
LDAP.GetProtocolVersion
Queries protocol version for this connection.
Mac/Win/Linux
6.0
LDAP.GetReferrals
Queries the referrals option.
Mac/Win/Linux
6.0
LDAP.GetTimeOut
Queries timeout value.
Mac/Linux
6.0
LDAP.JSON
Queries JSON structure of LDAP data.
Mac/Win/Linux
8.0
LDAP.List
Lists all IDs of LDAP connections.
Mac/Win/Linux
13.0
LDAP.ModifyJSON
Changes an existing entry.
Mac/Win/Linux
8.0
LDAP.Release
Releases the connection.
Mac/Win/Linux
6.0
LDAP.ReleaseAll
Release all LDAP objects.
Mac/Win/Linux
10.5
LDAP.Rename
Changes the distinguished name of an entry in the directory.
Mac/Win/Linux
6.0
LDAP.Search
Performs a search.
Mac/Win/Linux
6.0
LDAP.SearchResult.AttributeCount
Queries number of attributes for an entry.
Mac/Win/Linux
6.0
LDAP.SearchResult.AttributeName
Returns the name of an attribute in an entry.
Mac/Win/Linux
6.0
LDAP.SearchResult.AttributeNames
Queries all names of attributes for an entry as a list.
Mac/Win/Linux
6.0
LDAP.SearchResult.AttributeValue
Queries a value from search results.
Mac/Win/Linux
6.0
LDAP.SearchResult.AttributeValueCount
Queries the number of values for an attribute.
Mac/Win/Linux
6.0
LDAP.SearchResult.AttributeValues
Returns the values for an attribute in an entry.
Mac/Win/Linux
6.0
LDAP.SearchResult.AttributeValuesByName
Returns the values for an attribute in an entry.
Mac/Win/Linux
7.4
LDAP.SearchResult.Count
Queries number of entries in search results.
Mac/Win/Linux
6.0
LDAP.SearchResult.DistinguishedName
Queries distinguished name for an entry in search results.
Mac/Win/Linux
6.0
LDAP.SetBinaryKeys
Sets which attributes should be handled as binary data.
Mac/Win/Linux
12.5
LDAP.SetNetworkTimeOut
Sets network timeout value.
Mac/Linux
6.0
LDAP.SetProtocolVersion
Set the protocol version to use.
Mac/Win/Linux
6.0
LDAP.SetReferrals
Sets the referrals option.
Mac/Win/Linux
6.0
LDAP.SetTimeOut
Sets timeout value.
Mac/Linux
6.0
LDAP.SimpleBind
Authenticates a client to a server, using a plaintext password.
Mac/Win/Linux
6.0
LDAP.StartTLS
Starts encrypted connection.
Mac/Win/Linux
9.3
List.AddPostfix
Adds a postfix text to each entry in the list.
All
6.1
List.AddPrefix
Adds a prefix text to each entry in the list.
All
6.1
List.AddValue
Adds a value to the list.
All
7.1
List.And
Returns a list with values which are contained in both lists.
All
4.4
List.AndColumn
Returns a list with values which are contained in both lists.
All
10.0
List.BestMatch
Looks for best match of a text in a list of texts.
All
5.0
List.CSVSplit
Splits CSV text.
All
7.4
List.CountValues
Counts values in list.
All
8.1
List.CountValuesMatching
Count matching entries in list.
All
10.2
List.CrossProduct
Creates the cross product from two lists.
All
6.1
List.DeCombine
Picks elements from each line in a list.
All
6.3
List.Deserialize
Restores a serialized list.
All
5.2
List.Find
Finds an entry in the list.
All
11.1
List.FindDuplicateItems
Finds duplicate items in the list.
All
10.5
List.FindEquals
Finds equal items in both lists.
All
4.2
List.FindUnequals
Finds unequal items in both lists.
All
4.2
List.GetColumn
Queries a column from each line in a list.
All
11.3
List.GetValue
Queries a value in the list.
All
7.1
List.HasDuplicateItems
Checks if list has duplicates.
All
7.5
List.HasValue
Checks whether a list contains a given value.
All
6.4
List.IndexOfFirstValueMatching
Finds index of first value matching value.
All
10.2
List.InsertValue
Inserts a value to a list.
All
7.1
List.MapEntries
Maps selection of keys from a key list to value list.
All
11.3
List.MatchesPostfix
Finds list entries which have a given postfix text.
All
5.4
List.MatchesPrefix
Finds list entries which have a given prefix text.
All
5.4
List.MatchesSubString
Finds list entries which contains a given text.
All
12.4
List.Not
Returns values of first list which are not in second list.
All
4.4
List.NotColumn
Returns values of first list which are not in second list.
All
10.0
List.Or
Returns values of both lists.
All
4.4
List.OrColumn
Returns values of both lists.
All
10.0
List.RegExMatch
Matches a list against a pattern.
All
4.4
List.Remove
Removes the value with the given index in the list.
All
7.1
List.RemoveDuplicateItems
Removes duplicate items in the list.
All
4.2
List.RemoveEmptyItems
Removes empty items in the list.
All
4.2
List.RemovePostfix
Removes a postfix text to each entry in the list.
All
6.1
List.RemovePrefix
Removes a prefix text to each entry in the list.
All
6.1
List.RemoveValue
Removes a value from a list.
All
7.1
List.Reverse
Reverses the order of items in the list.
All
4.4
List.Serialize
Serialized a list as a text.
All
5.2
List.SetValue
Sets a value in the list.
All
7.1
List.Shuffle   New in 14.0
Shuffles the items in the list.
All
14.0
List.Sort
Sorts the list.
All
4.2
List.SortWithEvaluate
Sorts a list with using an expression to evaluate.
All
10.2
List.SubList
Returns a part of the list.
All
7.5
List.Trim
Trims all texts in the list.
All
7.5
List.ValueIndex
Finds the index for a given value.
All
5.4
List.XOr
Returns list with values found in either first or second list, but not in both.
All
4.4
List.XOrColumn
Returns list with values found in either first or second list, but not in both.
All
10.0
Log
Writes the given values to the debug console.
All
2.2
MapView.FormatDistance
Formats a distance.
Mac/iOS
9.2
MapView.List
Lists all IDs of map view objects.
Mac/iOS
13.0
MapView.ParseDistance
Parses distance string.
Mac/iOS
9.2
MapView.PlanRoute
Plans a route.
Mac/iOS
9.2
MapView.RemoveOverlays
Removes all overlays.
Mac/iOS
9.1
MapView.Snapshot
Creates a map snapshot.
Mac/iOS
9.0
MarkDown.CSS
Queries CSS for the markdown.
All
5.1
MarkDown.Create
Creates a new MarkDown convert object with given markdown code.
All
5.1
MarkDown.HTML
Queries html for the markdown.
All
5.1
MarkDown.List
Lists all IDs of markdown objects.
All
13.0
MarkDown.Release
Releases the mark down object.
All
5.1
MarkDown.ReleaseAll
Frees all markdown objects.
All
10.5
Math.Average
Calculates average of given values.
All
12.1
Math.BitwiseAND
Perform bitwise AND operation.
All
4.1
Math.BitwiseNOT
Perform bitwise not operation.
All
4.1
Math.BitwiseOR
Perform bitwise or operation.
All
4.1
Math.BitwiseShiftLeft
Perform bitwise shift left.
All
4.1
Math.BitwiseShiftRight
Perform bitwise shift right.
All
4.1
Math.BitwiseXOR
Perform bitwise xor operation.
All
4.1
Math.DecToHex
Converts a number to a hexadecimal number.
All
2.5
Math.DecodeNumber
Decodes a number from it's binary representation.
All
6.4
Math.EncodeNumber
Encodes a number as binary data as hex text.
All
6.4
Math.FormatNumber
Formats a number.
All
11.1
Math.HexToDec
Converts a hexadecimal number to a normal decimal number.
All
2.5
Math.InchToPixel
Converts a inch value to pixel.
All
3.4
Math.IsValidCC
Verifies a credit card number.
All
3.1
Math.Max
Calculates maximum of given values.
All
12.1
Math.Median
Calculates median of given values.
All
12.1
Math.MillimeterToPixel
Converts a millimeter value to pixel.
All
3.4
Math.Min
Calculates minimum of given values.
All
12.1
Math.Multiply
Multiplies values.
All
12.1
Math.NormInv
Calculates NormInv function like in Excel.
All
11.1
Math.NumberToText
Converts a number value to a text string.
All
2.9
Math.PixelToInch
Converts a pixel value to inch.
All
3.4
Math.PixelToMillimeter
Converts a pixel value to millimeter.
All
3.4
Math.PolylineDecode
Decodes number from Polyline Algorithm Format.
All
9.2
Math.PolylineEncode
Encodes number in Polyline Algorithm Format.
All
9.2
Math.Random.ExponentialDistribution   New in 14.0
Generates a random number using exponential distribution.
All
14.0
Math.Random.NormalDistribution   New in 14.0
Generates a random number using normal distribution.
All
14.0
Math.Random.PoissonDistribution   New in 14.0
Generates a random number using poisson distribution.
All
14.0
Math.Reciprocal
Calculates reciprocals of values.
All
12.1
Math.StandardDeviation
Calculates standard deviation of given values.
All
12.1
Math.Sum
Calculates sum of given values.
All
12.1
Math.TextToNumber
Converts a text to a number.
All
2.9
Matrix.Add
Adds a value to cells in matrix.
All
10.2
Matrix.AddColumn
Adds one column to a matrix.
All
9.2
Matrix.AddColumns
Adds columns to a matrix.
All
9.2
Matrix.AddRow
Adds a row to the matrix.
All
9.2
Matrix.AddRows
Adds rows to the matrix.
All
9.2
Matrix.Avg
Calculates average value in a matrix column.
All
9.2
Matrix.CSV
Queries text of matrix for CSV export.
All
9.2
Matrix.CSVSplit
Splits CSV text.
All
10.5
Matrix.Clear
Clears the matrix.
All
9.2
Matrix.ClearValues
Clears all values in the matrix.
All
9.2
Matrix.Clone
Creates a copy of a matrix.
All
9.2
Matrix.ConvertDataType
Converts the data types.
All
12.5
Matrix.CopyColumn
Copies a column from one (or same) matrix to another column.
All
10.2
Matrix.CopyRow
Copies a row from one (or same) matrix to another row.
All
10.2
Matrix.DataType
Queries data type of a value.
All
9.2
Matrix.Evaluate
Evaluates an expression for each cell.
All
10.2
Matrix.GetColumn
Queries text of a whole column.
All
9.2
Matrix.GetColumnName
Queres column name.
All
10.2
Matrix.GetColumnNames
Queres column names.
All
10.2
Matrix.GetRow
Queries text of a whole row.
All
9.2
Matrix.GetRowName
Queres row name.
All
10.2
Matrix.GetRowNames
Queries row names.
All
10.2
Matrix.GetText
Queries text of whole matrix.
All
9.2
Matrix.GetValue
Queries a single value.
All
9.2
Matrix.HTML
Queries html of matrix.
All
13.3
Matrix.Height
Queries height of matrix.
All
9.2
Matrix.IndexOfFirstValueMatching   New in 14.0
Finds index of first value matching value.
All
14.0
Matrix.InsertRecords
Inserts records in FileMaker database from records in memory.
All
9.2
Matrix.InsertRecordsToSQL
Inserts records in SQL database from records in memory.
All
9.2
Matrix.JSONRecord
Returns a row as JSON object.
All
9.2
Matrix.JSONRecords
Returns rows as JSON array.
All
9.2
Matrix.List
Lists all IDs of current Matrix objects.
All
12.5
Matrix.Lookup
Queries value without errors.
All
13.5
Matrix.Max
Queries max value in a matrix column.
All
9.2
Matrix.Min
Queries min value in a matrix column.
All
9.2
Matrix.Multiply
Multiplies a value with cells in matrix.
All
10.3
Matrix.New
Creates a new matrix (2D array).
All
9.2
Matrix.NewWithSQL
Execute the SQL Statement against a FileMaker database.
All
9.2
Matrix.Release
Frees the matrix object.
All
9.2
Matrix.ReleaseAll
Releases all matrix objects.
All
10.5
Matrix.RemoveColumn
Removes a column.
All
9.2
Matrix.RemoveRow
Removes a row.
All
9.2
Matrix.Resize
Resizes matrix to given height and width.
All
9.2
Matrix.Rotate
Rotates a matrix.
All
12.4
Matrix.SetColumn
Sets a column to the given texts.
All
9.2
Matrix.SetColumnName
Sets column name.
All
10.2
Matrix.SetColumnNames
Sets column names.
All
12.5
Matrix.SetRow
Sets a row to the given texts.
All
9.2
Matrix.SetRowName
Sets row name.
All
10.2
Matrix.SetRowNames
Sets row names.
All
12.5
Matrix.SetValue
Sets a single value in the matrix.
All
9.2
Matrix.Sum
Calculates sum value in a matrix column.
All
9.2
Matrix.Text
Queries text of matrix.
All
9.2
Matrix.Width
Queries width of matrix.
All
9.2
MetaDataQuery.AttributesForFile
Queries properties for a file.
Mac only
8.0
MetaDataQuery.Close
Frees the metadata query.
Mac/iOS
8.0
MetaDataQuery.Create
Creates a new metadata search object.
Mac/iOS
8.0
MetaDataQuery.GetEvaluate
Queries expression to be run when shell is done.
Mac/iOS
8.0
MetaDataQuery.IsGathering
Query whether gathering.
Mac/iOS
8.0
MetaDataQuery.IsStarted
Query whether search is started.
Mac/iOS
8.0
MetaDataQuery.IsStopped
Query whether search is stopped.
Mac/iOS
8.0
MetaDataQuery.List
Lists all IDs of metadata query objects.
Mac/iOS
13.0
MetaDataQuery.PathAtIndex
Queries path of an item in results.
Mac/iOS
8.0
MetaDataQuery.Paths
Queries file paths.
Mac/iOS
8.0
MetaDataQuery.QueryString
Queries the query string.
Mac/iOS
8.0
MetaDataQuery.ResultAtIndex
Queries an item from result as JSON.
Mac/iOS
8.0
MetaDataQuery.ResultCount
Queries number of found items.
Mac/iOS
8.0
MetaDataQuery.Results
Queries results.
Mac/iOS
8.0
MetaDataQuery.SearchScopes
Queries the search scopes.
Mac/iOS
8.0
MetaDataQuery.SetEvaluate
Sets expression to be run when initial gathering is done.
Mac/iOS
8.0
MetaDataQuery.SetQueryString
Sets the predicate to search.
Mac/iOS
8.0
MetaDataQuery.SetSearchScopes
Sets the search scopes.
Mac/iOS
8.0
MetaDataQuery.StartQuery
Attempts to start the query.
Mac/iOS
8.0
MetaDataQuery.StopQuery
Stops the receiver’s current query from gathering any further results.
Mac/iOS
8.0
Modbus.CalculateRTUMessageCRC
Calculates the RTU Message CRC string.
All
3.1
MongoDB.AbortTransaction
Abort a multi-document transaction.
All
12.5
MongoDB.AggregateCollection
Creates an aggregate collection.
All
13.1
MongoDB.AggregateDatabase
Creates an aggregate database.
All
13.1
MongoDB.BSONtoJSON
Converts BSON to JSON.
All
12.3
MongoDB.ChangeStreamErrorDocument
Checks if an error has occurred when creating or iterating over a change stream.
All
13.0
MongoDB.ChangeStreamResumeToken
Queries resume token.
All
13.0
MongoDB.CloseChangeStream
Closes change stream.
All
13.0
MongoDB.CloseCollection
Closes the current collection explicitly.
All
12.4
MongoDB.CloseCursor
Closes cursor.
All
12.3
MongoDB.CloseDatabase
Closes the current database explicitly.
All
12.4
MongoDB.CollectionName
Queries name of current collection.
All
12.3
MongoDB.CollectionNames
Fetches the list of the names of all of the collections in database.
All
12.3
MongoDB.Command
Execute a command on the server.
All
13.1
MongoDB.CommitTransaction
Commit a multi-document transaction.
All
12.5
MongoDB.Connect
Connects the client using the URI provided.
All
12.3
MongoDB.ContainerToBinary
Converts a container to JSON for MongoDB.
All
13.2
MongoDB.CreateCollection
Creates a collection in the database.
All
12.3
MongoDB.CursorBatchSize
Queries batch size.
All
12.3
MongoDB.CursorCurrent
Queries current record as JSON.
All
12.3
MongoDB.CursorErrorDocument
Checks to see if an error has occurred while iterating the cursor.
All
12.4
MongoDB.CursorGetMaxAwaitTimeMS
The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
All
12.3
MongoDB.CursorID
Retrieves the cursor id used by the server to track the cursor.
All
12.3
MongoDB.CursorLimit
Queries current limit.
All
12.3
MongoDB.CursorMore
Whether there may be more data.
All
12.3
MongoDB.CursorNext
Queries the next record as JSON.
All
12.3
MongoDB.CursorSetBatchSize
Sets batch size,
All
12.3
MongoDB.CursorSetLimit
Limits the number of documents in the result set.
All
12.3
MongoDB.CursorSetMaxAwaitTimeMS
Sets the maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
All
12.3
MongoDB.DatabaseCommand
Creates a collection in the database.
All
12.3
MongoDB.DatabasesNames
Queries the MongoDB server for a list of known databases.
All
12.3
MongoDB.DeleteMany
Deletes many records.
All
12.3
MongoDB.DeleteOne
Deletes one record.
All
12.3
MongoDB.EstimatedDocumentCount
Executes a count query on collection.
All
12.3
MongoDB.Find
Query on collection, passing arbitrary query options to the server in options.
All
12.3
MongoDB.FindCollections
Fetches a cursor containing documents, each corresponding to a collection on this database.
All
12.3
MongoDB.FindDatabases
Fetches list of database records.
All
12.3
MongoDB.FindIndexes
Fetches a cursor containing documents, each corresponding to an index on this collection.
All
12.4
MongoDB.GetAuthMechanism
Queries authentication mechanism.
All
12.3
MongoDB.GetAuthSource
Queries authorization source.
All
12.3
MongoDB.GetCompressors
Queries compressors.
All
12.3
MongoDB.GetOptions
Queries the options from the URL.
All
13.1
MongoDB.GetPassword
Queries password used for login.
All
12.3
MongoDB.GetServiceHostName
Queries service hostname for login.
All
12.3
MongoDB.GetServiceName
Queries service name for login.
All
12.3
MongoDB.GetTLS
Whether this connection is set to be encrypted.
All
13.1
MongoDB.GetURI
Fetches the URI as a string.
All
12.3
MongoDB.GetUserName
Queries username for login.
All
12.3
MongoDB.HasCollection
Checks to see if a collection exists on the MongoDB server within database.
All
12.3
MongoDB.InTransaction
Check whether a multi-document transaction is in progress for this session.
All
12.5
MongoDB.InsertMany
Insert documents into collection.
All
12.4
MongoDB.InsertOne
Inserts a document into collection.
All
12.3
MongoDB.IsTracing
Queries whether trace is enabled.
All
13.4
MongoDB.JSONtoBSON
Converts JSON to BSON.
All
12.3
MongoDB.Keys
Queries current collection to find all the key names.
All
12.3
MongoDB.LibraryVersion
Queries library version.
All
12.3
MongoDB.List
Lists all IDs of current MongoDB objects.
All
12.5
MongoDB.MaxBSONSize
Returns the maximum bson document size allowed by the cluster.
All
12.3
MongoDB.MaxMessageSize
Returns the maximum message size allowed by the cluster.
All
12.3
MongoDB.New
Creates a new MongoDB object.
All
12.3
MongoDB.NewCursorFromCommandReply
Creates a cursor object from the reply of a command.
All
12.4
MongoDB.NextChange
Iterates the underlying change stream, returning the next document.
All
13.0
MongoDB.NowUTC
Create a new JSON value with current date and time.
All
13.2
MongoDB.OpenCollection
Sets the current collection.
All
12.3
MongoDB.OpenDatabase
Opens the given database.
All
12.3
MongoDB.OpenDefaultDatabase
Selects default database.
All
12.3
MongoDB.Ping
Sends ping command.
All
13.4
MongoDB.Release
Frees the MongoDB object.
All
12.3
MongoDB.ReleaseAll
Frees all MongoDB objects.
All
12.3
MongoDB.Rename
This function is a helper to rename an existing collection on a MongoDB server.
All
12.4
MongoDB.ReplaceOne
This replace one document in the collection that match selector with replacement.
All
12.3
MongoDB.SSLLibrary
Queries SSL library used.
All
13.4
MongoDB.ServerDescription
Get information about the server specified by ServerID.
All
12.3
MongoDB.ServerDescriptions
Fetches an server descroptions for all known servers in the topology.
All
12.3
MongoDB.SetAuthMechanism
Sets authentication mechanism.
All
12.3
MongoDB.SetAuthSource
Sets authentication source.
All
12.3
MongoDB.SetCompressors
Sets compressors to use.
All
12.3
MongoDB.SetDatabase
Sets the URI's database, after the URI has been parsed.
All
13.1
MongoDB.SetPassword
Sets user password for login.
All
12.3
MongoDB.SetSSLOptions
Sets the TLS (SSL) options to use when connecting to TLS enabled MongoDB servers.
All
13.4
MongoDB.SetURI
Sets the URI.
All
12.3
MongoDB.SetUserName
Sets user name for login.
All
12.3
MongoDB.StartTransaction
Start a multi-document transaction for all following operations in this session.
All
12.5
MongoDB.TextToBinary
Converts a text to JSON for MongoDB.
All
13.2
MongoDB.Time
Create a new JSON value with given timestamp.
All
13.2
MongoDB.Trace
Enables or disables trace.
All
13.4
MongoDB.TransactionState
Returns the current transaction state for this session.
All
12.5
MongoDB.UpdateMany
Updates many documents in collection that matches selector.
All
12.3
MongoDB.UpdateOne
Updates at most one document in collection that matches selector.
All
12.3
MongoDB.WatchClient
Creates a change stream for a client.
All
13.0
MongoDB.WatchCollection
Creates a change stream for a collection.
All
13.0
MongoDB.WatchDatabase
Creates a change stream for a database.
All
13.0
MouseCursor.Set
Sets the mouse cursor.
Mac/Win
2.6
Mutex.Create
Creates a new mutex with given name.
All
10.2
Mutex.Free
Frees a mutex.
All
10.2
Mutex.List
Lists all Mutex reference numbers.
All
10.2
Mutex.Lock
Locks the mutex.
All
10.2
Mutex.Name
Queries name of mutex.
All
10.2
Mutex.TryLock
Tries to lock the mutex.
All
10.2
Mutex.Unlock
Unlocks the mutex.
All
10.2
NetworkInterfaces.Count
Queries number of network interfaces found.
Mac/Linux/iOS
4.3
NetworkInterfaces.Default
Queries default network interface.
Mac/Linux/iOS
5.2
NetworkInterfaces.JSON
Returns all network interfaces as JSON.
Mac/Linux/iOS
8.4
NetworkInterfaces.Update
Queries current network interfaces.
Mac/Linux/iOS
4.3
NetworkInterfaces.Value
Queries the
Mac/Linux/iOS
4.3
Notification.List
Returns list of all notification names registered.
Mac/Win
3.3
Notification.Send
Sends a notification.
Mac/Win
2.6
Notification.SendDirect
Sends a notification within FileMaker to all listener.
Mac/Win
5.2
Notification.Unlisten
Unregisters a notification handler.
Mac/Win
3.3
Notification.UnlistenAll
Stops listening to all notifications.
Mac/Win
7.2
OCR.Cleanup
Shutdown the engine and free all memory.
All
2.9
OCR.Clear
Free up recognition results and any stored image data, without actually freeing any recognition data that would be time-consuming to reload.
All
2.9
OCR.GetBoxText
The recognized text is returned as a text which is coded in the same format as a box file used in training.
All
2.9
OCR.GetHOCRText
Make a HTML-formatted string with hOCR markup from the internal data structures.
All
2.9
OCR.GetPageSegMode
Queries page segmentation mode.
All
2.9
OCR.GetText
Returns recognized text.
All
2.9
OCR.GetTextAsJSON
Queries result as JSON.
All
13.3
OCR.GetTextWithCoordinates
Queries text with coordinates.
All
6.5
OCR.GetVariable
Queries a variable.
All
7.5
OCR.Initialize
Initializes tesseract.
All
2.9
OCR.IsInitialized
Checks if OCR library has been initialized.
All
4.2
OCR.IsLoaded
Whether newer tesseract is loaded.
All
11.3
OCR.Language
Return the language used in the last valid initialization.
All
2.9
OCR.Load
Loads newer tesseract engine.
All
11.3
OCR.MeanTextConf
Returns the (average) confidence value between 0 and 100.
All
2.9
OCR.Recognize
Recognize the image.
All
2.9
OCR.SetImage
Provide an image for Tesseract to recognize.
All
2.9
OCR.SetImageContainer
Loads a picture from container.
All
11.3
OCR.SetImageFile
Loads a picture from file directly.
All
11.3
OCR.SetPageSegMode
Sets page segmentation mode.
All
2.9
OCR.SetRectangle
Restrict recognition to a sub-rectangle of the image.
All
2.9
OCR.SetResolution
Set the resolution of the source image in pixels per inch.
All
5.1
OCR.SetVariable
Sets a variable.
All
7.5
OCR.Version
Query version of Tesseract library.
All
11.3
OCR.WriteToPDF
Writes text on the PDF.
All
3.1
PDFKit.AddEmptyPage
Adds an empty page to the given PDF document.
Mac/iOS
5.0
PDFKit.AddImageFilePage
Adds a new page to PDF document with given image file.
Mac/iOS
7.2
PDFKit.AddImagePage
Adds a new page to PDF document with given image.
Mac/iOS
5.0
PDFKit.AppendPages
Copies pages from one PDF to append other PDF.
Mac/iOS
3.1
PDFKit.Combine
Creates a new PDF file with all the given PDF files/references.
Mac/iOS
2.3
PDFKit.CombineRef
Creates a new PDF document with all the given PDF files/references and returns the new PDF reference.
Mac/iOS
2.3
PDFKit.GeneratePreview
Adds preview to an existing PDF container.
Mac/Win/iOS
7.5
PDFKit.GetCurrentFilter
Queries name of current selected filter.
Mac only
4.3
PDFKit.GetIgnoreCombineErrors
Returns status of Combine Error handling.
Mac/iOS
2.4
PDFKit.GetPDFAttribute
Queries a PDF attribute.
Mac/iOS
2.3
PDFKit.GetPDFDocument
Creates a new PDF Document with the given PDF document.
Mac/iOS
2.2
PDFKit.GetPDFPageCount
Queries the number of the pages in the PDF document.
Mac/iOS
2.1
PDFKit.GetPDFPageDisplayAnnotation
Gets whether annotations are drawn.
Mac/iOS
6.0
PDFKit.GetPDFPageFormattedText
Queries the styled text of a page in a PDF document.
Mac/iOS
2.7
PDFKit.GetPDFPageImage
Renders an image of a page in a PDF document.
Mac/iOS
2.1
PDFKit.GetPDFPagePDF
Creates a new PDF Document with the given PDF page.
Mac/iOS
2.2
PDFKit.GetPDFPagePDFRef
Creates a new PDF Document with the given PDF page.
Mac/iOS
2.3
PDFKit.GetPDFPageRotation
Returns the page rotation angle in degrees.
Mac/iOS
2.9
PDFKit.GetPDFPageText
Queries the text of a page in a PDF document.
Mac/iOS
2.1
PDFKit.GetPDFPageValue
Queries a page property.
Mac/iOS
5.0
PDFKit.GetPDFPagesPDF
Creates a new PDF Document with the given PDF pages.
Mac/iOS
2.2
PDFKit.GetPDFPagesPDFRef
Creates a new PDF Document with the given PDF pages.
Mac/iOS
2.3
PDFKit.GetPDFText
Queries the text of the PDF document.
Mac/iOS
2.1
PDFKit.GetPrintSetting
Queries print settings for printing PDF.
Mac only
4.0
PDFKit.List
Lists all IDs of PDFKit objects.
Mac/iOS
13.0
PDFKit.NewPDFDocument
Creates a new empty PDF and returns a PDF Reference value.
Mac/iOS
5.0
PDFKit.Open
Opens a PDF and returns a PDF Reference value.
Mac/iOS
2.2
PDFKit.OpenContainer
Opens a PDF from container value and returns a PDF Reference value.
Mac/iOS
2.3
PDFKit.OpenPath
Opens a PDF from a file path and returns a PDF Reference value.
Mac/iOS
2.3
PDFKit.OpenURL
Opens a PDF from an URL and returns a PDF Reference value.
Mac/iOS
2.3
PDFKit.PageBounds
Returns the bounds for the specified PDF display box.
Mac/iOS
2.9
PDFKit.Print
Prints a PDF without dialogs.
Mac only
4.0
PDFKit.Release
Releases a PDF reference.
Mac/iOS
2.1
PDFKit.ReleaseAll
Release all PDFKit documents.
Mac/iOS
10.5
PDFKit.ResetPrintSettings
Resets print settings to default settings.
Mac only
4.0
PDFKit.RestorePrintSettings
Restores print settings.
Mac only
4.0
PDFKit.SavePrintSettings
Saves current print settings.
Mac only
4.0
PDFKit.SetCurrentFilter
Sets the current filter.
Mac only
4.3
PDFKit.SetIgnoreCombineErrors
Sets whether Combine operation should report error if you did not pass PDF files or references.
Mac/iOS
2.4
PDFKit.SetPDFAttribute
Sets a PDF attribute.
Mac/iOS
2.3
PDFKit.SetPDFPageDisplayAnnotation
Sets whether annotations are drawn.
Mac/iOS
6.0
PDFKit.SetPDFPageRotation
Sets the rotation angle for the page in degrees.
Mac/iOS
2.9
PDFKit.SetPrintSetting
Sets print settings for printing PDF.
Mac only
4.0
PDFKit.Watermark
Adds a watermark to a page.
Mac/iOS
2.7
PDFKit.WriteToPath
Writes the PDF to the given file path.
Mac/iOS
3.1
PDFKit.allowsCopying
Returns a Boolean value indicating whether the document allows copying of content to the Pasteboard.
Mac/iOS
2.9
PDFKit.allowsPrinting
Returns a Boolean value indicating whether the document allows printing.
Mac/iOS
2.9
PDFKit.isEncrypted
Returns a Boolean value specifying whether the document is encrypted.
Mac/iOS
2.9
PDFKit.isLocked
Returns a Boolean value indicating whether the document is locked.
Mac/iOS
2.9
PKCS12.CA
Queries certificate with given index.
All
7.0
PKCS12.CACount
Queries number of other certificates.
All
7.0
PKCS12.Cert
Queries the X509 certificate in the PKCS12 file.
All
7.0
PKCS12.List
Lists all IDs of PKCS12 objects.
All
13.0
PKCS12.PKey
Queries the private key from the PKCS12 file.
All
7.0
PKCS12.ReadFromContainer
Reads certificate and private key from a PKCS12 file in container.
All
7.0
PKCS12.ReadFromFile
Reads certificate and private key from a PKCS12 file.
All
7.0
PKCS12.Release
Releases the PKCS12 from memory.
All
7.0
PKCS12.ReleaseAll
Release all PKCS12 keys.
All
10.5
PKCS12.SignData
Creates a PKCS#7 signature for given data.
All
13.1
PKCS7.List
Lists all IDs of PKCS7 objects.
All
13.0
PKCS7.ReadFromContainer
Reads PKCS#7 from a file in container.
All
9.1
PKCS7.ReadFromFile
Reads certificate and private key from a PKCS#7 file.
All
9.1
PKCS7.Release
Releases the PKCS7 from memory.
All
9.1
PKCS7.ReleaseAll
Release all PKCS7 keys.
All
10.5
PKCS7.SignedDataCert
Queries signing certificate with given index.
All
9.1
PKCS7.SignedDataCertCount
Queries number of signing certificates.
All
9.1
PKCS7.SignedDataContent
Queries content signed.
All
9.1
PKey.Bits
Queries number of bits of key.
All
7.0
PKey.DescriptionPrivateKey
Describes the private key.
All
7.0
PKey.DescriptionPublicKey
Describes the public key.
All
7.0
PKey.GetPrivateKey
Queries private key as PEM file text.
All
7.0
PKey.GetPublicKey
Queries public key as PEM file text.
All
7.0
PKey.List
Lists all IDs of private key objects.
All
13.0
PKey.Read
Reads a private/public key from PEM certificate from text.
All
11.4
PKey.ReadFromContainer
Reads a key from a container value.
All
11.4
PKey.ReadFromFile
Reads a key from a PEM file.
All
11.4
PKey.Release
Releases the private key from memory.
All
7.0
PKey.ReleaseAll
Release all private keys.
All
10.5
PKey.Type
Queries the type of key.
All
7.0
PList.ReadData
Read property list from data.
Mac/iOS
11.4
PList.ReadFile
Reads property list files.
Mac/iOS
11.4
PList.WriteData
Encodes property list data.
Mac/iOS
11.4
Path.AddPathComponent
Adds a new path component.
All
6.0
Path.FileMakerPathToNativePath
Converts a FileMaker path useful for "filemac:" and "filewin:" path specification to a native path.
All
2.4
Path.FilePathToFileURL
Converts a file path to a local file URL.
All
5.0
Path.FileURLToFilePath
Converts a file URL to a local file path.
All
5.0
Path.LastPathComponent
Queries the last path component.
All
6.0
Path.LongPath
Queries long file path on Windows.
All
9.0
Path.NativePathToFileMakerPath
Converts a native path to a FileMaker path useful for "filemac:" and "filewin:" path specification.
All
2.4
Path.RemoveLastPathComponent
Removes last path component.
All
6.0
Path.ShortPath
Queries short file path on Windows.
All
9.0
Phidget.AddPositionOffset
Adds an offset (positive or negative) to the current position.
Mac/Win/Linux
13.4
Phidget.ChildDevices
Queries child devices for a device.
Mac/Win/Linux
13.4
Phidget.Clear
Clears all pixels in the current frame buffer.
Mac/Win/Linux
13.4
Phidget.ClearScriptTrigger
Removes a script trigger for a phidget.
Mac/Win/Linux
13.5
Phidget.Close
Closes a Phidget channel that has been opened.
Mac/Win/Linux
13.4
Phidget.Create
Creates an instance of a Phidget channel.
Mac/Win/Linux
13.4
Phidget.DisableServerDiscovery   New in 14.0
Disables the dynamic discovery of servers that publish their identity.
Mac/Win/Linux
14.0
Phidget.EnableFailsafe
Enables the failsafe feature for the channel, with a given failsafe time.
Mac/Win/Linux
13.4
Phidget.EnableServerDiscovery   New in 14.0
Enables the dynamic discovery of servers that publish their identity to the network.
Mac/Win/Linux
14.0
Phidget.Flush
Flushes the buffered LCD contents to the LCD screen.
Mac/Win/Linux
13.4
Phidget.GetProperty
Queries a property for a phidget device.
Mac/Win/Linux
13.4
Phidget.GetTag   New in 14.0
Queries tag value.
All
14.0
Phidget.LibraryVersion
Queries version number for the loaded phidgets library.
Mac/Win/Linux
13.4
Phidget.List
Returns list of all Phidget IDs.
Mac/Win/Linux
13.4
Phidget.Load
Loads the Phidget library.
Mac/Win/Linux
13.4
Phidget.Loaded
Checks whether Phidgets library is loaded.
Mac/Win/Linux
13.4
Phidget.Open
Opens the Phidget channel.
Mac/Win/Linux
13.4
Phidget.Release
Frees memory for a Phidget object.
Mac/Win/Linux
13.4
Phidget.ReleaseAll
Frees all Phidget objects.
Mac/Win/Linux
13.4
Phidget.ResetFailsafe
Resets the failsafe timer.
Mac/Win/Linux
13.4
Phidget.SetProperty
Sets a property for the phidget object.
Mac/Win/Linux
13.4
Phidget.SetScriptTrigger
Installs a script trigger with the phidget.
Mac/Win/Linux
13.4
Phidget.SetTag   New in 14.0
Sets the tag value.
All
14.0
Phidget.WriteText
Writes text to a LCD screen.
Mac/Win/Linux
13.4
PhotoPicker.GetDisabledCapabilities
Queries which Capabilities of the picker that should be disabled.
Mac/iOS
13.4
PhotoPicker.GetMode
Queries the mode of the picker.
Mac/iOS
13.4
PhotoPicker.SetDisabledCapabilities
Sets which Capabilities of the picker that should be disabled.
Mac/iOS
13.4
PhotoPicker.SetMode
Sets the mode of the picker.
Mac/iOS
13.4
Platform
Returns what platform the plugin is running on.
All
3.0
Plugin.BuildNumber
Queries the build number of the plugin.
All
5.0
Plugin.CallCounter
Queries call counter.
All
9.3
Plugin.CompileDate
Queries compile date as FileMaker date.
All
10.0
Plugin.DisableFunction
Disables a plugin function.
All
2.8
Plugin.FunctionCount
Queries number of functions available.
All
7.2
Plugin.Functions
Returns a list of all the functions in the plugin.
All
1.0
Plugin.GetFunctionParameters
Queries the function metadata for parameter list.
All
12.1
Plugin.GetFunctionPlatforms
Queries the function metadata for platform support.
All
10.5
Plugin.GetSuccessReturn
Queries current OK return.
All
5.1
Plugin.InstallSignalHandlers
Installs signal handlers.
Mac/Linux/iOS
9.3
Plugin.IsMaintenanceExpired
Queries whether maintenance is expired.
All
13.1
Plugin.IsPrerelease
Queries whether this is a MBS Plugin beta version.
All
10.0
Plugin.JasperVersion
Queries version string for Jasper library.
All
9.0
Plugin.LibSSHVersion
Queries the SSH library version used.
All
6.2
Plugin.LicenseeName
Queries licensee name.
All
8.3
Plugin.LimitFunction
Limits a function.
All
5.4
Plugin.LoadIconvLibrary
Loads the iconv library.
All
10.4
Plugin.LockFunction
Locks a function with a password.
All
5.4
Plugin.ObjectCounts
Returns JSON with object counts.
All
13.5
Plugin.OpenSSLVersion
Queries OpenSSL Version.
All
6.2
Plugin.PNGVersion
Queries PNG version.
All
7.3
Plugin.Path
Queries the native file path to the plugin.
All
3.3
Plugin.ScriptStepParameter
Queries script step parameter with given index.
All
7.2
Plugin.ScriptStepParameterCount
Queries number of parameters to the current script step.
All
7.2
Plugin.Seats
Queries the internal seats value.
All
1.6
Plugin.SetFunctions
Sets the function list the plugin has.
All
5.1
Plugin.SetPreviewSize
Sets which size plugin uses for preview images.
All
5.1
Plugin.SetSuccessReturn
Sets what the plugin returns on success.
All
5.1
Plugin.StartTimeStamp
Queries time the plugin was loaded.
All
9.5
Plugin.State
Queries plugin state.
All
13.1
Plugin.TiffVersion
Queries version string for TIFF library.
All
9.0
Plugin.UnlockFunction
Unlocks a locked function.
All
5.4
Plugin.UsedFunctionCounts
Queries plugin function usage counts.
All
13.5
Plugin.UsedFunctions
Queries used functions.
All
8.3
Plugin.WebPVersion
Returns version of WebP library.
All
13.2
Plugin.ZLibVersion
Queries zlib version number.
All
8.1
Plugin.isDebug
Checks whether this is debug version of MBS Plugin.
All
7.1
PortMidi.List
Lists all IDs of midi objects.
Mac/Win
13.0
Preferences.DeleteValue
Deletes a preference value.
Mac/Win/iOS
6.0
Preferences.GetTextSelectionWithDragAndDrop
Queries drag and drop preference.
Mac only
2.8
Preferences.GetValue
Queries preferences value.
Mac/Win/iOS
2.7
Preferences.GetValueType
Queries data type for a preferences entry.
Mac/Win/iOS
9.3
Preferences.HasValue
Checks if a preference value is defined.
Mac/Win/iOS
6.0
Preferences.List
Lists keys for preferences.
Mac/Win/iOS
12.0
Preferences.SetTextSelectionWithDragAndDrop
Set the preference setting from FileMaker/Runtime about allowing text selection by drag and drop.
Mac only
2.8
Preferences.SetValue
Sets preferences value.
Mac/Win/iOS
2.7
Printer.GetDefaultPrinter
Queries default system printer.
Mac/Win
3.0
Printer.PrinterCount
Queries the number of printers.
Mac/Win
3.0
Printer.PrinterInfo
Queries printer info.
Mac/Win
6.5
Printer.PrinterName
Queries the name of the printer with given index.
Mac/Win
3.0
Process.GetCurrentDirectory
Queries current directory.
All
6.5
Process.GetDllDirectory
Queries DLL directory.
Win only
13.1
Process.IsRunning
Checks if a process is running.
Mac only
4.0
Process.List
Queries process list.
Mac/Win
11.2
Process.LoadLibrary
Loads a given native library.
All
6.5
Process.SetCurrentDirectory
Sets the current directory.
All
6.5
Process.SetDllDirectory
Adds a directory to the search path used to locate DLLs for the application.
Win only
13.1
ProcessActivity.List
Lists all activities.
Mac/Win/iOS
5.2
ProcessActivity.Options
Queries option flags.
Mac/Win/iOS
5.2
ProcessActivity.Reason
Queries the reason text.
Mac/Win/iOS
5.2
ProcessActivity.beginActivity
Begins an activity.
Mac/Win/iOS
5.2
ProcessActivity.endActivity
Ends the activity started with ProcessActivity.beginActivity.
Mac/Win/iOS
5.2
QuickList.AddList
Adds a list of values to a quick list.
All
5.0
QuickList.AddMultiValue
Adds a value or list to the list.
All
7.2
QuickList.AddPostfix
Adds a postfix text to each entry in the list.
All
6.1
QuickList.AddPrefix
Adds a prefix text to each entry in the list.
All
6.1
QuickList.AddQuickList
Adds the content of second list to first list.
All
5.0
QuickList.AddSQL
Adds values to a quick list via SQL.
All
5.1
QuickList.AddValue
Adds a value to the list.
All
4.4
QuickList.And
Returns a list with values which are contained in both lists.
All
4.4
QuickList.AndColumn
Returns a list with values which are contained in both lists.
All
10.0
QuickList.BestMatch
Looks for best match of a text in a list of texts.
All
5.0
QuickList.CSVSplit
Splits CSV text.
All
7.4
QuickList.Clear
Clears the content of the list.
All
4.4
QuickList.Clone
Creates a clone of the list.
All
6.1
QuickList.Count
Queries the count of items in list.
All
4.4
QuickList.CountValuesMatching
Count matching entries in list.
All
10.2
QuickList.CrossProduct
Creates the cross product from two lists.
All
6.1
QuickList.DeCombine
Picks elements from each line in a list.
All
7.5
QuickList.Deserialize
Restores a serialized list.
All
5.2
QuickList.Find
Finds an entry in the list.
All
11.1
QuickList.FindDuplicateItems
Finds duplicate items in the list.
All
10.5
QuickList.FindEquals
Finds equal items in both lists.
All
4.4
QuickList.FindUnequals
Finds unequal items in both lists.
All
4.4
QuickList.GetColumn
Queries a column from each line in a list.
All
11.3
QuickList.GetList
Queries the list as text.
All
4.4
QuickList.GetValue
Queries a value in the list.
All
4.4
QuickList.HasDuplicateItems
Checks if list has duplicates.
All
7.5
QuickList.HasValue
Checks whether a list contains a given value.
All
5.0
QuickList.IndexOfFirstValueMatching
Finds index of first value matching value.
All
10.2
QuickList.InsertValue
Inserts a value to a list.
All
5.2
QuickList.JoinJSON
Joins text in a QuickList as JSON array.
All
13.3
QuickList.List
Returns list of all quick list IDs.
All
5.3
QuickList.MatchesPostfix
Finds list entries which have a given postfix text.
All
5.4
QuickList.MatchesPrefix
Finds list entries which have a given prefix text.
All
5.4
QuickList.MatchesSubString
Finds list entries which contains a given text.
All
6.0
QuickList.New
Creates a new list.
All
4.4
QuickList.Not
Returns values of first list which are not in second list.
All
4.4
QuickList.NotColumn
Returns values of first list which are not in second list.
All
10.0
QuickList.Or
Returns values of both lists.
All
4.4
QuickList.OrColumn
Returns values of both lists.
All
10.0
QuickList.Pop
Pops last value from the list.
All
5.2
QuickList.PopFirst
Pops the first value from a list.
All
5.2
QuickList.Push
Pushes a value to the end of the list.
All
5.2
QuickList.RegExMatch
Matches a list against a pattern.
All
4.4
QuickList.Release
Releases the list.
All
4.4
QuickList.Remove
Removes the value with the given index.
All
5.0
QuickList.RemoveDuplicateItems
Removes duplicate items in the list.
All
4.4
QuickList.RemoveEmptyItems
Removes empty items in the list.
All
4.4
QuickList.RemovePostfix
Removes a postfix text to each entry in the list.
All
6.1
QuickList.RemovePrefix
Removes a prefix text to each entry in the list.
All
6.1
QuickList.RemoveValue
Removes a value from a quick list.
All
5.0
QuickList.Reserve
Reserves memory for a list of given size.
All
4.4
QuickList.Reverse
Reverses the order of items in the list.
All
4.4
QuickList.Serialize
Serialized a list as a text.
All
5.2
QuickList.SetList
Sets the list to the content of the passed list.
All
4.4
QuickList.SetValue
Sets a value in the list.
All
4.4
QuickList.Shuffle   New in 14.0
Shuffles the items in the list.
All
14.0
QuickList.Sort
Sorts the list.
All
4.4
QuickList.SortWith
Sorts the list with together with other lists.
All
6.2
QuickList.SortWithEvaluate
Sorts a list with using an expression to evaluate.
All
10.2
QuickList.SubList
Returns a part of the list.
All
7.5
QuickList.Trim
Trims all texts in the list.
All
7.5
QuickList.ValueIndex
Finds the index for a given value.
All
5.4
QuickList.XOr
Returns list with values found in either first or second list, but not in both.
All
4.4
QuickList.XOrColumn
Returns list with values found in either first or second list, but not in both.
All
10.0
RSA.DecryptPrivateKey
Decrypts a private key.
All
7.5
RSA.EncryptPrivateKey
Encrypts a private key.
All
7.5
RSA.GeneratePrivateKey
Creates a new private key.
All
6.2
RSA.GetPublicKey
Queries public key from private key.
All
6.2
RSA.PrivateDecrypt
Decrypts data using private key.
All
6.2
RSA.PrivateEncrypt
Encrypts data using private key.
All
6.2
RSA.PublicDecrypt
Decrypts data using public key.
All
6.2
RSA.PublicEncrypt
Encrypts data using public key.
All
6.2
RSA.Sign
Signs data with RSA digital signature.
All
6.2
RSA.Verify
Verifies RSA digital signature.
All
6.2
RegEx.CaptureCount
Queries number of captured sub patterns.
All
4.4
RegEx.Compile
Compiles a pattern.
All
4.4
RegEx.DataDetector
Performs data detection to find details in text.
Mac/iOS
11.1
RegEx.Execute
Executes a statement.
All
4.4
RegEx.Extract
Extracts found text.
All
11.1
RegEx.FindMatches
Finds in a text all matches of a given pattern and returns list.
All
5.1
RegEx.List
Returns list of all regex IDs.
All
5.3
RegEx.Match
Matches a text against to a pattern.
All
4.4
RegEx.MatchList
Matches a list against a pattern.
All
4.4
RegEx.MinimumLength
Queries the minimum length of the text to match.
All
4.4
RegEx.NameCount
Queries number of names.
All
4.4
RegEx.NamedSubstring
Queries the named substring.
All
4.4
RegEx.Options
Queries the options to used when compiling the pattern.
All
4.4
RegEx.Pattern
Queries the pattern used to compile this regular expression.
All
4.4
RegEx.Quote
Quotes text for use in patterns.
All
7.5
RegEx.Release
Frees memory for a regular expression.
All
4.4
RegEx.ReleaseAll
Frees all regular expression objects.
All
13.2
RegEx.Replace
Replace pattern once.
All
7.5
RegEx.ReplaceAll
Replaces patterns.
All
7.5
RegEx.Results
Queries the result from execute.
All
4.4
RegEx.Size
Queries size of compiled pattern.
All
4.4
RegEx.StringNumber
Queries the index number of a name.
All
4.4
RegEx.Study
Studies the regular expression for improved execution speed.
All
4.4
RegEx.Substring
Queries a substring.
All
4.4
RegEx.SubstringList
Returns list of substrings.
All
4.4
RegEx.Version
Returns the version number of the PCRE library.
All
4.4
Register
This function is used to register the Plugin.
All
1.0
Registration
Returns a list of the currently registered components.
All
1.0
Registry.CreateKey
Creates a new registry key.
Win only
7.2
Registry.DeleteKey
Deletes a key in the registry.
Win only
7.2
Registry.DeleteTree
Deletes a key with all sub keys.
Win only
7.2
Registry.DeleteValue
Deletes a value from a registry key.
Win only
7.2
Registry.FlushKey
Writes changes to disk.
Win only
7.2
Registry.GetValue
Queries value of key’s value.
Win only
7.2
Registry.GetValueType
Queries type of a value.
Win only
7.2
Registry.ListKeys
Lists all sub keys of a key.
Win only
7.2
Registry.ListValues
Queries list of value names of a key.
Win only
7.2
Registry.SetValue
Sets a value on a registry key.
Win only
7.2
RichText.AppendFormattedText
Appends new styled text to the document.
Mac/iOS
10.0
RichText.AppendText
Appends text to the current document.
Mac/iOS
10.0
RichText.Attribute
Queries an attribute value.
Mac/iOS
3.0
RichText.Clear
Clears current document.
Mac/iOS
3.5
RichText.FormattedText
Returns the styled text of the currently loaded text file.
Mac/iOS
3.0
RichText.GeneratePDF
Generates a PDF from the current rich text document.
Mac only
5.1
RichText.HTMLText
Converts the current rich text to html.
Mac/iOS
6.0
RichText.RTF
Returns current rich text as RTF data.
Mac/iOS
6.5
RichText.ReadContainer
Reads text file from container.
Mac/iOS
3.0
RichText.ReadFile
Reads a text file from a file.
Mac/iOS
3.0
RichText.ReadRTF
Loads RTF text as rich text.
Mac/iOS
5.2
RichText.ReadText
Read rich text from text.
Mac/iOS
4.4
RichText.ReadURL
Reads a text file from an URL.
Mac/iOS
3.0
RichText.Release
Frees memory for current text file.
Mac/iOS
3.0
RichText.ReplaceText
Replaces text in current rich text document with new text.
Mac/iOS
4.4
RichText.ReplaceTexts
Replaces text in current rich text document with new text.
Mac/iOS
6.4
RichText.SetAttribute
Sets metadata.
Mac/iOS
3.5
RichText.SetFormattedText
Sets new text for saving a document.
Mac/iOS
3.5
RichText.SetText
Sets new text for saving a document.
Mac/iOS
3.5
RichText.Text
Returns the plain text of the currently loaded text file.
Mac/iOS
3.0
RichText.TextLength
Returns the length of the text in characters.
Mac/iOS
3.0
RichText.WriteContainer
Writes current rich text to a container.
Mac/iOS
4.4
RichText.WriteDOC
Writes a Word file.
Mac only
3.5
RichText.WriteFile
Writes current rich text to a file.
Mac/iOS
4.4
RichText.WritePDF
Write the current rich text document to a PDF file.
Mac only
5.1
RichText.WriteRTF
Writes a RTF file.
Mac/iOS
3.5
SQL.Cancel
Attempts to cancel the pending result set, or current statement execution.
All
2.6
SQL.ClientVersion
Gets the DBMS client API version number.
All
2.6
SQL.Close
Closes the specified command object.
All
2.6
SQL.CommandText
Gets the command text associated with the command object.
All
2.6
SQL.CommandType
Gets the command type currently associated with the command object.
All
2.6
SQL.Commit
Saves any changes and ends the current transaction.
All
2.6
SQL.Connect
Opens the connection to a data source.
All
2.6
SQL.ConvertDateTimeFromSQL
Converts a date or timestamp to FileMaker format.
All
11.2
SQL.ConvertDateTimeToSQL
Converts a date/time/timestamp to SQL text.
All
11.2
SQL.Disconnect
Disconnects the connection from the database.
All
2.6
SQL.Execute
Executes the current command.
All
2.6
SQL.FetchFirst
Fetches the first row from a result set.
All
2.6
SQL.FetchLast
Fetches the last row from a result set.
All
2.6
SQL.FetchNext
Fetches next row from a result set.
All
2.6
SQL.FetchPos
Fetches a row from a result set.
All
5.1
SQL.FetchPrior
Fetches previous row from a result set.
All
2.6
SQL.FieldCount
Returns the number of fields (columns) in a result set.
All
2.6
SQL.FieldExists
Checks whether a field exists.
All
11.4
SQL.FreeAllConnections
Frees all SQL connections and commands.
All
6.3
SQL.FreeCommand
Frees the command and releases all memory associated with it.
All
2.6
SQL.FreeConnection
Call this method if you are done with a connection.
All
2.6
SQL.GetAutoCommit
Checks whether autocommit is enabled or disabled for the current connection.
All
2.6
SQL.GetCommandOption
Gets a string value of a specific command option.
All
2.6
SQL.GetCommandOptions
Queries list of options for command.
All
8.4
SQL.GetCommandTag
Queries tag for command.
All
6.4
SQL.GetConnectionOption
Gets a string value of a specific connection option.
All
2.6
SQL.GetConnectionOptions
Queries list of options for connection.
All
8.4
SQL.GetConnectionTag
Queries tag for connection.
All
6.4
SQL.GetFieldAsBoolean
Returns field's value as boolean value; converts if needed.
All
2.6
SQL.GetFieldAsContainer
Queries field value as container.
All
6.2
SQL.GetFieldAsDate
Returns field's value as date value; converts if needed.
All
2.6
SQL.GetFieldAsDateTime
Returns field's value as timestamp value.-
All
2.6
SQL.GetFieldAsFloat
Returns field's value as floating point number value; converts if needed.
All
2.6
SQL.GetFieldAsJPEG
Returns field's value as JPEG value.
All
3.0
SQL.GetFieldAsNumber
Returns field's value as integer number value; converts if needed.
All
2.6
SQL.GetFieldAsPDF
Returns field's value as PDF value.
All
4.3
SQL.GetFieldAsPNG
Returns field's value as PNG value.
All
3.0
SQL.GetFieldAsText
Returns field's value as text value; converts if needed.
All
2.6
SQL.GetFieldAsTime
Returns field's value as time value; converts if needed.
All
2.6
SQL.GetFieldDataType
Returns field data type.
All
2.6
SQL.GetFieldIsNull
Whether the field value is NULL.
All
2.6
SQL.GetFieldName
Returns name of the field.
All
2.6
SQL.GetFieldNameList
Queries list of field names.
All
5.1
SQL.GetFieldOption
Gets a string value of a specific field option.
All
2.6
SQL.GetFieldOptions
Queries list of options for field.
All
8.4
SQL.GetFieldValue
Returns field's value.
All
5.1
SQL.GetFieldValueList
Queries list of field values.
All
5.1
SQL.GetFieldsAsJSON
Queries fields values current record as JSON object.
All
10.2
SQL.GetIsolationLevel
Gets the transaction isolation level.
All
2.6
SQL.GetParamAsBoolean
Returns param's value as boolean value; converts if needed.
All
2.6
SQL.GetParamAsContainer
Queries parameter value as container.
All
6.2
SQL.GetParamAsDate
Returns param's value as date; converts if needed.
All
2.6
SQL.GetParamAsDateTime
Returns param's value as timestamp value; converts if needed.
All
2.6
SQL.GetParamAsFloat
Returns param's value as floating point number; converts if needed.
All
2.6
SQL.GetParamAsJPEG
Returns parameters's value as JPEG value.
All
3.0
SQL.GetParamAsNumber
Returns param's value as integer; converts if needed.
All
2.6
SQL.GetParamAsPDF
Returns parameters's value as PDF value.
All
4.3
SQL.GetParamAsPNG
Returns parameters's value as PNG value.
All
3.0
SQL.GetParamAsText
Returns param's value as text; converts if needed.
All
2.6
SQL.GetParamAsTime
Returns param's value as time value; converts if needed.
All
2.6
SQL.GetParamDataType
Returns parameter data type.
All
2.6
SQL.GetParamIsDefault
Checks whether parameter is default value.
All
2.6
SQL.GetParamIsNull
Whether the parameter value is NULL.
All
2.6
SQL.GetParamName
Returns the name of the parameter.
All
2.6
SQL.GetParamNameList
Queries list of parameter names.
All
5.1
SQL.GetParamOption
Gets a string value of a specific parameter option.
All
8.4
SQL.GetParamOptions
Queries list of options for parameter.
All
8.4
SQL.GetParamValue
Returns param's value.
All
5.1
SQL.GetParamValueList
Queries list of parameter values.
All
5.1
SQL.GetParamsAsJSON
Queries parameters as JSON object.
All
10.2
SQL.GetRecordsAsJSON
Queries records of current result set as JSON array.
All
10.2
SQL.GetRecordsAsText
Queries all records as text.
All
5.3
SQL.InsertOrUpdateRecords
Creates or updates records in FileMaker database for current recordset.
All
7.3
SQL.InsertRecords
Creates records in FileMaker database for current recordset.
All
5.2
SQL.InternalSQLiteLibrary.Activate
Activates the internal SQLite library.
All
5.3
SQL.InternalSQLiteLibrary.Activated
Checks if internal SQLite library is used.
All
5.3
SQL.InternalSQLiteLibrary.Deactivate
Deactivates the use of internal SQLite library.
All
5.3
SQL.InternalSQLiteLibrary.ICUEnabled
Queries whether ICU libraries are enabled.
All
11.2
SQL.InternalSQLiteLibrary.ICULoaded
Queries whether ICU libraries are loaded.
All
11.2
SQL.InternalSQLiteLibrary.ICUUsed
Queries whether ICU libraries have been used.
All
11.2
SQL.InternalSQLiteLibrary.LoadICU
Loads ICU libraries now.
All
11.2
SQL.InternalSQLiteLibrary.SetICUEnabled
Sets whether to use ICU libraries.
All
11.2
SQL.InternalSQLiteLibrary.SourceID
Returns the source code ID.
All
5.3
SQL.InternalSQLiteLibrary.Version
Returns the SQLite version number.
All
5.3
SQL.InternalSQLiteLibrary.VersionNumber
Returns the SQLite version number.
All
5.3
SQL.ListCommands
Returns a list of all SQL Commands.
All
6.4
SQL.ListConnections
Returns a list of all SQL Connections.
All
6.4
SQL.MySQL.InsertID
For MySQL Connection queries the last insert ID.
All
2.9
SQL.NewCommand
Creates a new command.
All
2.6
SQL.NewConnection
Initialize a new SAConnection object and returns Connection Reference.
All
2.6
SQL.Open
Opens the specified command object.
All
2.6
SQL.ParamCount
Returns the number of parameters associated with the command object.
All
2.6
SQL.Prepare
Validates and prepares the current command for execution.
All
2.6
SQL.ResetCommand
Clears all DBMS related handles and sturctures but doesn't destroy them (mostly for Unix fork/exec based applications)
All
2.6
SQL.ResetConnection
Clears all DBMS related handles and structures but doesn't destroy them.
All
2.6
SQL.Rollback
Cancels any changes made during the current transaction and ends the transaction.
All
2.6
SQL.RowsAffected
Queries the number of rows affected.
All
2.6
SQL.SQLite3.EnableLoadExtension
Enables extensions on SQLite 3.
All
4.4
SQL.SQLite3.LastInsertRowID
For SQLite3, returns the last row ID used.
All
2.9
SQL.SQLite3.MemoryHighwater
Queries maximum memory usage so far.
All
7.4
SQL.SQLite3.MemoryUsed
Queries memory in use by SQLite.
All
7.4
SQL.SQLite3.ReKey
You can change the key on a database using the Rekey Function.
All
5.3
SQL.SQLite3.SetKey
Sets the encryption key to use.
All
5.3
SQL.ServerVersion
The long number of the currently connected server version.
All
2.6
SQL.ServerVersionString
Gets the currently connected DBMS server version string.
All
2.6
SQL.SetAutoCommit
Enables or disables autocommit for the current connection, that is, automatic commit of every SQL command.
All
2.6
SQL.SetClient
Assigns an DBMS client for the connection.
All
2.6
SQL.SetCommandOption
Sets a string value of a specific command option.
All
2.6
SQL.SetCommandTag
Sets the tag for the command.
All
6.4
SQL.SetCommandText
Sets the command text.
All
2.6
SQL.SetConnectionOption
Sets a string value of a specific connection or command option.
All
2.6
SQL.SetConnectionTag
Sets the tag for the connection.
All
6.4
SQL.SetFieldOption
Sets a string value of a specific field option.
All
2.6
SQL.SetIsolationLevel
Sets the transaction isolation level.
All
2.6
SQL.SetParamAsBoolean
Sets parameter's value as bool data.
All
2.6
SQL.SetParamAsContainer
Sets parameter's value as BLOB value with data from a container.
All
3.0
SQL.SetParamAsDate
Sets parameter's value as Date data.
All
2.6
SQL.SetParamAsDateTime
Sets parameter's value as DateTime data.
All
2.6
SQL.SetParamAsFloat
Sets parameter's value as floating point number.
All
2.6
SQL.SetParamAsNumber
Sets parameter's value as 32-bit integer number.
All
2.6
SQL.SetParamAsText
Sets parameter's value as character string data.
All
2.6
SQL.SetParamAsTime
Sets parameter's value as Time data.
All
2.6
SQL.SetParamDataType
Sets parameter's data type.
All
2.6
SQL.SetParamDefault
Sets the default value for this parameter.
All
2.6
SQL.SetParamNull
Sets parameter's value as null.
All
2.6
SQL.SetParamOption
Sets a string value of a specific parameter option.
All
8.4
SQL.SetParamTypesValues
Sets all parameters for a query in one call.
All
5.1
SQL.SetParamUnknown
Sets parameter's type as unknown.
All
2.6
SQL.SetParamValue
Sets parameter's value.
All
5.1
SQL.SetParamValues
Sets all parameters for a query in one call.
All
5.1
SQL.SetParamsWithJSON
Sets parameters based on values in JSON.
All
10.2
SQL.isAlive
Returns the database server connection status for a particular connection object.
All
2.6
SQL.isConnected
Returns the connection state for a particular connection object.
All
2.6
SQL.isExecuted
Whether command was executed.
All
2.6
SQL.isOpened
Tests whether the specified command object is opened.
All
2.6
SQL.isResultSet
Tests whether a result set exists after the command execution.
All
2.6
SSH.CloseChannel
Closes the channel.
All
6.3
SSH.ConfigureKeepAlive
Configures keep alive probes.
All
10.4
SSH.Connect
Connects a new socket to the given IP & Port.
All
6.3
SSH.Disconnect
Disconnects the session.
All
6.3
SSH.EOF
Check a channel's EOF status.
All
6.3
SSH.Execute
Executes something on the server.
All
6.3
SSH.Flush
Flush streams for this channel.
All
6.3
SSH.FreeChannel
Frees the SSH channel.
All
6.3
SSH.GetExitState
Get the remote exit code.
All
6.3
SSH.GetIP
Queries IP or domain used to connect.
All
6.3
SSH.GetPort
Queries port used to connect.
All
6.3
SSH.GetTag
Queries tag value.
All
6.3
SSH.GetTimeout
Queries timeout.
All
6.3
SSH.GetUserName
The user name we got authenticated for.
All
6.3
SSH.HostKey
Returns the hex encoded host key.
All
6.3
SSH.HostKeyHash
Returns the hex encoded host key hash.
All
6.3
SSH.IsAuthenticated
Queries the authentication state.
All
6.3
SSH.List
Lists all IDs of SSH connection objects.
All
13.0
SSH.New
Creates a new SSH session.
All
6.3
SSH.OpenSession
Opens a SSH channel.
All
6.3
SSH.ReadHex
Reads bytes from channel and returns them hex encoded.
All
6.3
SSH.ReadText
Reads bytes from channel and returns them as text.
All
6.3
SSH.Release
Frees the memory for the ssh session.
All
6.3
SSH.ReleaseAll
Release all SSH sessions.
All
10.5
SSH.RequestPTY
Request a PTY on an established channel.
All
6.3
SSH.SendEOF
Send EOF to remote server.
All
6.3
SSH.SessionHandshake
Perform the SSH handshake.
All
6.3
SSH.SetEnv
Set an environment variable on the channel.
All
6.3
SSH.SetTag
Sets the tag value.
All
6.3
SSH.SetTimeout
Sets timeout.
All
6.3
SSH.Shell
Request a shell on a channel.
All
6.3
SSH.Tunnel.BytesReceived
Queries number of bytes received.
All
8.5
SSH.Tunnel.BytesSent
Queries number of bytes sent.
All
8.5
SSH.Tunnel.Cancel
Cancel the tunnel.
All
8.5
SSH.Tunnel.Cancelled
Queries cancel state for tunnel.
All
8.5
SSH.Tunnel.GetConnected
Queries whether tunnel is connected and transfers data.
All
10.3
SSH.Tunnel.GetKeepAlive
Queries keep alive status.
All
10.2
SSH.Tunnel.Messages
Queries messages from tunnel.
All
8.5
SSH.Tunnel.Run
Creates a SSH tunnel on the session.
All
8.5
SSH.Tunnel.Running
Queries whether tunnel is running.
All
8.5
SSH.Tunnel.SetKeepAlive
Sets keep alive status.
All
10.2
SSH.UserAuthKeyboardInteractive
Authenticate a session using keyboard-interactive authentication.
All
6.3
SSH.UserAuthList
List supported authentication methods.
All
6.3
SSH.UserAuthPassword
Authenticate a session with username and password.
All
6.3
SSH.UserAuthPublicKey
Authenticate a session with a public key, read from memory.
All
6.3
SSH.UserAuthPublicKeyFile
Authenticate a session with a public key, read from a file.
All
6.3
SSH.WaitClosed
Wait for the remote to close the channel.
All
6.3
SSH.WaitEOF
Wait for the remote end to acknowledge an EOF request.
All
6.3
SSH.WaitSocket
Waits on the socket for sending or receiving.
All
6.3
SSH.WriteHex
Writes text to the channel.
All
6.3
SSH.WriteText
Writes text to the channel.
All
6.3
SendMail.AddAttachmentContainer
Adds an attachment to the email based on a container field.
All
4.3
SendMail.AddAttachmentFile
Adds an attachment to the email based on a file path.
All
4.3
SendMail.AddAttachmentText
Adds an attachment to the email based on a text.
All
6.5
SendMail.AddBCC
Adds a blind copy recipient.
All
4.3
SendMail.AddCC
Adds a copy recipient.
All
4.3
SendMail.AddHeader
Adds an header to the email.
All
4.3
SendMail.AddRecipient
Adds a recipient.
All
4.3
SendMail.AddReplyTo
Adds a recipient to reply to.
All
4.3
SendMail.AddTo
Adds a recipient.
All
4.3
SendMail.AttachmentCount
Queries number of attachments.
All
6.5
SendMail.ClearAttachments
Clears all attachments from this email.
All
4.3
SendMail.ClearHeaders
Clears the headers for email.
All
6.1
SendMail.ClearRecipients
Clears all recipients.
All
4.3
SendMail.CreateEmail
Creates a new email.
All
4.3
SendMail.GetHTMLText
Queries the html text of this email.
All
7.1
SendMail.GetInReplyTo
Queries the reply to address of this email.
All
7.1
SendMail.GetMessageID
Queries the message ID of this email.
All
7.1
SendMail.GetPlainText
Queries the plain text of this email.
All
7.1
SendMail.GetRichText
Queries the rich text of this email.
All
7.1
SendMail.GetSMTPPassword
Queries the smtp password of this email.
All
7.1
SendMail.GetSMTPServer
Queries the smtp server of this email.
All
7.1
SendMail.GetSMTPUserName
Queries the smtp username of this email.
All
7.1
SendMail.GetSource
Queries the source code for the email.
All
4.3
SendMail.GetSubject
Queries the subject of this email.
All
7.1
SendMail.PrepareCURL
Setups existing CURL session for an email transfer.
All
4.3
SendMail.Release
Releases all memory used by this email.
All
4.3
SendMail.ReleaseAll
Frees all SendMail objects.
All
10.5
SendMail.SetFrom
Sets the email from address.
All
4.3
SendMail.SetHTMLText
Sets the HTML text of the new email.
All
4.3
SendMail.SetInReplyTo
Sets the in reply to message ID.
All
4.3
SendMail.SetMessageID
Sets the message ID.
All
4.4
SendMail.SetPlainText
Sets the plain text of the new email.
All
4.3
SendMail.SetRichText
Sets the enriched text of the new email.
All
4.3
SendMail.SetSMTPPassword
Sets the password for SMTP server authentication.
All
4.3
SendMail.SetSMTPServer
Sets which SMTP server to use.
All
4.3
SendMail.SetSMTPUserName
Sets the username for SMTP server authentication.
All
4.3
SendMail.SetSubject
Sets the subject line.
All
4.3
SendMail.Sign
Signs the email.
All
11.4
SerialPort.AvailableBytes
Queries number of bytes available in buffer.
Mac/Win
4.4
SerialPort.Clear
Clears incoming buffer.
Mac/Win
7.4
SerialPort.ClearDataAvailableHandler
Clears the data available handler.
Mac/Win
5.1
SerialPort.Close
Closes serial port.
Mac/Win
3.0
SerialPort.CloseAll
Closes all serial ports.
Mac/Win
5.4
SerialPort.GetBaudRate
Queries the baud rate.
Mac/Win
3.1
SerialPort.GetCTS
Queries current CTS mode.
Mac/Win/Linux
3.4
SerialPort.GetDSR
Queries whether DSR mode is used.
Mac/Win/Linux
3.4
SerialPort.GetDTR
Queries whether DTR (data-terminal-ready) flow control is used.
Mac/Win/Linux
3.4
SerialPort.GetDataBits
Queries the data bit size.
Mac/Win
3.1
SerialPort.GetParity
Queries parity setting.
Mac/Win
5.0
SerialPort.GetRTS
Queries whether to use RTS (request-to-send) flow control.
Mac/Win/Linux
3.4
SerialPort.GetStopBits
Queries number of stop bits.
Mac/Win
5.0
SerialPort.GetTag
Queries tag value.
Mac/Win
13.0
SerialPort.GetXON
Queries if XON/XOFF flow control is used.
Mac/Win
3.4
SerialPort.HasLine
Checks if a line is available.
Mac/Win
7.0
SerialPort.IsSuspended
Checks suspension state.
Mac/Win
7.4
SerialPort.LastError
Returns the system error from last serial port function call.
Mac/Win
3.3
SerialPort.List
Returns list of names of serial ports.
Mac/Win
3.0
SerialPort.Open
Opens a serial port.
Mac/Win
3.0
SerialPort.OpenPath
Opens a special file, device or pipe.
Mac/Win
13.4
SerialPort.Path
Queries the path used to open the serial port.
Mac/Win
13.0
SerialPort.Read
Reads bytes from serial port and returns them as text.
Mac/Win
3.0
SerialPort.ReadByte
Reads a single byte to the serial port.
Mac/Win
3.0
SerialPort.ReadHex
Reads bytes from serial port and returns them hex encoded.
Mac/Win
3.0
SerialPort.ReadLine
Reads a line of text from serial port.
Mac/Win
7.0
SerialPort.Resume
Resumes serial port.
Mac/Win
7.4
SerialPort.SetBaudRate
Sets the baud rate.
Mac/Win
3.1
SerialPort.SetCTS
Sets CTS mode.
Mac/Win/Linux
3.4
SerialPort.SetDSR
Sets whether DSR mode is used.
Mac/Win/Linux
3.4
SerialPort.SetDTR
Sets whether DTR (data-terminal-ready) flow control is used.
Mac/Win/Linux
3.4
SerialPort.SetDataAvailableEvaluate
Sets the data available expression for this serial port.
Mac/Win
6.2
SerialPort.SetDataAvailableHandler
Sets the data available handler for this serial port.
Mac/Win
5.1
SerialPort.SetDataBits
Sets data bit size.
Mac/Win
3.1
SerialPort.SetParity
Sets parity setting.
Mac/Win
5.0
SerialPort.SetRTS
Sets whether to use RTS (request-to-send) flow control.
Mac/Win/Linux
3.4
SerialPort.SetStopBits
Sets number of stop bits.
Mac/Win
5.0
SerialPort.SetTag
Sets tag value.
Mac/Win
13.0
SerialPort.SetXON
Sets the serial port to use XON/XOFF mode.
Mac/Win
3.4
SerialPort.Suspend
Suspends serial port.
Mac/Win
7.4
SerialPort.WaitNamedPipe
Waits for a named pipe.
Win only
13.4
SerialPort.Write
Writes text to the serial port.
Mac/Win
3.0
SerialPort.WriteByte
Writes a single byte to the serial port.
Mac/Win
3.0
SerialPort.WriteHex
Writes text to the serial port.
Mac/Win
3.0
SharedMemory.Exists
Checks whether shared memory exists.
Mac/Win/Linux
10.1
SharedMemory.GetValue
Queries shared memory value.
Mac/Win/Linux
10.1
SharedMemory.LookupValue
Queries shared memory value.
Mac/Win/Linux
12.3
SharedMemory.SetValue
Sets shared memory value.
Mac/Win/Linux
10.1
Shell.AddArgument
Adds an argument.
Mac/Win/Linux
7.5
Shell.AddEnvironment
Adds an entry for environment variables.
Mac/Win/Linux
7.5
Shell.AvailableBytesError
Queries number of available bytes in error.
Mac/Win/Linux
7.5
Shell.AvailableBytesOutput
Queries number of available bytes in output.
Mac/Win/Linux
7.5
Shell.ClearArguments
Clears arguments list.
Mac/Win/Linux
7.5
Shell.ClearEnvironment
Clears list of environment variables.
Mac/Win/Linux
7.5
Shell.CloseInput
Closes input stream.
Mac/Win/Linux
8.3
Shell.CloseStreams
Closes all streams.
Mac/Win/Linux
8.3
Shell.Execute
Executes a child process.
Mac/Win/Linux
7.5
Shell.ExitCode
Queries exit code of child application.
Mac/Win/Linux
7.5
Shell.GetApplicationName
Queries application name.
Mac/Win/Linux
7.5
Shell.GetArgument
Queries argument.
Mac/Win/Linux
7.5
Shell.GetArgumentCount
Queries number of arguments.
Mac/Win/Linux
7.5
Shell.GetArguments
Queries arguments as list.
Mac/Win/Linux
9.3
Shell.GetBufferSize
Queries desired shell buffer size.
Mac/Win/Linux
10.3
Shell.GetCurrentDirectory
Queries current directory path.
Mac/Win/Linux
7.5
Shell.GetDomain
Queries domain name for login.
Mac/Win/Linux
7.5
Shell.GetEnvironment
Queries list with environment variables.
Mac/Win/Linux
7.5
Shell.GetPassword
Queries password for login.
Mac/Win/Linux
7.5
Shell.GetTag
Queries tag value.
Mac/Win/Linux
13.0
Shell.GetUsername
Queries user name.
Mac/Win/Linux
7.5
Shell.IsRunning
Queries whether application is running.
Mac/Win/Linux
7.5
Shell.List
Lists all IDs of shell objects.
Mac/Win/Linux
13.0
Shell.New
Creates a new shell object.
Mac/Win/Linux
7.5
Shell.PeekErrorText
Peeks into error output buffer.
Mac/Win/Linux
7.5
Shell.PeekOutputText
Peeks into output buffer.
Mac/Win/Linux
7.5
Shell.ProcessIdentifier
Queries process identifier of child process.
Mac/Win/Linux
7.5
Shell.ReadErrorText
Reads error.
Mac/Win/Linux
7.5
Shell.ReadOutputText
Reads output.
Mac/Win/Linux
7.5
Shell.Release
Frees the shell object.
Mac/Win/Linux
7.5
Shell.ReleaseAll
Frees all Shell objects.
Mac/Win/Linux
10.5
Shell.SetApplicationName
Sets the application name.
Mac/Win/Linux
7.5
Shell.SetArguments
Sets list of arguments to parameters of this functions.
Mac/Win/Linux
7.5
Shell.SetArgumentsList
Sets list of arguments.
Mac/Win/Linux
7.5
Shell.SetBufferSize
Sets desired shell buffer size.
Mac/Win/Linux
10.3
Shell.SetCurrentDirectory
Sets the current directory to use.
Mac/Win/Linux
7.5
Shell.SetDomain
Sets the domain to use for login.
Mac/Win/Linux
7.5
Shell.SetPassword
Sets the password for login.
Mac/Win/Linux
7.5
Shell.SetTag
Sets tag value.
Mac/Win/Linux
13.0
Shell.SetUsername
Sets the user name.
Mac/Win/Linux
7.5
Shell.Terminate
Terminates the child process.
Mac/Win/Linux
7.5
Shell.TerminationReason
Returns the reason the task was terminated.
Mac only
7.5
Shell.Wait
Waits for child process.
Mac/Win/Linux
7.5
Shell.WriteInputText
Writes a text to input stream.
Mac/Win/Linux
7.5
ShowURL
Shows an URL.
Mac/Win/iOS
2.4
SmartCard.Available
Whether SmartCard API is available.
Mac/Win
6.3
SmartCard.BeginTransaction
Starts a transaction.
Mac/Win
6.3
SmartCard.Cancel
Terminates all outstanding actions within a specific resource manager context.
Mac/Win
6.3
SmartCard.CancelTransaction
Cancels current transaction.
Mac/Win
6.3
SmartCard.Connect
Connects to a smartcard.
Mac/Win
6.3
SmartCard.Control
Direct control of the reader.
Mac/Win
6.3
SmartCard.Disconnect
Disconnects card.
Mac/Win
6.3
SmartCard.EndTransaction
Ends transaction.
Mac/Win
6.3
SmartCard.GetActiveProtocol
Queries the active protocol.
Mac/Win
6.3
SmartCard.GetAttribute
Retrieves the current reader attribute.
Mac/Win
6.3
SmartCard.Init
Initializes a smartcard context.
Mac/Win
6.3
SmartCard.ListReaderGroups
Queries list of reader groups.
Mac/Win
6.3
SmartCard.ListReaders
Queries list of readers.
Mac/Win
6.3
SmartCard.PerformSignature
Performs signature.
Mac/Win
7.0
SmartCard.ReadCertificate
Reads certificate for smart cards.
Mac/Win
7.0
SmartCard.ReadFile
Read file from smart card with APDU protocol.
Mac/Win
8.5
SmartCard.Reconnect
Reconnects to smart card with different protocol.
Mac/Win
6.3
SmartCard.Release
Releases context and all memory needed.
Mac/Win
6.3
SmartCard.ReleaseAll
Frees all SmartCard objects.
Mac/Win
10.5
SmartCard.SetAttribute
Sets the given reader attribute.
Mac/Win
6.3
SmartCard.SplitValues
Split values read from smart card.
Mac/Win
8.5
SmartCard.Status
Queries current status of smart card in reader.
Mac/Win
6.3
SmartCard.Transmit
Sends a service request to the smart card and expects to receive data back from the card.
Mac/Win
6.3
SmartCard.TransmitReceiveHeader
Returns the receive header from last Transmit.
Mac/Win
6.3
SmartCard.Valid
Determines whether a smart card context handle is valid.
Mac/Win
6.3
Socket.AcceptNewConnection
Accepts a new connection and returns a new socket.
All
3.1
Socket.AddMembership
Adds this socket to a multicast group.
All
7.5
Socket.AvailableBytes
Queries number of bytes in read buffer.
All
4.3
Socket.Check
Performs the socket event check.
All
5.1
Socket.CheckAll
Checks status of all sockets.
All
5.1
Socket.ClearDataAvailableHandler
Clears the data available handler.
All
3.1
Socket.ClearErrorHandler
Clears the error handler.
All
3.1
Socket.ClearNewConnectionHandler
Clears the new connection handler.
All
7.2
Socket.Close
Closes a socket.
All
3.1
Socket.CloseAll
Closes all open sockets.
All
4.3
Socket.Connect
Connects a TCP/IP socket to the given domain/IP on the given port.
All
3.1
Socket.DropMembership
Removes this socket from a multicast group.
All
7.5
Socket.EnableKeepAlive
Enables keep alive of TCP/IP socket.
All
10.3
Socket.GetBroadcast
Queries whether broadcasts are allowed.
All
5.3
Socket.GetMulticastInterface
Queries the interface to use for multicast.
All
7.5
Socket.GetMulticastLoop
Queries whether multicast packets are also sent to the sending socket.
All
5.3
Socket.GetMulticastTimeToLive
Queries time to live for multicast data packets.
All
5.3
Socket.GetReceiveBufferSize
Query receive buffer size.
All
11.1
Socket.GetSendBufferSize
Query send buffer size.
All
11.1
Socket.GetTag
Queries the tag value of the socket.
All
8.3
Socket.GetTimeToLive
Queries time to live for data packets.
All
5.3
Socket.IsClosed
Checks if socket got closed.
All
9.0
Socket.IsListening
Checks whether socket is listening.
All
9.0
Socket.LastError
Queries the last error code for the given socket.
All
4.3
Socket.LastMessageIP
Returns the IP from the last message received.
All
3.1
Socket.LastMessagePort
Returns the port from the last message received.
All
3.1
Socket.List
Liste all reference numbers for sockets.
All
9.2
Socket.Listen
Binds the socket to the port and starts listening.
All
3.1
Socket.LocalIP
Queries local IP.
All
8.0
Socket.LocalPort
Queries local port number.
All
8.0
Socket.NewTCPSocket
Creates a new TCP Socket.
All
3.1
Socket.NewUDPSocket
Creates a new UDP Socket.
All
3.1
Socket.Peek
Peeks bytes from socket and returns them as text.
All
3.1
Socket.PeekAll
Peeks bytes from socket and returns them as text.
All
4.3
Socket.PeekAllHex
Peeks from socket and returns them hex encoded.
All
4.3
Socket.PeekHex
Peeks from socket and returns them hex encoded.
All
3.1
Socket.Read
Reads bytes from socket and returns them as text.
All
3.1
Socket.ReadAll
Reads bytes from socket and returns them as text.
All
4.3
Socket.ReadAllHex
Reads bytes from socket and returns them hex encoded.
All
4.3
Socket.ReadHex
Reads bytes from socket and returns them hex encoded.
All
3.1
Socket.ReadLine
Reads a line of data from socket and returns them as text.
All
4.3
Socket.ReadLineHex
Reads a line of data from socket and returns them as text.
All
4.3
Socket.ReadMLLP
Reads bytes from socket and returns them as text.
All
3.1
Socket.RemoteIP
Returns IP of the remote socket.
All
3.1
Socket.RemotePort
Returns port of the socket on the other side.
All
3.1
Socket.SSL.Accept
Wait for a TLS/SSL client to initiate a TLS/SSL handshake.
All
3.5
Socket.SSL.Connect
Initiate the TLS/SSL handshake with an TLS/SSL server.
All
3.5
Socket.SSL.GetMethod
Queries the SSL method.
All
3.5
Socket.SSL.Initialize
Initializes a SSL connection.
All
3.5
Socket.SSL.Prepare
First step in SSL initialization.
All
3.5
Socket.SSL.SetMethod
Sets the SSL method for this socket.
All
3.5
Socket.SSL.UseCertificateFile
Defines to use a certificate key file for this SSL socket.
All
3.5
Socket.SSL.UsePrivateKeyFile
Defines to use a private key file for this SSL socket.
All
3.5
Socket.SendMessage
Sends an UDP data message.
All
3.1
Socket.SendMessageHex
Sends an UDP data message.
All
3.1
Socket.SetBroadcast
Enables or disables whether broadcasts are allowed.
All
5.3
Socket.SetDataAvailableURL
Sets the URL to query when data is available.
All
6.5
Socket.SetErrorURL
Sets the URL to query when error happens.
All
6.5
Socket.SetMulticastInterface
Sets the interface to use for multicast.
All
7.5
Socket.SetMulticastLoop
Sets whether multicast packets are also sent to the sending socket.
All
5.3
Socket.SetMulticastTimeToLive
Sets time to live for multicast data packets.
All
5.3
Socket.SetNewConnectionURL
Sets the URL to query when new connection is received.
All
6.5
Socket.SetReceiveBufferSize
Sets receive buffer size.
All
11.1
Socket.SetSendBufferSize
Sets send buffer size.
All
11.1
Socket.SetTag
Sets the tag of the socket.
All
8.3
Socket.SetTimeToLive
Sets time to live for data packets.
All
5.3
Socket.Write
Writes text to the socket.
All
3.1
Socket.WriteByte
Writes a single byte to the socket.
All
3.1
Socket.WriteHex
Writes text to the socket.
All
3.1
Socket.WriteMLLP
Writes text to the socket.
All
3.1
StoreRegistration
Stores registration on Mac in preferences file of FileMaker so the plugin can auto register itself on startup of FileMaker.
All
3.0
SyntaxColoring.ColorizeScript
Colorises a script text.
Mac only
12.1
SyntaxColoring.FormatCalculation   New in 14.1
Reformats the calculation text.
All
14.1
System.Logout
Logout current user.
Mac/Win
3.1
System.Restart
Restarts computer.
Mac/Win
3.1
System.Shutdown
Shuts computer down.
Mac/Win
3.1
System.Sleep
Asks computer to go to sleep (standby).
Mac/Win
3.1
SystemInfo.AppUsageStatistics
Queries information about resource utilization.
Mac/iOS
10.5
SystemInfo.AvailableRAM
Returns the size of the free RAM in bytes.
All
1.5
SystemInfo.CPUBrandString
Returns the CPU brand string.
All
2.8
SystemInfo.CPULoad
Queries system load statistics.
Mac/iOS
10.5
SystemInfo.ComputerName
Returns the name of the computer.
All
1.5
SystemInfo.DomainName
Returns the domain name of the current computer.
All
2.8
SystemInfo.DoubleClickTime
Queries the double click time for this computer in seconds.
All
3.1
SystemInfo.HardDiscSerial
Returns the hard disc serial number of the first hard disc which has a serial number.
Mac/Win
2.8
SystemInfo.HostDNSName
Queries the domain name for the host name.
All
5.0
SystemInfo.HostName
Returns the hostname for this computer.
All
2.8
SystemInfo.Is64bitWindows
Checks Windows on Windows status.
All
2.8
SystemInfo.IsAdminUser
Tries to check if user is admin user on the system.
All
5.2
SystemInfo.IsLowPowerModeEnabled
Queries Low Power mode.
All
11.3
SystemInfo.IsiOSAppOnMac
Whether the app is for iOS and runs on macOS.
All
11.0
SystemInfo.LinuxSystemInfo
Queries Linux system information details.
Linux only
11.2
SystemInfo.MACAddress
Returns the hardware ethernet address of the first ethernet card.
Mac/Win
2.8
SystemInfo.MacBoardID
Queries board-id for Mac.
Mac only
9.4
SystemInfo.MacBugFixVersion
Returns the BugFix part of the Mac OS version number.
Mac only
2.8
SystemInfo.MacMajorVersion
Returns the major Mac OS version number.
Mac only
2.8
SystemInfo.MacMinorVersion
Returns the minor Mac OS version number.
Mac only
2.8
SystemInfo.MacModel
Returns the Mac Model string.
Mac only
1.5
SystemInfo.MacROMBootVersion
Returns boot ROM version string.
Mac only
9.4
SystemInfo.MacSerialNumber
Returns the Mac Serial number.
Mac only
1.5
SystemInfo.MacSystemDarkMode
Queries dark mode setting for system.
Mac only
9.5
SystemInfo.MacUUID
Returns the system UUID on macOS.
Mac only
1.5
SystemInfo.MachoArchInfo
Queries Macho Architecture Info.
Mac/iOS
10.5
SystemInfo.NetworkStats
Queries network statistics for link layer on MacOS.
Mac only
10.0
SystemInfo.OSName
Returns the name of the operating system.
All
1.5
SystemInfo.OSVersionString
Returns the Name of the operating system with version.
All
1.5
SystemInfo.PhysicalRAM
Returns the size of the physical RAM in bytes.
All
1.5
SystemInfo.ProcessorCount
Returns the number of processors on the target system.
All
2.8
SystemInfo.SystemFont
Returns the system font.
Mac/Win
1.5
SystemInfo.Time
Returns current system time stamp as double.
All
3.0
SystemInfo.UserName
Returns the user name.
Mac/Win
1.5
SystemInfo.UserShortName
Returns the user's short name. eg 'admin'
Mac/Win
1.5
SystemInfo.WinBuildNumber
Returns the windows build number of the operating system.
Win/Linux
2.8
SystemInfo.WinMajorVersion
Returns the major version number of the operating system.
Win only
2.8
SystemInfo.WinMinorVersion
Returns the minor version number of the operating system.
Win only
2.8
SystemInfo.WinPlatformId
Returns the operating system platform.
Win only
2.8
SystemInfo.WinProductKey
Returns the product key of the Windows installation.
Win only
2.8
SystemInfo.WinProductType
Returns a number containing any additional information about the system.
Win only
2.8
SystemInfo.WinSuiteMask
Returns a bit mask that identifies the product suites available on the system.
Win only
2.8
SystemInfo.WinSystemMetrics
Retrieves the specified system metric or system configuration setting.
Win only
6.3
SystemInfo.WindowsMachineInfo
Queries system machine information.
Win only
11.2
SystemInfo.WindowsSystemInfo
Queries system information on Windows.
Win only
11.2
SystemInfo.isARM
Whether CPU is ARM based.
All
10.3
SystemInfo.isBigSur
Whether the operation system is macOS 11 Big Sur or newer.
All
10.3
SystemInfo.isCatalina
Whether the operation system is macOS 10.15 Catalina or newer.
All
9.3
SystemInfo.isElCapitan
Whether the operation system is macOS 10.10 El Capitan or newer.
All
6.3
SystemInfo.isHighSierra
Whether the operation system is macOS 10.13 High Sierra or newer.
All
7.5
SystemInfo.isMacOSX
Returns 1 if being called on macOS.
All
2.8
SystemInfo.isMavericks
Whether the operation system is macOS 10.9 Mavericks or newer.
All
3.5
SystemInfo.isMojave
Whether the operation system is macOS 10.14 Mojave or newer.
All
8.4
SystemInfo.isMonterey
Whether the operation system is MacOS 12 Monterey or newer.
All
11.3
SystemInfo.isSierra
Whether the operation system is macOS 10.12 Sierra or newer.
All
6.3
SystemInfo.isSonoma
Whether the operation system is macOS 14 Sonoma or newer.
All
13.3
SystemInfo.isTranslated
Queries whether application is translated on Apple Silicon Macs.
All
10.3
SystemInfo.isVentura
Whether the operation system is macOS 13 Ventura or newer.
All
12.3
SystemInfo.isWindows10
Returns 1 if called on Windows 10 or higher.
All
5.2
SystemInfo.isWindows11
Returns 1 if called on Windows 11.
All
11.4
SystemInfo.isWindows8
Returns 1 if called on Windows 8.
All
2.8
SystemInfo.isYosemite
Whether the operation system is macOS 10.11 Yosemite or newer.
All
6.3
TOTP.Calculate
Calculates a Time-based one-time password.
All
12.3
TOTP.CurrentTime
Queries current time.
All
12.3
TOTP.DecodeFromBase32
Decode a base 32 string.
All
13.4
TOTP.EncodeToBase32
Encode a base32 string.
All
13.4
Text.AddLineNumbers
Adds line numbers to text.
All
8.3
Text.AppendTextFile
Appends a text file with the given text.
All
2.8
Text.CapitalCase
Converts text to capital case letters.
All
5.1
Text.Character
Creates a character with given number.
All
5.2
Text.Characters
Returns the character codes.
All
5.2
Text.Code
Queries the number of a character.
All
5.2
Text.Concat
Creates a text with concatenating all the given parameters.
All
11.5
Text.ConcatWithDelimiter
Creates a text with concatenating all the given parameters.
All
13.3
Text.ConvertFromTextEncoding
Converts text from a text encoding.
All
9.4
Text.ConvertToTextEncoding
Converts text into a text encoding.
All
9.4
Text.ConvertUnicodeToCharacterComposition
Converts text by applying unicode character normalization.
All
5.2
Text.ConvertUnicodeToCharacterDecomposition
Converts text by applying unicode character normalization.
All
5.2
Text.CountWords
Counts words.
All
8.1
Text.DecodeBytesFromBase64
Decodes base64 string and encodes it as byte values.
All
3.0
Text.DecodeFromBase64
Decode a base 64 string.
All
3.0
Text.DecodeFromBase64URL
Decode a base 64 URL string.
All
7.5
Text.DecodeFromBytes
Decode a byte string.
All
3.0
Text.DecodeFromHTML
Decodes html text.
All
2.4
Text.DecodeFromHex
Decode a hex string.
All
2.4
Text.DecodeFromQuotedPrintable
Decodes a string with quoted printable encoding.
All
4.3
Text.DecodeFromURL
Decode an URL string.
All
2.6
Text.DecodeFromXML
Decodes xml text.
All
4.3
Text.DecodeHexFromBase64
Decodes base64 string and encodes it as hex values.
All
3.0
Text.DecodeIMAPFolderName
Decodes text from IMAP UTF-7.
All
9.2
Text.DecodeURLComponent
Decodes an URL component.
All
3.1
Text.Deserialize
Restores a styled text.
All
5.4
Text.EncodeBytesToBase64
Encodes string with byte values to base 64.
All
3.0
Text.EncodeEmailSubject
Encodes an email subject.
All
4.3
Text.EncodeHexToBase64
Encodes hex string to base 64.
All
3.0
Text.EncodeToBase64
Encode a base64 string.
All
3.0
Text.EncodeToBase64URL
Encode a base64 URL string.
All
7.5
Text.EncodeToBytes
Encode a byte string.
All
3.0
Text.EncodeToHTML
Encodes text as html.
All
2.4
Text.EncodeToHex
Encode a hex string.
All
2.4
Text.EncodeToQuotedPrintable
Returns a string with quoted printable characters.
All
4.3
Text.EncodeToURL
Encode an URL string.
All
2.6
Text.EncodeToXML
Encodes text as xml.
All
4.3
Text.EncodeURLComponent
Encodes an URL component.
All
3.1
Text.FileExtensionToMimeType
Finds a mime type for a file extension.
All
5.4
Text.FilterASCII
Filters text to ASCII.
All
10.4
Text.FilterUTF16
Filters text to UTF-16.
All
9.3
Text.FindBetween
Searches text for text between the two search strings.
All
3.0
Text.FromStyles
Creates styled text from JSON made with Text.Style.
All
11.3
Text.IdentifyData   New in 14.0
Checks file type from the data.
All
14.0
Text.InvalidCharactersForEncoding
Looks for invalid characters for an encoding.
All
5.2
Text.JaroWinklerDistance
Calculates the string distance.
All
2.9
Text.Length
Query length of text.
All
7.2
Text.LevenshteinDistance
Calculates the string distance.
All
2.9
Text.List
Creates a list with all the given parameters.
All
11.5
Text.ListWords
Split words and list them.
All
8.1
Text.LowerCase
Converts text to lower case letters.
All
5.1
Text.MergeFields
Merge field and variable names into text.
All
8.5
Text.MimeTypeToFileExtension
Returns file extension for given mime type.
All
5.4
Text.RTFToText
Parses RTF to styled text.
All
11.3
Text.ReadEMLXFile
Reads email text from emlx file.
All
5.3
Text.ReadTextFile
Reads a text file.
All
2.4
Text.ReadTextFromContainer
Reads content of container value as text.
All
4.4
Text.RedefineEncoding
Takes a text in a given encoding and reencodes it with other encoding.
All
5.2
Text.RemoveAccents
Returns text without accents.
All
2.1
Text.RemoveAccentsCaseInsensitive
Returns text without accents.
All
2.1
Text.RemoveControlCharacters
Removes control characters.
All
5.1
Text.RemoveNewLine
Removes newline characters from string.
All
2.4
Text.RemovePostfix
Removes the postfix from text.
All
6.1
Text.RemovePrefix
Removes the prefix from text.
All
6.1
Text.ReplaceAll
Find & Replace all occurrences of a text.
All
7.3
Text.ReplaceNewline
Replaces newline characters.
All
2.4
Text.Reverse
Reverses the order of characters in the text.
All
12.1
Text.Serialize
Serializes styled text as text.
All
5.4
Text.SoundEx
Returns soundex string for the given text.
All
2.1
Text.SoundExGerman
Returns soundex string for the given text.
All
3.5
Text.Styles
Queries style information as JSON.
All
9.3
Text.TextToHTML
Creates HTML text for a given FileMaker formatted styled text.
All
4.3
Text.TextToRTF
Creates RTF text for a given FileMaker formatted styled text.
All
2.4
Text.Trim
Trims whitespace on the left and right side.
All
8.2
Text.UpperCase
Converts text to upper case letters.
All
5.1
Text.WriteTextFile
Writes a text file with the given text.
All
2.4
Text.WriteToContainer
Write a text as a FILE in a container.
All
4.4
Time.Format
Formats a date with C time formatting functions.
All
6.4
Time.Parse
Parses a date.
All
6.4
Time.Sleep
Delays execution for the given number of milliseconds.
All
4.1
Time.TimeStampToUTC
Converts timestamp to UTC.
All
6.1
Time.TimeZoneOffset
Queries time zone offset.
All
9.1
Time.UnixTimeStamp
Returns the unix time stamp.
All
3.1
Time.UnixTimeStampToFileMaker
Converts time from unix to FileMaker.
All
8.3
Time.Wait
Waits for the given number of milliseconds.
All
11.2
TouchBar.List
Lists all IDs of Touch Bar objects.
Mac only
13.0
Trace
Starts logging all plugin calls to a text file.
All
2.4
Trace.GetErrorsOnly
Queries whether to trace only errors.
All
9.3
Trace.GetServerLogPath
Queries server log path.
All
10.4
Trace.GetWithTimes
Queries whether to trace with times.
All
9.3
Trace.IsEnabled
Queries trace on/off status.
All
11.2
Trace.IsPaused
Queries pause state of trace function.
All
11.2
Trace.Off
Disables tracing.
All
3.3
Trace.Path
Queries current trace path.
All
11.2
Trace.Pause
Pauses trace logging until you resume.
All
11.2
Trace.Resume
Resumes trace logging.
All
11.2
Trace.SetErrorsOnly
Sets whether to only log trace.
All
9.3
Trace.SetServerLogPath
Enables logging per thread for server.
All
10.4
Trace.SetWithTimes
Sets whether to include times in traces.
All
9.3
Trace.WriteLine
Adds line to trace logging.
All
9.1
UNNotification.List
Lists all IDs of notification objects.
Mac/iOS
13.0
USB.Count
Queries all USB Devices and returns the number of found devices.
Mac/Win
2.4
USB.FindDevice
Finds USB devices.
Mac/Win
2.4
USB.FindSerialNumber
Searches the USB device list for a device with the given serial number.
Mac/Win
2.4
USB.GetProductID
Queries the product ID of an USB device.
Mac/Win
2.4
USB.GetProductName
Queries the product name of an USB device.
Mac/Win
2.4
USB.GetSerialNumber
Queries the serial number of an USB device.
Mac/Win
2.4
USB.GetVendorID
Queries the vendor ID of an USB device.
Mac/Win
2.4
USB.GetVendorName
Queries the vendor name of an USB device.
Mac/Win
2.4
UUID.Formatted
Creates a new UUID/GUID and returns it as a formatted string.
All
2.3
UUID.FromNumber
Converts from formatted UUID to UUID number.
All
8.2
UUID.Hex
Creates a new UUID/GUID and returns it as a hex string.
All
2.3
UUID.Number
Creates new UUID number.
All
8.2
UUID.Raw
Creates a new UUID/GUID and returns it as a 16 byte string. The string is not for displaying to users, but for small footprint on storage.
All
2.3
UUID.ToNumber
Converts from UUID number to formatted UUID.
All
8.2
UnZipFile.Close
Closes the current zip file.
All
3.4
UnZipFile.GlobalComment
Reads the global comment of the zip archive.
All
3.4
UnZipFile.ItemCRC
Queries the checksum for a file.
All
3.4
UnZipFile.ItemComment
Queries the file comment of the given item.
All
3.4
UnZipFile.ItemCompressedSize
Queries compressed item size.
All
3.4
UnZipFile.ItemCompressionMethod
Queries the compression method used for this item.
All
3.4
UnZipFile.ItemCount
Queries number of items in the archive.
All
3.4
UnZipFile.ItemDate
Queries file date of item.
All
3.4
UnZipFile.ItemDiskNumberStart
Queries the disk number start.
All
3.4
UnZipFile.ItemExternalFileAttributes
Queries the external file attributes for this item.
All
3.4
UnZipFile.ItemFlag
Queries the flags for this item.
All
3.4
UnZipFile.ItemInternalFileAttributes
Queries the internal file attributes for this item.
All
3.4
UnZipFile.ItemName
Queries the file name of the given item.
All
3.4
UnZipFile.ItemSizeFileComment
Queries the size of the comment in bytes.
All
3.4
UnZipFile.ItemSizeFileExtra
Queries the size of extra file data.
All
3.4
UnZipFile.ItemSizeFileName
Queries the size of the file name.
All
3.4
UnZipFile.ItemUncompressedSize
Queries uncompressed item size.
All
3.4
UnZipFile.ItemVersion
Queries the version number of the zip format used to create this entry.
All
3.4
UnZipFile.ItemVersionNeeded
Returns the version needed to uncompress this entry.
All
3.4
UnZipFile.ReadAsFileContainer
Reads the file with given index as container value with data.
All
3.4
UnZipFile.ReadAsGIFContainer
Reads the file with given index as container value with GIF data.
All
3.4
UnZipFile.ReadAsHex
Reads the file with given index as data and return hex text.
All
3.4
UnZipFile.ReadAsJPEGContainer
Reads the file with given index as container value with JPEG data.
All
3.4
UnZipFile.ReadAsPNGContainer
Reads the file with given index as container value with PNG data.
All
3.4
UnZipFile.ReadAsText
Reads the file with given index as text.
All
3.4
UnZipFile.ReadToFile
Reads file from archive and writes it to a new file.
All
3.4
UnZipFile.UsePassword
Sets the password to use for uncompressing.
All
5.1
Unregister
Unregisters the plugin license.
All
1.6
Version
Useful for doing auto-updates from server and version checking.
All
1.0
VersionAutoUpdate
Returns the version in the auto update format. e.g. 02040028
All
2.4
Vision.ClassifyImage
Classifies content of image.
Mac/iOS
9.4
Vision.DetectBarcode
Detects barcodes in images.
Mac/iOS
9.4
Vision.KnownClassifications
Queries classifications.
Mac/iOS
9.4
Vision.RecognizeText
Recognizes text.
Mac/Win/iOS
9.4
Vision.RecognizeTextJSON
Recognizes text and returns result as JSON.
Mac/iOS
13.2
Vision.SupportedRecognitionLanguages
Queries supported languages.
Mac/Win/iOS
9.4
Vision.SupportedSymbologies
Queries list of supported barcode types.
Mac/iOS
9.4
WMFP.Create
Creates a new player.
Win only
10.0
WMFP.FrameStep
Steps forward one video frame.
Win only
10.0
WMFP.GetAudioBitsPerSample
Number of bits per audio sample in an audio media type.
Win only
13.2
WMFP.GetAudioChannels
Number of audio channels in an audio media type.
Win only
13.2
WMFP.GetAudioSamplesPerSecond
Number of audio samples per second in an audio media type.
Win only
13.2
WMFP.GetBalance
Queries current audio balance.
Win only
10.0
WMFP.GetDuration
Queries duration.
Win only
10.0
WMFP.GetIdealVideoSize
Queries ideal video size.
Win only
10.0
WMFP.GetMute
Queries whether the audio is muted.
Win only
10.0
WMFP.GetNativeVideoSize
Queries native video size.
Win only
10.0
WMFP.GetPosition
Queries current position.
Win only
10.0
WMFP.GetRate
Queries the current playback rate.
Win only
10.0
WMFP.GetState
Queries state of player.
Win only
10.0
WMFP.GetTag
Queries the tag string for this player.
Win only
10.0
WMFP.GetVideoFrameRate
Frame rate of a video media type, in frames per second.
Win only
13.2
WMFP.GetVolume
Queries the audio volume.
Win only
10.0
WMFP.List
Lists all IDs of windows media player objects.
Win only
13.0
WMFP.Pause
Pauses playback.
Win only
10.0
WMFP.Play
Starts playback.
Win only
10.0
WMFP.Release
Frees the player.
Win only
10.0
WMFP.ReleaseAll
Frees all player objects.
Win only
10.5
WMFP.SetBalance
Sets current audio balance.
Win only
10.0
WMFP.SetFrame
Repositions player to given control.
Win only
10.0
WMFP.SetMute
Sets whether the audio is muted.
Win only
10.0
WMFP.SetPlaybackEndedScriptTrigger
Sets the playback ended script trigger.
Win only
10.0
WMFP.SetPosition
Sets the position.
Win only
10.0
WMFP.SetRate
Sets the current playback rate.
Win only
10.0
WMFP.SetTag
Sets the tag string for this player.
Win only
10.0
WMFP.SetVolume
Sets the audio volume.
Win only
10.0
WMFP.Stop
Stops playback.
Win only
10.0
WMIQuery.Connect
Connects to WMI server.
Win only
5.2
WMIQuery.New
Creates a new WMI Query object.
Win only
5.2
WMIQuery.Next
Queries the next item in the result of a query.
Win only
5.2
WMIQuery.PropertyNames
Queries a list of property names for current item.
Win only
5.2
WMIQuery.PropertyType
Queries data type of a property.
Win only
5.2
WMIQuery.PropertyValue
Queries the value of the property.
Win only
5.2
WMIQuery.Query
Executes a query.
Win only
5.2
WMIQuery.Release
Releases a query object.
Win only
5.2
WMIQuery.ReleaseAll
Frees all query objects.
Win only
10.5
WebHook.Check
Checks whether a web hook has been triggered.
All
11.5
WebHook.Create
Creates a new web hook object.
All
11.5
WebHook.GetAutoAnswer
Queries auto answer.
All
11.5
WebHook.GetCertificateFile
Queries file path for certificate file.
All
11.5
WebHook.GetConnectionCounter
Queries number of connections accepted.
All
11.5
WebHook.GetMaximumRequestSize
Queries maximum allowed request size.
All
12.1
WebHook.GetMode
Queries keep open flag.
All
11.5
WebHook.GetPort
Queries listening port for a web hook.
All
11.5
WebHook.GetPrivateKeyFile
Queries file path for private key file.
All
11.5
WebHook.GetSSL
Whether SSL is enabled.
All
11.5
WebHook.GetTimeOut
Queries the timeout for the hook.
All
12.0
WebHook.GetWebRequestCounter
Queries number of web requests created.
All
11.5
WebHook.List
Lists all web hook objects with their reference numbers.
All
11.5
WebHook.Listen
Starts listening for incoming requests on this port.
All
11.5
WebHook.Release
Releases the object and all memory used for it.
All
11.5
WebHook.SetAutoAnswer
Sets auto answer text.
All
11.5
WebHook.SetMaximumRequestSize
Sets maximum allowed request size.
All
12.1
WebHook.SetMode
Sets mode flags.
All
11.5
WebHook.SetSSL
Sets SSL certificate and key to use.
All
11.5
WebHook.SetTimeOut
Sets the timeout for the hook.
All
12.0
WebRequest.GetBody
Queries body for HTTP request.
All
11.5
WebRequest.GetBodyAsContainer
Queries body for HTTP request as container.
All
11.5
WebRequest.GetBodySize
Queries size of body in bytes.
All
12.1
WebRequest.GetHTTPMethod
Queries HTTP method for the request.
All
11.5
WebRequest.GetHTTPVersion
Queries HTTP method.
All
11.5
WebRequest.GetHeaders
Queries HTTP headers as JSON.
All
11.5
WebRequest.GetHost
Queries host name from HTTP headers.
All
11.5
WebRequest.GetLocalIP
Queries local IP for web hook.
All
11.5
WebRequest.GetLocalPort
Queries local port number
All
11.5
WebRequest.GetMode
Queries mode of request.
All
13.0
WebRequest.GetRawData
Get raw data of full request.
All
11.5
WebRequest.GetRemoteIP
Queries remote IP address.
All
11.5
WebRequest.GetRemotePort
Queries remote port number.
All
11.5
WebRequest.GetSSL
Whether this web request comes in with SSL.
All
11.5
WebRequest.GetSize
Queries size of whole request.
All
12.1
WebRequest.GetState
Queries the state of the web request.
All
12.0
WebRequest.GetURL
Queries HTTP URL received.
All
11.5
WebRequest.GetWebHook
Queries the web hook for this web request.
All
11.5
WebRequest.List
Lists all web request objects with their reference numbers.
All
11.5
WebRequest.Release
Releases the object and all memory used for it.
All
11.5
WebRequest.Send
Send custom answer.
All
11.5
WebRequest.URLComponents
Queries parsed URL components.
All
11.5
WinPDF.GeneratePreview
Adds preview to an existing PDF container.
Mac/Win/iOS
13.2
WinPDF.IsPasswordProtected
Whether this document is password-protected.
Win only
13.2
WinPDF.List
Returns list of all Windows PDF IDs.
Win only
13.2
WinPDF.LoadContainer
Loads a PDF document from data in container.
Win only
13.2
WinPDF.LoadFile
Loads a PDF document from file synchronously.
Win only
13.2
WinPDF.PageBox
Queries page dimensions.
Win only
13.2
WinPDF.PageCount
Gets the number of pages in the Portable Document Format (PDF) document.
Win only
13.2
WinPDF.PageHeight
Queries page height.
Win only
13.2
WinPDF.PageImage
Renders a page to an image.
Win only
13.2
WinPDF.PageImageAtSize
Renders a page to an image.
Win only
13.2
WinPDF.PagePreferredZoom
Gets the Portable Document Format (PDF) page's preferred magnification factor.
Win only
13.2
WinPDF.PageRotation
Queries rotation for a page.
Win only
13.2
WinPDF.PageWidth
Queries page width.
Win only
13.2
WinPDF.Release
Releases an object reference.
Win only
13.2
WinPDF.ReleaseAll
Releases all PDF documents.
Win only
13.2
WindowsML.BindDouble
Binds values to an input feature.
Win only
10.5
WindowsML.BindFloat
Binds values to an input feature.
Win only
10.5
WindowsML.BindFloat16
Binds values to an input feature.
Win only
10.5
WindowsML.BindImageFile
Binds values to an input feature.
Win only
10.5
WindowsML.BindInt16
Binds values to an input feature.
Win only
10.5
WindowsML.BindInt32
Binds values to an input feature.
Win only
10.5
WindowsML.BindInt64
Binds values to an input feature.
Win only
10.5
WindowsML.BindInt8
Binds values to an input feature.
Win only
10.5
WindowsML.BindUInt16
Binds values to an input feature.
Win only
10.5
WindowsML.BindUInt32
Binds values to an input feature.
Win only
10.5
WindowsML.BindUInt64
Binds values to an input feature.
Win only
10.5
WindowsML.BindUInt8
Binds values to an input feature.
Win only
10.5
WindowsML.Clear
Clears the properties for this model.
Win only
10.5
WindowsML.Description
Queries description of model.
Win only
10.5
WindowsML.Evaluate
Evaluates the model and returns result as JSON.
Win only
10.5
WindowsML.List
Lists all IDs of ML objects.
Win only
13.1
WindowsML.Open
Loads a model for Windows Machine Learning.
Win only
10.5
WindowsML.Release
Releases a model.
Win only
10.5
WindowsML.ReleaseAll
Release all Windows machine learning models.
Win only
10.5
WindowsOCR.Available
Whether OCR is available.
Win only
13.1
WindowsOCR.AvailableRecognizerLanguages
Returns a list of all available OCR languages on the device.
Win only
13.1
WindowsOCR.CurrentInputMethodLanguageTag
Queries current language tag for the user.
Win only
13.1
WindowsOCR.IsLanguageSupported
Whether a language is supported for OCR.
Win only
13.1
WindowsOCR.List
Lists all IDs of OCR engine objects.
Win only
13.1
WindowsOCR.MaxImageDimension
Gets the maximum image pixel dimensions supported by the OCR engine.
Win only
13.1
WindowsOCR.New
Creates a new OCR engine.
Win only
13.1
WindowsOCR.Recognize
Scans the specified image for text.
Win only
13.1
WindowsOCR.RecognizeFile
Scans the specified image for text.
Win only
13.1
WindowsOCR.RecognizerLanguage
Queries the language used for the recognizer.
Win only
13.1
WindowsOCR.Release
Releases the object and all memory used for it.
Win only
13.1
WindowsOCR.ReleaseAll
Release all our objects.
Win only
13.1
WindowsOCR.Result
Queries a JSON with result of the OCR.
Win only
13.1
WindowsOCR.Text
Gets the recognized text.
Win only
13.1
WindowsOCR.TextAngle
Gets the clockwise rotation of the recognized text, in degrees, around the center of the image.
Win only
13.1
WindowsScript.AddCode
Adds the code to the specified script.
Win only
1.1
WindowsScript.Close
Removes the specified script from memory.
Win only
1.1
WindowsScript.Create
Creates a Windows Script in memory.
Win only
1.1
WindowsScript.ErrorClear
Clears the old errors
Win only
1.1
WindowsScript.ErrorColumn
Returns the error column of the last error.
Win only
1.1
WindowsScript.ErrorDescription
Returns the text description of the error.
Win only
1.1
WindowsScript.ErrorLine
Returns the error line of the last error.
Win only
1.1
WindowsScript.ErrorNumber
Returns the number of the last error in a VB script.
Win only
1.1
WindowsScript.ErrorSource
This function returns the name of the module that had the error.
Win only
1.1
WindowsScript.ErrorText
Returns the Line of the Script that contains the error.
Win only
1.1
WindowsScript.Eval
Evaluates the "text" and returns the result.
Win only
1.1
WindowsScript.ExecuteFunction
Runs the script specified by the Script ID.
Win only
1.1
WindowsScript.ExecuteStatement
Executes a statement.
Win only
1.1
WindowsScript.GetAllowUI
Returns the Allow UI State of the specified script.
Win only
1.1
WindowsScript.GetLanguage
Queries the current language.
Win only
1.1
WindowsScript.GetTimeout
Each script has a setting that dictates how long a script will wait before timing out.
Win only
1.1
WindowsScript.GetUseSafeSubset
Returns the Safe Subset State of the specified script.
Win only
1.1
WindowsScript.SetAllowUI
Sets the "Allow UI State of the specified script.
Win only
1.1
WindowsScript.SetLanguage
Returns the Line of the Script that contains the error.
Win only
1.1
WindowsScript.SetTimeout
Each script has a setting that dictates how long a script will wait before timing out.
Win only
1.1
WindowsScript.SetUseSafeSubset
Sets the Safe Subset State of the specified script.
Win only
1.1
WordFile.Append
Appends one word file text to other.
All
7.5
WordFile.AppendTableRow
Duplicates and appends a table row containing a placeholder.
All
7.1
WordFile.Contains
Checks if some text exists in the document.
All
11.4
WordFile.DuplicateTableRow
Duplicates a table row containing a placeholder.
All
7.1
WordFile.FieldNames
Queries field names in the file.
All
7.5
WordFile.GetCaseless
Queries caseless state.
All
7.4
WordFile.GetFieldText
Queries field value.
All
7.5
WordFile.GetMediaFile
Queries media file in word file.
All
6.3
WordFile.GetXML
Queries xml content of the word file.
All
6.2
WordFile.HasTag
Checks if a tag exists.
All
5.4
WordFile.List
Lists all IDs of word file objects.
All
13.0
WordFile.MediaFiles
Queries list of media files in the word file.
All
6.3
WordFile.OpenContainer
Opens a word file from container.
All
5.4
WordFile.OpenFile
Opens a word file from file.
All
5.4
WordFile.OpenText
Opens a word xml file from text.
All
5.4
WordFile.Parts
Queries names of the parts of the document.
All
6.2
WordFile.Release
Frees the memory used for the word file.
All
5.4
WordFile.ReleaseAll
Releases all word file objects.
All
10.5
WordFile.RemoveTableRow
Removes a table row containing a placeholder.
All
7.0
WordFile.ReplaceTag
Replaces a placeholder with text.
All
5.4
WordFile.SetCaseless
Sets caseless state.
All
7.4
WordFile.SetFieldText
Sets field value.
All
7.5
WordFile.SetMarkers
Sets the markers to look for before/after a tag.
All
6.3
WordFile.SetMediaFile
Sets a media file image.
All
6.3
WordFile.SetXML
Sets the xml for this word file.
All
6.2
WordFile.Substitute
Replaces some text in the document with new text.
All
11.4
WordFile.Tags
Queries list of tags.
All
12.2
WordFile.Texts
Extracts text of word file.
All
5.4
WordFile.WriteContainer
Writes a file to container.
All
11.4
WordFile.WriteFile
Writes a file to disk.
All
5.4
X509.Description
Provides a description of the certificate.
All
7.0
X509.Duplicate
Creates a copy of the certificate.
All
7.0
X509.IssuerName
The issuer name.
All
7.0
X509.List
Lists all IDs of X509 objects.
All
13.0
X509.Name
The name of the certificate.
All
7.0
X509.Read
Reads a PEM certificate from text.
All
7.0
X509.ReadFromContainer
Reads a certificate from a container value.
All
7.0
X509.ReadFromFile
Reads a certificate from a PEM file.
All
7.0
X509.Release
Releases the certificate from memory.
All
7.0
X509.ReleaseAll
Release all certificates.
All
10.5
X509.SerialNumber
Queries the serial number.
All
7.0
X509.SubjectName
The subject name.
All
7.0
X509.ValidNotAfter
The date where the certificate expires.
All
10.3
X509.ValidNotBefore
The date where the certificate was created.
All
10.3
X509.Version
Queries the version of the file.
All
7.0
X509.Write
Writes certificate.
All
9.1
XL.Book.AddCustomNumFormat
Adds a new custom number format to the workbook.
All
3.5
XL.Book.AddFont
Adds a new font to the workbook, initial parameters can be copied from other font.
All
3.5
XL.Book.AddFontFromBook
Copies a font definition.
All
11.2
XL.Book.AddFormat
Adds a new format to the workbook, initial parameters can be copied from other format.
All
3.5
XL.Book.AddFormatFromBook
Copies a format definition.
All
11.2
XL.Book.AddPictureContainer
Adds a picture to the workbook from container.
All
3.5
XL.Book.AddPictureFile
Adds a picture to the workbook.
All
3.5
XL.Book.AddSheet
Adds a new sheet to this book, returns the sheet index.
All
3.5
XL.Book.BiffVersion
Returns BIFF version of binary file.
All
3.5
XL.Book.CustomNumFormat
Returns a custom format string for specified custom format identifier fmt.
All
3.5
XL.Book.DeleteSheet
Deletes a sheet with specified index.
All
3.5
XL.Book.DeleteSheetsExcept
Deletes all sheets except the one with given name.
All
5.4
XL.Book.FontCount
Returns a number of fonts in this book.
All
3.5
XL.Book.FormatCount
Returns a number of formats in this book.
All
3.5
XL.Book.GetActiveSheet
Returns an active sheet index in this workbook.
All
3.5
XL.Book.GetCalcMode
Queries current calculation mode.
All
10.2
XL.Book.GetDefaultFontName
Returns a default font name for this workbook.
All
3.5
XL.Book.GetDefaultFontSize
Returns a default font size for this workbook.
All
3.5
XL.Book.GetPicture
Returns a picture at position index.
All
3.5
XL.Book.GetPictureType
Returns a picture type at position index.
All
3.5
XL.Book.GetRGBMode
Returns whether the RGB mode is active.
All
3.5
XL.Book.GetRefR1C1
Returns whether the R1C1 reference mode is active.
All
3.5
XL.Book.GetText
Queries the text of a workbook.
All
3.5
XL.Book.InsertSheet
Inserts a new sheet to this book at position index, returns the new sheet index.
All
3.5
XL.Book.IsDate1904
Returns whether the 1904 date system is active.
All
7.2
XL.Book.IsTemplate
Returns whether the workbook is template.
All
7.2
XL.Book.IsWriteProtected
Queries whether the workbook is marked as read-only.
All
13.1
XL.Book.MoveSheet
Moves a sheet.
All
7.2
XL.Book.PictureCount
Returns a number of pictures in this workbook.
All
3.5
XL.Book.Release
Frees a workbook from memory.
All
3.5
XL.Book.ReleaseAll
Releases all books from memory.
All
10.0
XL.Book.Save
Writes excel file to container for storing in database.
All
3.5
XL.Book.SaveToFile
Saves current workbook into xls-file.
All
3.5
XL.Book.SetActiveSheet
Sets an active sheet index in this workbook.
All
3.5
XL.Book.SetCalcMode
Sets the current calculation mode.
All
10.2
XL.Book.SetDate1904
Sets the date system mode.
All
7.2
XL.Book.SetDefaultFont
Sets a default font name and size for this workbook.
All
3.5
XL.Book.SetRGBMode
Sets a RGB mode.
All
3.5
XL.Book.SetRefR1C1
Sets the R1C1 reference mode.
All
3.5
XL.Book.SetTemplate
Sets the template flag.
All
7.2
XL.Book.SheetCount
Queries how many sheets are part of the workbook.
All
3.5
XL.Book.SheetIndexForName
Queries sheet index for sheet name.
All
5.4
XL.Book.Sheets
Queries list of sheet names.
All
5.4
XL.Book.Version
Queries version of XL library.
All
7.2
XL.Color.Pack
Packs red, green and blue components in color type.
All
3.5
XL.Color.UnPack
Unpacks color type to red, green and blue components.
All
3.5
XL.CopyCellValue
Copies one cell.
All
11.2
XL.CopyColumn
Copies cells from one column to another column.
All
10.5
XL.CopyContent
Copies all content from one book to other book.
All
5.1
XL.CopyRow
Copies cells from one row to another row.
All
6.5
XL.CopySheet
Copies a sheet to another book.
All
6.5
XL.Date.DoubleToTimeStamp
Converts a timestamp number to a timestamp value.
All
5.0
XL.Date.Pack
Packs date and time information into double type.
All
3.5
XL.Date.TimeStampToDouble
Converts a date to a numeric value for writing in a number cell.
All
5.0
XL.Date.UnPack
Unpacks date and time information from double type.
All
3.5
XL.Font.GetBold
Returns whether the font is bold.
All
3.5
XL.Font.GetColor
Returns the color of the font.
All
3.5
XL.Font.GetItalic
Returns whether the font is italic.
All
3.5
XL.Font.GetName
Returns the name of the font.
All
3.5
XL.Font.GetScript
Returns the script style of the font.
All
3.5
XL.Font.GetSize
Returns the size of the font in points.
All
3.5
XL.Font.GetStrikeOut
Returns whether the font is strikeout.
All
3.5
XL.Font.GetUnderline
Returns the underline style of the font.
All
3.5
XL.Font.SetBold
Turns on/off the bold font.
All
3.5
XL.Font.SetColor
Sets the color of the font.
All
3.5
XL.Font.SetItalic
Turns on/off the italic font.
All
3.5
XL.Font.SetName
Sets the name of the font.
All
3.5
XL.Font.SetScript
Sets the script style of the font.
All
3.5
XL.Font.SetSize
Sets the size of the font in points.
All
3.5
XL.Font.SetStrikeOut
Turns on/off the strikeout font.
All
3.5
XL.Font.SetUnderline
Sets the underline style of the font.
All
3.5
XL.FormControl.AddItem
Adds the item to a list box or drop-down form control.
All
13.1
XL.FormControl.AltText
Returns alternative text for the object.
All
13.1
XL.FormControl.ClearItems
Clears all items from a list box or drop-down form control.
All
13.1
XL.FormControl.DefaultSize
Returns whether the object is at its default size.
All
13.1
XL.FormControl.Disabled
Returns whether the object is allowed to run an attached macro.
All
13.1
XL.FormControl.GetChecked
Queries the check state.
All
13.1
XL.FormControl.GetDropLines
Returns the number of lines in the drop-down before scroll bars are added.
All
13.1
XL.FormControl.GetDx
Returns the width of the scroll bar in pixels.
All
13.1
XL.FormControl.GetFirstButton
Returns whether the object is the first button in a set of radio buttons.
All
13.1
XL.FormControl.GetFmlaGroup
Queries group name.
All
13.1
XL.FormControl.GetFmlaRange
Returns the cell reference with range of source data cells.
All
13.1
XL.FormControl.GetFmlaTxbx
Queries the source for the control.
All
13.1
XL.FormControl.GetFromAnchor
Returns the bottom right location of a control within a document.
All
13.1
XL.FormControl.GetHoriz
Returns whether the scroll bar is horizontal.
All
13.1
XL.FormControl.GetInc
Queries increment.
All
13.1
XL.FormControl.GetMax
Queries maximum value.
All
13.1
XL.FormControl.GetMin
Queries minimum value.
All
13.1
XL.FormControl.GetMultiSel
Returns the indices of selected items as a comma-delimited list.
All
13.1
XL.FormControl.GetSet
Queries the index of the selected item.
All
13.1
XL.FormControl.GetToAnchor
Returns the top left location of a control within a document.
All
13.1
XL.FormControl.InsertItem
Inserts the item to the specified position to a list box or drop-down form control.
All
13.1
XL.FormControl.Item
Returns the item by index from a list box or drop-down form control.
All
13.1
XL.FormControl.ItemCount
Returns the number of items in a list box or drop-down form control.
All
13.1
XL.FormControl.JSON   New in 14.0
Queries form controls as JSON.
All
14.0
XL.FormControl.LinkedCell
Returns the worksheet range linked to the control's value.
All
13.1
XL.FormControl.ListFillRange
Returns the range of source data cells used to populate the list box.
All
13.1
XL.FormControl.Locked
Returns whether the object is locked when the sheet is protected.
All
13.1
XL.FormControl.Macro
Returns the custom function associated with the object.
All
13.1
XL.FormControl.Name
Returns the name for this embedded control.
All
13.1
XL.FormControl.ObjectType
Returns the form control object type.
All
13.1
XL.FormControl.Print
Returns whether the object is printed when the document is printed.
All
13.1
XL.FormControl.SetChecked
Sets the check state.
All
13.1
XL.FormControl.SetDropLines
Sets the number of lines in the drop-down before scroll bars are added.
All
13.1
XL.FormControl.SetDx
Sets the width of the scroll bar in pixels.
All
13.1
XL.FormControl.SetFirstButton
Sets whether the object is the first button in a set of radio buttons.
All
13.1
XL.FormControl.SetFmlaGroup
Sets the cell reference in a group box is linked to.
All
13.1
XL.FormControl.SetFmlaRange
Sets the cell reference with range of source data cells.
All
13.1
XL.FormControl.SetFmlaTxbx
Sets the source.
All
13.1
XL.FormControl.SetHoriz
Sets whether the scroll bar is horizontal.
All
13.1
XL.FormControl.SetInc
Sets increment.
All
13.1
XL.FormControl.SetMax
Sets the maximum.
All
13.1
XL.FormControl.SetMin
Sets the minimum.
All
13.1
XL.FormControl.SetMultiSel
Sets the indices of selected items as a comma-delimited list.
All
13.1
XL.FormControl.SetSel
Sets the index of the selected item.
All
13.1
XL.Format.GetAlignH
Returns the horizontal alignment.
All
3.5
XL.Format.GetAlignV
Returns the vertical alignment.
All
3.5
XL.Format.GetBorderBottom
Returns the bottom border style.
All
3.5
XL.Format.GetBorderBottomColor
Returns the color of the bottom border.
All
3.5
XL.Format.GetBorderDiagonal
Returns the diagonal border.
All
3.5
XL.Format.GetBorderDiagonalColor
Returns the color of the diagonal border.
All
3.5
XL.Format.GetBorderDiagonalStyle
Gets the style for diagonal border.
All
3.5
XL.Format.GetBorderLeft
Returns the left border style.
All
3.5
XL.Format.GetBorderLeftColor
Returns the color of the left border.
All
3.5
XL.Format.GetBorderRight
Returns the right border style.
All
3.5
XL.Format.GetBorderRightColor
Returns the color of the right border.
All
3.5
XL.Format.GetBorderTop
Returns the top border style.
All
3.5
XL.Format.GetBorderTopColor
Returns the color of the top border.
All
3.5
XL.Format.GetFillPattern
Returns the fill pattern.
All
3.5
XL.Format.GetFont
Returns the font for this format.
All
3.5
XL.Format.GetHidden
Returns whether the hidden property is set to true.
All
3.5
XL.Format.GetIndent
Returns the text indentation level.
All
3.5
XL.Format.GetLocked
Returns whether the locked property is set to true.
All
3.5
XL.Format.GetNumFormat
Returns the number format identifier.
All
3.5
XL.Format.GetPatternBackgroundColor
Returns the background color of the fill pattern.
All
3.5
XL.Format.GetPatternForegroundColor
Returns the foreground color of the fill pattern.
All
3.5
XL.Format.GetRotation
Returns the text rotation.
All
3.5
XL.Format.GetShrinkToFit
Returns whether the cell is shrink-to-fit.
All
3.5
XL.Format.GetWrap
Returns whether the cell text is wrapped.
All
3.5
XL.Format.SetAlignH
Sets the horizontal alignment.
All
3.5
XL.Format.SetAlignV
Sets the vertical alignment.
All
3.5
XL.Format.SetBorder
Sets the border style.
All
3.5
XL.Format.SetBorderBottom
Sets the bottom border style.
All
3.5
XL.Format.SetBorderBottomColor
Sets the color of the bottom border.
All
3.5
XL.Format.SetBorderColor
Sets the border color.
All
3.5
XL.Format.SetBorderDiagonal
Sets the diagonal border.
All
3.5
XL.Format.SetBorderDiagonalColor
Sets the color of the diagonal border.
All
3.5
XL.Format.SetBorderDiagonalStyle
Sets the style for diagonal border.
All
3.5
XL.Format.SetBorderLeft
Sets the left border style.
All
3.5
XL.Format.SetBorderLeftColor
Sets the color of the left border.
All
3.5
XL.Format.SetBorderRight
Sets the right border style.
All
3.5
XL.Format.SetBorderRightColor
Sets the color of the right border.
All
3.5
XL.Format.SetBorderTop
Sets the top border style.
All
3.5
XL.Format.SetBorderTopColor
Sets the color of the top border.
All
3.5
XL.Format.SetFillPattern
Sets the fill pattern.
All
3.5
XL.Format.SetFont
Sets the font for the format.
All
3.5
XL.Format.SetHidden
Sets the hidden property.
All
3.5
XL.Format.SetIndent
Sets the text indentation level.
All
3.5
XL.Format.SetLocked
Sets the locked property.
All
3.5
XL.Format.SetNumFormat
Sets the number format identifier.
All
3.5
XL.Format.SetPatternBackgroundColor
Sets the background color of the fill pattern.
All
3.5
XL.Format.SetPatternForegroundColor
Sets the foreground color of the fill pattern.
All
3.5
XL.Format.SetRotation
Sets the text rotation.
All
3.5
XL.Format.SetShrinkToFit
Sets the flag whether the cell is shrink-to-fit.
All
3.5
XL.Format.SetWrap
Sets the flag whether the cell text is wrapped.
All
3.5
XL.Initialize
Initializes the XL library by loading it.
All
2.9
XL.IsInitialized
Checks if libXL library has been initialized.
All
4.2
XL.List
Lists all IDs of current XL books.
All
13.0
XL.LoadBook
Loads a Excel file.
All
2.9
XL.LoadBookPartially
Loads a Excel file partially.
All
8.0
XL.NewBook
Creates a new workbook in memory.
All
2.9
XL.Sheet.AddDataValidation
Adds a data validation for the specified range.
All
10.5
XL.Sheet.AddIgnoredError
Adds the ignored error for specified range.
All
7.2
XL.Sheet.AddSelectionRange
Adds a range to the selection.
All
13.1
XL.Sheet.AddrToRowCol
Converts a cell reference to row and column.
All
3.5
XL.Sheet.ApplyFilter
Applies the AutoFilter to the sheet.
All
7.2
XL.Sheet.AreCellsEmpty
Checks whether the cells in the given range are empty.
All
13.2
XL.Sheet.AutoFilter
Initializes the AutoFilter.
All
7.2
XL.Sheet.AutoFilter.AddFilter
Adds the filter value.
All
7.3
XL.Sheet.AutoFilter.AddSort
Adds the sorted column in AutoFilter by zero-based index and its sort order.
All
11.5
XL.Sheet.AutoFilter.Clear
Clear the filter criteria.
All
7.3
XL.Sheet.AutoFilter.ColumnSize
Returns the number of specified AutoFilter columns which have a filter information.
All
7.2
XL.Sheet.AutoFilter.Filter
Returns the filter value by index.
All
7.3
XL.Sheet.AutoFilter.FilterSize
Returns the number of filter values.
All
7.3
XL.Sheet.AutoFilter.FilterType
Returns the filter type of this AutoFilter column.
All
7.3
XL.Sheet.AutoFilter.GetCustomFilter
Gets the custom filter criteria.
All
7.3
XL.Sheet.AutoFilter.GetRef
Gets the cell range of AutoFilter with header.
All
7.2
XL.Sheet.AutoFilter.GetSort
Gets the zero-based index of sorted column in AutoFilter and its sort order.
All
7.2
XL.Sheet.AutoFilter.GetSortRange
Gets the whole range of data to sort.
All
7.2
XL.Sheet.AutoFilter.GetTop10
Gets the number of top or bottom items.
All
7.3
XL.Sheet.AutoFilter.SetCustomFilter
Sets the custom filter criteria.
All
7.3
XL.Sheet.AutoFilter.SetRef
Sets the cell range of AutoFilter with header.
All
7.2
XL.Sheet.AutoFilter.SetSort
Sets the sorted column in AutoFilter by zero-based index and its sort order.
All
7.2
XL.Sheet.AutoFilter.SetTop10
Sets the number of top or bottom items.
All
7.3
XL.Sheet.CellIsDate
Checks that cell contains a date or time value.
All
3.5
XL.Sheet.CellIsFormula
Checks that cell contains a formula.
All
3.5
XL.Sheet.CellIsStyledText
Queries whether cell has styled text.
All
10.2
XL.Sheet.CellReadBlank
Checks if cell is blank.
All
3.5
XL.Sheet.CellReadBoolean
Reads a boolean value from a cell.
All
3.5
XL.Sheet.CellReadBooleans
Reads all the boolean values in an area.
All
8.0
XL.Sheet.CellReadComment
Reads a comment value from a cell.
All
3.5
XL.Sheet.CellReadComments
Reads all the comments from cells in an area.
All
8.0
XL.Sheet.CellReadDate
Reads a number value from a cell.
All
5.0
XL.Sheet.CellReadDates
Reads all the dates from cells in an area.
All
8.0
XL.Sheet.CellReadFormula
Reads the formula value from a cell.
All
3.5
XL.Sheet.CellReadFormulas
Reads all the formulas from cells in an area.
All
8.0
XL.Sheet.CellReadNumber
Reads a number value from a cell.
All
3.5
XL.Sheet.CellReadNumbers
Reads all the numbers from cells in an area.
All
8.0
XL.Sheet.CellReadStyledText
Reads a styled text value from a cell.
All
10.2
XL.Sheet.CellReadText
Reads a text value from a cell.
All
3.5
XL.Sheet.CellReadTexts
Reads all the texts from cells in an area.
All
8.0
XL.Sheet.CellReadValue
Reads a value value from a cell.
All
10.5
XL.Sheet.CellReadValues
Reads all the values from cells in an area.
All
11.5
XL.Sheet.CellType
Queries type of cell.
All
3.5
XL.Sheet.CellWriteBlank
Writes a blank cell.
All
3.5
XL.Sheet.CellWriteBlanks
Writes blanks to an area of cells.
All
8.0
XL.Sheet.CellWriteBoolean
Writes a boolean value into cell.
All
3.5
XL.Sheet.CellWriteBooleans
Writes booleans to an area of cells.
All
8.0
XL.Sheet.CellWriteComment
Writes a comment to a cell.
All
3.5
XL.Sheet.CellWriteComments
Writes comments to an area of cells.
All
8.0
XL.Sheet.CellWriteDate
Writes a number into cell.
All
5.0
XL.Sheet.CellWriteDates
Writes dates to an area of cells.
All
8.0
XL.Sheet.CellWriteError
Writes error into the cell with specified format.
All
7.2
XL.Sheet.CellWriteFormula
Writes a formula into cell.
All
3.5
XL.Sheet.CellWriteFormulaBoolean
Writes a formula and value in a cell.
All
6.5
XL.Sheet.CellWriteFormulaNumber
Writes a formula and value in a cell.
All
6.5
XL.Sheet.CellWriteFormulaText
Writes a formula and value in a cell.
All
6.5
XL.Sheet.CellWriteFormulas
Writes formulas to an area of cells.
All
8.0
XL.Sheet.CellWriteMatrix
Writes cell values from matrix.
All
13.3
XL.Sheet.CellWriteNumber
Writes a number into cell.
All
3.5
XL.Sheet.CellWriteNumbers
Writes numbers to an area of cells.
All
8.0
XL.Sheet.CellWriteStyledText
Writes a styled text into a cell.
All
10.2
XL.Sheet.CellWriteText
Writes a string into cell.
All
3.5
XL.Sheet.CellWriteTextAsNumber
Writes a number into cell, but passes it as text.
All
10.3
XL.Sheet.CellWriteTexts
Writes texts to an area of cells.
All
8.0
XL.Sheet.Clear
Clears cells in specified area.
All
3.5
XL.Sheet.ClearPrintArea
Clears the print area.
All
3.5
XL.Sheet.ClearPrintRepeats
Clears repeated rows and columns on each page.
All
3.5
XL.Sheet.CopyCell
Copies cell with format from (rowSrc, colSrc) to (rowDst, colDst).
All
3.5
XL.Sheet.DefaultRowHeight
Returns the default row height measured in point size.
All
13.1
XL.Sheet.DelMergeByIndex
Removes merged cells by index.
All
4.3
XL.Sheet.DeleteMerge
Removes merged cells.
All
3.5
XL.Sheet.DeleteNamedRange
Deletes the named range by name.
All
3.5
XL.Sheet.FormControlCount
Queries number of form controls.
All
13.1
XL.Sheet.GetActiveCell
Gets an active cell of the sheet.
All
13.1
XL.Sheet.GetCellError
Reads error from cell.
All
3.5
XL.Sheet.GetCellErrors
Reads all the errors from cells in an area.
All
8.0
XL.Sheet.GetCellFormat
Returns cell's format.
All
3.5
XL.Sheet.GetCellFormats
Reads all the formats from cells in an area.
All
8.0
XL.Sheet.GetCellPicture
Queries picture for a cell.
All
11.5
XL.Sheet.GetColHidden
Returns whether column is hidden.
All
3.5
XL.Sheet.GetColWidth
Returns column width in points.
All
3.5
XL.Sheet.GetColWidthPixel
Returns column width in pixel.
All
10.2
XL.Sheet.GetDisplayGridlines
Returns whether the gridlines are displayed.
All
3.5
XL.Sheet.GetFirstCol
Returns the first column in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetFirstFilledCol
Returns the first column in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetFirstFilledRow
Returns the first row in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetFirstRow
Returns the first row in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetFooter
Returns the footer text of the sheet when printed.
All
3.5
XL.Sheet.GetFooterMargin
Returns the footer margin in inches.
All
3.5
XL.Sheet.GetGroupSummaryBelow
Returns whether grouping rows summary is below.
All
3.5
XL.Sheet.GetGroupSummaryRight
Returns whether grouping columns summary is right.
All
3.5
XL.Sheet.GetHCenter
Returns whether the sheet is centered horizontally when printed.
All
3.5
XL.Sheet.GetHeader
Returns the header text of the sheet when printed.
All
3.5
XL.Sheet.GetHeaderMargin
Returns the header margin in inches.
All
3.5
XL.Sheet.GetHidden
Returns whether sheet is hidden.
All
3.5
XL.Sheet.GetHorPageBreak
Returns row with horizontal page break at position index.
All
3.5
XL.Sheet.GetHorPageBreakCount
Returns a number of horizontal page breaks in the sheet.
All
3.5
XL.Sheet.GetLandscape
Returns a page orientation mode.
All
3.5
XL.Sheet.GetLastCol
Returns the zero-based index of the column after the last column in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetLastFilledCol
Returns the zero-based index of the column after the last column in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetLastFilledRow
Returns the zero-based index of the row after the last row in the sheet that contains a filled cell.
All
10.3
XL.Sheet.GetLastRow
Returns the zero-based index of the row after the last row in the sheet that contains a used cell.
All
3.5
XL.Sheet.GetMarginBottom
Returns the bottom margin of the sheet in inches.
All
3.5
XL.Sheet.GetMarginLeft
Returns the left margin of the sheet in inches.
All
3.5
XL.Sheet.GetMarginRight
Returns the right margin of the sheet in inches.
All
3.5
XL.Sheet.GetMarginTop
Returns the top margin of the sheet in inches.
All
3.5
XL.Sheet.GetMerge
Gets merged cells for cell at row, col.
All
3.5
XL.Sheet.GetName
Returns the name of the sheet.
All
3.5
XL.Sheet.GetNamedRange
Gets the named range coordianates by name.
All
3.5
XL.Sheet.GetPaper
Returns the paper size.
All
3.5
XL.Sheet.GetPicture
Returns a workbook picture index at position index in worksheet.
All
3.5
XL.Sheet.GetPrintArea
Gets the print area.
All
5.1
XL.Sheet.GetPrintFit
Returns whether fit to page option is enabled.
All
3.5
XL.Sheet.GetPrintGridlines
Returns whether the gridlines are printed.
All
3.5
XL.Sheet.GetPrintRepeatCols
Gets repeated columns on each page from colFirst to colLast.
All
5.1
XL.Sheet.GetPrintRepeatRows
Gets repeated rows on each page from rowFirst to rowLast.
All
5.1
XL.Sheet.GetPrintRow
Returns whether the row and column headers are printed.
All
3.5
XL.Sheet.GetPrintZoom
Returns the scaling factor for printing as a percentage.
All
3.5
XL.Sheet.GetProtect
Returns whether sheet is protected.
All
3.5
XL.Sheet.GetRowHeight
Returns row height in points.
All
3.5
XL.Sheet.GetRowHeightPixel
Returns row height in pixels.
All
10.2
XL.Sheet.GetRowHidden
Returns whether row is hidden.
All
3.5
XL.Sheet.GetTabColor
Queries the sheet's tab color.
All
13.1
XL.Sheet.GetTabColorRGB
Queries the sheet's tab RGB color.
All
13.1
XL.Sheet.GetText
Queries the text of a sheet in a workbook.
All
3.5
XL.Sheet.GetTopLeftView
Extracts the first visible row and the leftmost visible column of the sheet.
All
3.5
XL.Sheet.GetVCenter
Returns whether the sheet is centered vertically when printed.
All
3.5
XL.Sheet.GetVerPageBreak
Returns column with vertical page break at position index.
All
3.5
XL.Sheet.GetVerPageBreakCount
Returns a number of vertical page breaks in the sheet.
All
3.5
XL.Sheet.GetZoom
Returns the zoom level of the current view as a percentage.
All
3.5
XL.Sheet.GroupCols
Groups columns from colFirst to colLast.
All
3.5
XL.Sheet.GroupRows
Groups rows from rowFirst to rowLast.
All
3.5
XL.Sheet.HyperlinkIndex
Checks if the cell contains a hyperlink.
All
13.2
XL.Sheet.HyperlinkSize
Returns the number of hyperlinks in the sheet.
All
4.3
XL.Sheet.InsertCol
Inserts columns from colFirst to colLast.
All
3.5
XL.Sheet.InsertRow
Inserts rows from rowFirst to rowLast.
All
3.5
XL.Sheet.IsAutoFilter
Whether this sheet has an auto filter.
All
11.5
XL.Sheet.Merge
Gets the merged cells by index.
All
4.3
XL.Sheet.MergeSize
Returns a number of merged cells in this worksheet.
All
4.3
XL.Sheet.NamedRange
Gets the named range coordinates by index.
All
3.5
XL.Sheet.NamedRangeCount
Returns the number of named ranges in the sheet.
All
3.5
XL.Sheet.PictureCount
Returns a number of pictures in this worksheet.
All
3.5
XL.Sheet.ReadCellsAsMatrix
Reads all the values from cells in an area into a new matrix.
All
13.0
XL.Sheet.RemoveCol
Removes columns from colFirst to colLast.
All
3.5
XL.Sheet.RemoveComment
Removes a comment from a cell.
All
6.5
XL.Sheet.RemoveComments
Removes comments in given area.
All
8.0
XL.Sheet.RemoveDataValidations
Removes all data validations for the sheet.
All
10.5
XL.Sheet.RemoveFilter
Removes the AutoFilter from the sheet.
All
7.2
XL.Sheet.RemovePicture
Removes a picture from a cell.
All
10.2
XL.Sheet.RemovePictureByIndex
Removes a picture by index.
All
10.2
XL.Sheet.RemoveRow
Removes rows from rowFirst to rowLast.
All
3.5
XL.Sheet.RemoveSelection
Removes all selection.
All
13.1
XL.Sheet.RightToLeft
Returns whether the text is displayed in right-to-left mode.
All
7.2
XL.Sheet.RowColToAddr
Converts row and column to a cell reference.
All
3.5
XL.Sheet.SelectionRange
Returns a range of the selection.
All
13.1
XL.Sheet.SetActiveCell
Sets an active cell of the sheet.
All
13.1
XL.Sheet.SetAutoFitArea
Sets the borders for autofit column widths feature.
All
5.1
XL.Sheet.SetCellFormat
Sets cell's format.
All
3.5
XL.Sheet.SetCellFormats
Set cell formats in given area.
All
8.0
XL.Sheet.SetCol
Sets column width and format for all columns from colFirst to colLast.
All
3.5
XL.Sheet.SetColHidden
Hides or shows a column.
All
3.5
XL.Sheet.SetColPx
Sets column width in pixels and format for all columns from colFirst to colLast.
All
13.3
XL.Sheet.SetColumn
Sets column width and format for all columns from colFirst to colLast.
All
3.5
XL.Sheet.SetDefaultRowHeight
Sets the default row height measured in point size.
All
13.1
XL.Sheet.SetDisplayGridlines
Sets gridlines for displaying.
All
3.5
XL.Sheet.SetFooter
Sets the footer text for the sheet when printed.
All
3.5
XL.Sheet.SetGroupSummaryBelow
Sets a flag of grouping rows summary.
All
3.5
XL.Sheet.SetGroupSummaryRight
Sets a flag of grouping rows summary.
All
3.5
XL.Sheet.SetHCenter
Sets a flag that the sheet is centered horizontally when printed.
All
3.5
XL.Sheet.SetHeader
Sets the header text of the sheet when printed.
All
3.5
XL.Sheet.SetHidden
Hides/unhides the sheet. Returns false if error occurs.
All
13.4
XL.Sheet.SetHorPageBreak
Sets/removes a horizontal page break.
All
3.5
XL.Sheet.SetLandscape
Sets landscape or portrait mode for printing.
All
3.5
XL.Sheet.SetMarginBottom
Sets the bottom margin of the sheet in inches.
All
3.5
XL.Sheet.SetMarginLeft
Sets the left margin of the sheet in inches.
All
3.5
XL.Sheet.SetMarginRight
Sets the right margin of the sheet in inches.
All
3.5
XL.Sheet.SetMarginTop
Sets the top margin of the sheet in inches.
All
3.5
XL.Sheet.SetMerge
Sets merged cells for range: rowFirst - rowLast, colFirst - colLast.
All
3.5
XL.Sheet.SetName
Sets the name of the sheet.
All
3.5
XL.Sheet.SetNamedRange
Sets the named range.
All
3.5
XL.Sheet.SetPaper
Sets the paper size.
All
3.5
XL.Sheet.SetPictureWithScale
Sets a picture with pictureId identifier at position row and col with scale factor and offsets in pixels.
All
3.5
XL.Sheet.SetPictureWithSize
Sets a picture with pictureId identifier at position row and col with custom size and offsets in pixels.
All
3.5
XL.Sheet.SetPrintArea
Sets the print area.
All
3.5
XL.Sheet.SetPrintFit
Fits sheet width and sheet height to wPages and hPages respectively.
All
3.5
XL.Sheet.SetPrintGridliens
Sets gridlines for printing.
All
3.5
XL.Sheet.SetPrintRepeatCols
Sets repeated columns on each page from colFirst to colLast.
All
3.5
XL.Sheet.SetPrintRepeatRows
Sets repeated rows on each page from rowFirst to rowLast.
All
3.5
XL.Sheet.SetPrintRow
Sets a flag that the row and column headers are printed.
All
3.5
XL.Sheet.SetPrintZoom
Sets the scaling factor for printing as a percentage.
All
3.5
XL.Sheet.SetProtect
Protects/unprotects the sheet.
All
3.5
XL.Sheet.SetProtectEx
Protects/unprotects the sheet with password and enhanced parameters below.
All
7.2
XL.Sheet.SetRightToLeft
Sets the right-to-left mode:
Pass 1 and the text is displayed in right-to-left mode,
Pass 0 and the text is displayed in left-to-right mode.
All
7.2
XL.Sheet.SetRow
Sets row height and format.
All
3.5
XL.Sheet.SetRowHidden
Hides or shows a row.
All
3.5
XL.Sheet.SetRowPx
Sets column width in pixels and format for all columns from colFirst to colLast.
All
13.3
XL.Sheet.SetRows
Sets row height and format for multiple rows.
All
11.2
XL.Sheet.SetTabColor
Sets the color for the sheet's tab.
All
7.2
XL.Sheet.SetTabColorRGB
Sets the RGB color for the sheet's tab.
All
7.2
XL.Sheet.SetTopLeftView
Sets the first visible row and the leftmost visible column of the sheet.
All
3.5
XL.Sheet.SetVCenter
ets a flag that the sheet is centered vertically when printed.
All
3.5
XL.Sheet.SetVerPageBreak
Sets/removes a vertical page break.
All
3.5
XL.Sheet.SetZoom
Sets the zoom level of the current view.
All
3.5
XL.Sheet.Split
Splits a sheet at position (row, col).
All
3.5
XL.Sheet.SplitInfo
Gets the split information (position of frozen pane) in the sheet.
All
4.3
XL.Sheet.Table
Gets the table parameters by index.
All
7.2
XL.Sheet.TableSize
Returns the number of tables in the sheet.
All
7.2
XL.Sheet.Type
Returns type of sheet with specified index.
All
7.2
XL.Uninitialize
Uninitializes XL library.
All
10.1
XML.ApplyStylesheet
Apply the stylesheet to the document (XSLT transform).
All
8.4
XML.ApplyStylesheet2
Apply the stylesheet to the document (XSLT transform).
All
11.5
XML.Canonical
Creates canonical xml.
All
6.2
XML.ClearVariables
Clears the variables.
All
7.0
XML.Colorize
Formats a XML string with color.
All
8.2
XML.Compact
Compacts XML document.
All
10.2
XML.DeletePath
Delete a xml node.
All
7.4
XML.ExtractText
Extracts the text from the XML tree.
All
7.0
XML.Format
Formats XML document.
All
6.2
XML.GetAttribute
Queries text of an attribute.
All
7.0
XML.GetPathValue
Queries value in XML.
All
7.4
XML.GetSaveNoEmptyTags
Queries whether to include close tags for empty nodes.
All
12.4
XML.HasAttribute
Queries whether an attribute exists.
All
7.0
XML.Import
Imports XML and creates tables, fields and records.
All
5.3
XML.Import.Cancel
Cancels current import.
All
5.3
XML.Import.ErrorCount
Queries error counter.
All
9.3
XML.Import.Errors
Queries list of error messages.
All
9.3
XML.Import.GetExtraFieldDefinitions
Queries the extra field definitions.
All
13.5
XML.Import.SetBaseFields
Sets the names of the base fields per record.
All
7.1
XML.Import.SetExtraField
Sets the extra field to add to all tables.
All
7.1
XML.Import.SetExtraFieldDefinitions
Sets the extra field definitions.
All
13.5
XML.Import.Status
Queries status of xml import.
All
5.3
XML.Import.Todo
Queries how many items are to be done for XML import.
All
5.3
XML.Import.Total
Queries total items to be imported.
All
5.3
XML.Import.Work
Performs import.
All
5.4
XML.InsertRecords
Imports records from XML file.
All
13.4
XML.ItemRefs
Queries entries from XML nodes.
All
11.5
XML.List
Lists all IDs of current XML objects.
All
12.5
XML.ListAttributes
Lists attribute names.
All
7.0
XML.NodeCount
Counts nodes with given name.
All
7.0
XML.NodeNames
Queries list of node names in an XML.
All
7.0
XML.Parse
Parses a XML document.
All
7.3
XML.Query
Performs an XPath query.
All
3.0
XML.ReadContainer
Reads container content as XML.
All
7.4
XML.ReadFile
Reads a file as XML.
All
7.4
XML.Release
Releases an XML object.
All
7.3
XML.ReleaseAll
Releases all XML objects.
All
7.3
XML.SetPathCData
Sets path value with CData.
All
11.1
XML.SetPathValue
Sets a xml node.
All
7.4
XML.SetPathXML
Sets path value with XML sub tree.
All
8.1
XML.SetSaveNoEmptyTags
Sets whether to include close tags for empty nodes.
All
12.4
XML.SetVariables
Creates local variables in script for XML nodes.
All
7.0
XML.SubTree
Extracts a given subtree.
All
7.0
XML.ToHTML   New in 14.0
Converts XML to HTML.
All
14.0
XML.ToJSON
Converts XML to JSON.
All
8.2
XML.Validate
Validates XML against schema.
All
8.1
XML.ValidateFile
Validates XML against schema.
All
8.2
ZipFile.CRCFile
Calculates CRC of a file.
All
4.3
ZipFile.Close
Closes the zip archive.
All
3.4
ZipFile.SetCompressionLevel
Sets the compression level.
All
3.4
ZipFile.UsePassword
Sets the password to use for compressing.
All
5.1
ZipFile.WriteContainer
Writes a file to the zip archive with content from a container.
All
3.4
ZipFile.WriteFile
Reads a file and writes it to the zip archive.
All
3.4
ZipFile.WriteHex
Writes data into the zip archive.
All
3.4
ZipFile.WriteText
Writes a text into the zip archive.
All
3.4

4124 functions shown.

These functions require a license (68%).