SetName(PagePropertyList) Method

In This Topic

Sets the name of the page. Name parts should be given in the PagePropertyList.

Syntax

C#
C++/CLI

public void SetName( 
   PagePropertyList pNameParts
)

public:
void SetName( 
   PagePropertyList^ pNameParts
)

Parameters

pNameParts: New name for the page

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Cannot set name of the page
System.ArgumentNullException	Thrown when `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.

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.

Example

PagePropertyList pagePropList = new PagePropertyList();
pagePropList.DESIGNATION_PLANT = "API_Test";
pagePropList.DESIGNATION_LOCATION = "New_Schematic";
pagePropList.PAGE_COUNTER = 002;
page.SetName(pagePropList);

Reference

Page Class
Page Members
PagePropertyList Class

Send Feedback