Create(Project,DocumentType,PagePropertyList) Method

In This Topic

Creates a new Page object. It is placed in the project under location given as parameters.

Syntax

C#
C++/CLI

public void Create( 
   Project pProject,
   DocumentTypeManager.DocumentType nType,
   PagePropertyList pNameParts
)

public:
void Create( 
   Project^ pProject,
   DocumentTypeManager.DocumentType nType,
   PagePropertyList^ pNameParts
)

Parameters

pProject: Project the page is assigned to.
nType: Type of the page
pNameParts: Parts of name of the page, that determine its location in the project structure.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when valid page cannot be created.
System.ArgumentNullException	Thrown when pProject or pNameParts is null.
NameConflictException	Thrown when page with `pNameParts` name already exists in `pProject` .
InvalidPageNameException_IncorrectParts	Thrown when entries in `pNameParts` contain invalid tag values.
ObjectAlreadyCreatedException	Thrown when the Page has already been created.

Remarks

To know DeviceTag syntax please see chapter 'Dialog Settings: DT syntax check' in Eplan documentation. The name passed in the pNameParts parameter is validated whether it is correct and not yet existing in the project. Also if PAGE_COUNTER property is not specified, it is set to a default value automatically. Property list pNameParts should contain only name properties, for example : · DESIGNATION_PLANT · DESIGNATION_SUBPLANT1 · DESIGNATION_SUBPLANT2 · DESIGNATION_SUBPLANT3 · DESIGNATION_LOCATION · DESIGNATION_SUBLOCATION1 · DESIGNATION_SUBLOCATION2 · DESIGNATION_SUBLOCATION3 · DESIGNATION_SUBLOCATION4 · DESIGNATION_SUBLOCATION5 · PAGE_COUNTER · PAGE_SUBCOUNTER To check whether a property is a name property, please use PropertyDefinition::IsNamePart.

Example

PagePropertyList pagePropList = new PagePropertyList();
pagePropList.DESIGNATION_PLANT = "API_Test";
pagePropList.DESIGNATION_LOCATION = "New_Schematic";
pagePropList.PAGE_COUNTER = 002;
Page page = new Page( );
page.Create(project, DocumentTypeManager.DocumentType.Circuit, pagePropList);

Reference

Page Class
Page Members
Overload List
Project Class
PageType Property
PagePropertyList Class

Send Feedback