Skip to content

ImportImageFile.md

Latest commit

 

History

History
59 lines (46 loc) · 1.3 KB

ImportImageFile.md

File metadata and controls

59 lines (46 loc) · 1.3 KB
Raw

ImportImageFile

Description

Import the specified image file as an Image object in Vectorworks.

FUNCTION ImportImageFile(
				filePath : DYNARRAY[] of CHAR;
				importPt : POINT): HANDLE;
def vs.ImportImageFile(filePath, importPt):
    return HANDLE

Parameters

Name Type Description
filePath DYNARRAY[] of CHAR Full path to the image file.
importPt POINT Location on which the file should be imported. You can pass X, Y REAL coordinates here instead of POINT.

Remarks

This function returns NIL in Vectorworks 2014.

A typical call to this function would be:

hImage = vs.ImportImageFile( imagePath, importPt )

In Vectorworks 2014, if you need the result, the call should be:

vs.ImportImageFile( imagePath, importPt )
hImage = vs.FSActLayer()

Examples

[[Python Sample Import Images as Symbols]] for example.

resultH := ImportImageFile(filePath, 1);
import vs

# Import the specified image file as an Image object in Vectorworks.
filePath = 'C:/Temp'
importPt = (0, 0)

objHandle = vs.ImportImageFile(filePath, importPt)
if objHandle is not None:
    vs.Message('Created object handle: ' + str(objHandle))

Version

Availability: from Vectorworks 2014

Category