LoadPattern
LoadPattern loads an image pattern from file. Returns a Boolean. The return value is 'True' if the image file is loaded successfully, else the value is 'False'.
Syntax
object.LoadPattern( FileName, FileFormat, Options )
Parameter |
Type |
Required/ Optional |
Default |
Description |
FileName |
String |
Required |
|
This provides the directory path and file name of the bitmap file. |
FileFormat |
String |
Optional |
"" |
see Remarks |
Options |
String |
Optional |
"" |
This specifies the import options. |
Remarks
The FileFormat string must be a three letter, lower-case image file extension, as seen in the Import dialog. This option is specified when there is no three letter extension in the image file name and the format cannot otherwise be identified by Surfer.
The Options string is any import options that must be specified for file types that require them.
Example
The following example demonstrates how to load a bitmap file as a fill pattern.
FillFormat.LoadPattern(FileName:=SurferApp.Path+"\Samples\Demogrid.tif",FileFormat:="",Options:="")
Used by: FillFormat object