Eplan Platform API
Eplan.EplApi.DataModel.MasterData Namespace / PlotFrame Class

In This Topic
    PlotFrame Class
    In This Topic
    Inheritance Hierarchy


    public class PlotFrame : Eplan.EplApi.DataModel.DocumentBase 
    public ref class PlotFrame : public Eplan.EplApi.DataModel.DocumentBase 
    Public Constructors
    Public ConstructorDefault constructor.  
    Public Properties
    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 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 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 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 PropertyGet or set the placement's location. (Inherited from Eplan.EplApi.DataModel.DocumentBase)
    Public PropertyGet the name of the plot frame.  
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyOverridden. Returns 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.  
    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 PlotFrame object.  
    Public PropertyReturns the exact size of the page's plot frame. The size is calculated from center of border lines.  
    Public PropertyOverridden. Returns all grouped Eplan.EplApi.DataModel.Placements.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Methods
    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 MethodCreates a new Group object. It is placed on the page of first placement given as parameter. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodOverloaded. Remove all Eplan.EplApi.DataModel.Placements only from a group and it's sub groups. If true method will remove also SubGroups. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodDestructor for deterministic finalization of PlotFrame object. (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.Group)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodInsert Eplan.EplApi.DataModel.Placement to a group. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodInsert Eplan.EplApi.DataModel.Placements to a group. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodCheck if the Group is editable. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodReturns true, if group is valid if not, the group should be dissolved (Inherited from Eplan.EplApi.DataModel.Group)
    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 MethodMoves the group (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodRemoves placement. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodOverloaded. Remove Eplan.EplApi.DataModel.Placement from the group and from the project. The Placement object passed into this method is no longer valid. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodOverloaded. Remove Eplan.EplApi.DataModel.Placements from the group and from the project. The Placement objects passed into this method are no longer valid. (Inherited from Eplan.EplApi.DataModel.Group)
    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 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)
    Public MethodOverloaded. Remove Eplan.EplApi.DataModel.Placements only from a group. (Inherited from Eplan.EplApi.DataModel.Group)
    See Also