SetFile Method

In This Topic

Sets the reference to bitmap file. If the image file is not yet located in the project folder, it will be copied there, if the second parameter is set to true.

Syntax

C#
C++/CLI

public bool SetFile( 
   string fileName,
   bool copyToProject,
   bool overWrite
)

public:
bool SetFile( 
   String^ fileName,
   bool copyToProject,
   bool overWrite
)

Parameters

fileName: Full image file name.
copyToProject: Boolean value. If set to true, the image will be copied into the project directory.
overWrite: Boolean value. If set to true, an already existing image with the same name will be overwritten

Return Value

true: if the image was successfully copied.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when the file cannot be set.
System.ArgumentNullException	Thrown when `fileName` is `null`.

Reference

Image Class
Image Members

Send Feedback