API Help
Eplan.EplApi.DataModel Namespace / Page Class
Members Example

In This Topic
    Page Class
    In This Topic
    Page class represents an EPLAN project's page.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.Placement
             Eplan.EplApi.DataModel.Group
                Eplan.EplApi.DataModel.DocumentBase
                   Eplan.EplApi.DataModel.Page

    Syntax
    public class Page : DocumentBase, IWriteProtection  
    public ref class Page : public DocumentBase, IWriteProtection
    Remarks
    Some properties of the class are not linked with their owners even if from the syntax it may seem otherwise. This concerns NameParts property and array properties like : AllFirstLevelPlacements, AllGraphicalPlacements, AllPlacements, Functions, PLCs, PlugStrips, TerminalStrips.
    Example
    The following example shows how to use class Page. 
    PagePropertyList oPPL = new PagePropertyList();
oPPL.DESIGNATION_LOCATION = "A";
oPPL.DESIGNATION_PLANT = "O";
Page oPage = new Page(m_oTestProject, DocumentTypeManager.DocumentType.Circuit, oPPL);
    Public Constructors
     NameDescription
    Public ConstructorPage ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAllFirstLevelPlacementsAll 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 PropertyAllGraphicalPlacementsAll 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 PropertyAllPlacementsAll 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 PropertyBoxedDevicesReturns all BoxedDevices placed on the page. If the filter was set up, returns BoxedDevices matching the filter.  
    Public PropertyCrossReferencedObjectsAllReturns 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 PropertyDatabaseIdentifierReturns 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 PropertyDrawingOrderSets 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 PropertyFilterPage's property that allows to access current page's filter. It affects properties "Functions", "Terminals", "TerminalStrips", "Plugs", "PlugStrips" and "PLCs".  
    Public PropertyFunctionsReturns all Functions placed on the page. If the filter was set up, returns Functions matching the filter.  
    Public PropertyGridSizeGets/sets the size of the page's grid.  
    Public PropertyGroupReturns 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 PropertyIdentifyingNameReturns identifying name of the page.  
    Public PropertyIsLocked

    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 PropertyIsLogicalPageReturns if the page is a logical page.  
    Public PropertyIsPlacedReturns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyIsReadOnlyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsSetAsVisibleGets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyIsTransient

    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 PropertyIsValidDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyLocationGet or set the placement's location. (Inherited from Eplan.EplApi.DataModel.DocumentBase)
    Public PropertyMacroRepresentationTypePage'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 PropertyNameGet or set name of the page. When setting this property, it is not checked whether the given name already exists in project.  
    Public PropertyNamePartsGets/Sets the name of a page.  
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPageReturns 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 PropertyPageTypeGets/sets a page's property describing type of document  
    Public PropertyPageTypeNameReturns name of the page's type.  
    Public PropertyPlanningSegmentGet or set planning objects to which this page is assigned or null.  
    Public PropertyPLCsReturns all Eplan.EplApi.DataModel.EObjects.PLCs placed on the page. If the filter was set up, returns BoxedDevices matching the filter.  
    Public PropertyPlotFrameReturns the page PlotFrame.  
    Public PropertyPlugStripsReturns 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 PropertyProjectReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPropertiesProperty enabling access to internal properties of the Page object.  
    Public PropertyReportBlockReportBlock which contains data describing report from this page.  
    Public PropertySizeReturns the exact size of the page, takes into account page scale. The size is calculated from center of border lines.  
    Public PropertySubPlacementsReturns all grouped Placements. (Inherited from Eplan.EplApi.DataModel.Group)
    Public PropertyTerminalStripsReturns 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 PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyWriteProtectedCheck if object is currently write protected or sets Manual write protection  
    Top
    Public Methods
     NameDescription
    Public MethodConvertToGraphicsConverts all symbols and connections on the page into graphical instances. Graphical instances of a given symbol are automatically grouped.  
    Public MethodCopyToOverloaded. Creates copy of this page.  
    Public MethodCreateOverloaded. Creates a new Page object. It is placed in the project under location given as parameters.  
    Public MethodDeepUnGroupOverloaded. Remove all Placements only from a group and it's sub groups. If true method will remove also SubGroups. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodDispose()Destructor. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodEqualsOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetBoundingBoxOverridden. Placement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size.  
    Public MethodGetHashCodeServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetTypeNameReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetWriteProtectionFlagSetChecks if a specific write protection kind was set.  
    Public MethodInsertSubPlacementInsert Placement to a group. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodInsertSubPlacementsInsert Placements to a group. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodIsEditableCheck if the Group is editable. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodIsGroupValidReturns true, if group is valid if not, the group should be dissolved (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodLockObjectTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodMoveMove all Placements in a group by a Eplan.EplApi.Base.PointD given as param. (Inherited from Eplan.EplApi.DataModel.Group)
    Public MethodPauseWriteProtectionTemporarily disables write protection. Note that current write protection  
    Public MethodRemoveOverridden. Removes placement.  
    Public MethodRemoveSubPlacementOverloaded. Remove 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 MethodRemoveSubPlacementsOverloaded. Remove 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 MethodScaleOverloaded. 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 MethodSetNameSets the name of the page. Name parts should be given in the PagePropertyList.  
    Public MethodSetProjectAssigns a page to a given project.  
    Public MethodSmartLockTries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodToStringIdentifierReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodUnGroupOverloaded. Remove Placements only from a group. (Inherited from Eplan.EplApi.DataModel.Group)
    Top
    See Also

    Reference

    Page Members
    Eplan.EplApi.DataModel Namespace

     

     

    EPLAN API , 21.05.2020, © by EPLAN Software and Service GmbH and Co. KG. All rights reserved.

    Send Feedback