ImportImage Method (Drawing2D)

In This Topic

Import and place image from file.

Syntax

public I2DImage ImportImage( 
   string fileName,
   Transform2DProperty<LengthProperty> position,
   LengthProperty width
)

Parameters

fileName: Path to the image file.
position: Position of the top left corner of placed image.
width: Width of the placed image.

Return Value

Placed image occurrence.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ArgumentNullException	Argument is null.
EPLAN.Harness.API.Exceptions.ArgumentException	Argument is invalid. The exception is thrown when a wrong argument is passed to the method or the setter of property.
EPLAN.Harness.API.Exceptions.FileNotFoundException	This file was not found.
EPLAN.Harness.API.Exceptions.FileExtensionException	The exception that is thrown when the file has the wrong extension.
EPLAN.Harness.API.Exceptions.FileClosedException	This file is not opened.
EPLAN.Harness.API.Exceptions.FileOpenedAsReadOnlyException	You can not perform this action on a document opened as read only.
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from EPLAN.Harness.API.HpdApi.Status property. If API is uninitialized, you can initialize it by calling EPLAN.Harness.API.HpdApi.Init method. If API is in failed state, you can not resurrect it.
EPLAN.Harness.API.Exceptions.ObjectInvalidException	The object is in invalid state. Obtain a new one.
EPLAN.Harness.API.Exceptions.OperationFailedException	The operation was not successful.

Remarks

Height is calculated from width - placed image occurrence respects aspect ratio of the source image. This can be changed later by moving individual corners.

Reference

Drawing2D Class
Drawing2D Members

Send Feedback