Eplan Platform API
Eplan.EplApi.DataModel Namespace / Page Class

In This Topic
    Page Class Properties
    In This Topic

    For a list of all members of this type, see Page members.

    Public Properties
     NameDescription
    Public PropertyAll Placements including Groups placed on this page. They are not filtered. All returned Placements are placed directly on this page. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding).  
    Public PropertyAll Eplan.EplApi.DataModel.Graphics.GraphicalPlacements placed on this page. They are not filtered. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding).  
    Public PropertyAll Placements, placed on this page. Groups are ungrouped and contained Placements are returned. They are not filtered. This method does not return embedded objects (like for example Eplan.EplApi.DataModel.Graphics.Shielding). This method does not return Eplan.EplApi.DataModel.Graphics.PropertyPlacement.  
    Public PropertyReturns all BoxedDevices placed on the page. If the filter was set up, returns BoxedDevices matching the filter.  
    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 PropertyPage's property that allows to access current page's filter. It affects properties "Functions", "Terminals", "TerminalStrips", "Plugs", "PlugStrips" and "PLCs".  
    Public PropertyReturns all Functions placed on the page. If the filter was set up, returns Functions matching the filter.  
    Public PropertyGets/sets the size of the page's grid.  
    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 identifying name of the page.  
    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 if the page is a logical page.  
    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 Page and it was not assigned a Project,

    it is a Placement or any class derived from it and was not assigned a 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 PropertyPage's property describing type of macro. This type is used to find a suitable variant of macro, which can be insert on this page. While inserting macro on page, inserting variant of macro is get from page's MacroRepresentationType and variant of macro defined by user. This property depends on property PageType.  
    Public PropertyGet or set name of the page. When setting this property, it is not checked whether the given name already exists in project.  
    Public PropertyGets/Sets the name of a page.  
    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 PropertyGets/sets a page's property describing type of document  
    Public PropertyReturns name of the page's type.  
    Public PropertyGet or set planning objects to which this page is assigned or null.  
    Public PropertyReturns all Eplan.EplApi.DataModel.EObjects.PLCs placed on the page. If the filter was set up, returns BoxedDevices matching the filter.  
    Public PropertyReturns the page PlotFrame.  
    Public PropertyReturns all Eplan.EplApi.DataModel.EObjects.PlugStrips placed on the page. If the filter was set up, returns Eplan.EplApi.DataModel.EObjects.PlugStrips matching the filter.  
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyProperty enabling access to internal properties of the Page object.  
    Public PropertyReportBlock which contains data describing report from this page.  
    Public PropertyReturns the exact size of the page, takes into account page scale. The size is calculated from center of border lines.  
    Public PropertyReturns all grouped Placements. (Inherited from Eplan.EplApi.DataModel.Group)
    Public PropertyReturns all Eplan.EplApi.DataModel.EObjects.TerminalStrips placed on the page. If the filter was set up, returns Eplan.EplApi.DataModel.EObjects.TerminalStrips matching the filter.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyCheck if object is currently write protected or sets Manual write protection  
    Top
    See Also