API Help
Eplan.EplApi.DataModel.Graphics Namespace / Image Class
Properties Methods

In This Topic
    Image Class Members
    In This Topic

    The following tables list the members exposed by Image.

    Public Constructors
     NameDescription
    Public ConstructorConstructor. When object created with this constructor, its create method must be call.  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns angle. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public PropertyReturns radius of Rectangle's corners chamfers. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public PropertyReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertySets display sequence. The drawing order flag will be used to sort elements according to drawing order within a group. If elements chare the same value the drawing order will result from order of the data model. Default value is 67. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyFull file name of the image file.  
    Public PropertyOverridden. Gets or sets the fill pattern. Pattern types Bitmap, Eplan and System are not supported.  
    Public PropertyReturns a group that the Placement object belongs to. If the Placement object doesn't belong to any group, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyReturns if the rectangle has chamfers. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public PropertyReturns height of the rectangle. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyOverridden. This property specifies if the rectangle is filled.  
    Public Property

    Determines if the the StorableObject is transient.

    The StorableObject is transient when it was created by default constructor and:

    it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project,

    it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets the actual visibility state of the object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyGets or sets object's graphical layer. If object is not assigned to a project (Project is null), null is returned (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyGets layer id of layer assigned to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyGet or set the placement's location. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public PropertyReturns lower left corner's coordinates. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the page the Placement is on, or assigns a Page object to the placement. If the placement was previously assigned to another page, it is removed from old one and assigned to the page given as an argument. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertySets Pen related to this object. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public PropertyReturns size of the bitmap in points.  
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to P8 properties of the Image object.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns upper right corner's coordinates. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public PropertyReturns width of the rectangle. (Inherited from Eplan.EplApi.DataModel.Graphics.Rectangle)
    Public PropertyBoolean value: true if the aspect ratio of the image is the same as in the original image file.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Copy Placement and insert the Copy into destination group. Copied placement will be inserted into desired project of destination group. If this placement is temporary, the copy will be persistent, if the destination group is also persistent. Group or Page, where the placement will be inserted. Defines whether a layer should be matched by name. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodOverloaded. Creates the Image object.  
    Public MethodOverridden. Creates transient and not placed Image object.  
    Public MethodDestructor (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodPlacement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns size of the bitmap in pixels.  
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodRemoves placement. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodOverloaded. Scales the placement (or group of placements) by the specified factors in X and Y axis with scaling origin point specified by the ptOrigin parameter X axis factor. E.g. value of 2 makes the width two times bigger.Y axis factor. E.g. value of 0.5 makes the height two times smaller.Scaling origin point. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public MethodOverridden. Sets the size of a rectangle using the coordinates of the two opposite corners  
    Public MethodSets the size of an image by setting the coordinates of the lower left corner and the height. By this means the the aspect ratio is kept always the same as in the original image. The width results of the aspect ratio.  
    Public MethodSets the size of an image by setting the coordinates of the lower left corner and the width. By this means the the aspect ratio is kept always the same as in the original image. The height results of the aspect ratio.  
    Public MethodSets 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.  
    Public MethodThis method sets the visibility of the graphical instance to depend on the layer setting (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacement)
    Public MethodTries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also