Eplan Platform API
Eplan.EplApi.DataModel.Graphics Namespace / Image Class / SetFile Method
Full image file name.
Boolean value. If set to true, the image will be copied into the project directory.
Boolean value. If set to true, an already existing image with the same name will be overwritten

In This Topic
    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
    public bool SetFile( 
   string fileName,
   bool copyToProject,
   bool overWrite
)
    public:
bool SetFile( 
   String^ fileName,
   bool copyToProject,
   bool overWrite
)

    Parameters

    Parameter NameDescription
    fileNameFull image file name.
    copyToProjectBoolean value. If set to true, the image will be copied into the project directory.
    overWriteBoolean 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
    ExceptionDescription
    Eplan.EplApi.Base.BaseExceptionThrown when the file cannot be set.
    System.ArgumentNullExceptionThrown when fileName is null.
    See Also

    Reference

    Image Class
    Image Members

     

     

    Eplan API, 05.05.2026, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support