Eplan Platform API
Eplan.EplApi.DataModel Namespace / Page Class / SetName(PagePropertyList) Method
New name for the page
Example

In This Topic
SetName(PagePropertyList) Method
In This Topic
Sets the name of the page. Name parts should be given in the PagePropertyList.
Syntax
public void SetName( 
   PagePropertyList pNameParts
)

Parameters

pNameParts
New name for the page
Exceptions
ExceptionDescription
Eplan.EplApi.Base.BaseExceptionCannot set name of the page
System.ArgumentNullExceptionThrown when pNameParts is null.
NameConflictExceptionThrown when page with pNameParts name already exists in pProject .
InvalidPageNameException_IncorrectPartsThrown 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);
See Also

Reference

Page Class
Page Members
PagePropertyList Class

 

 

EPLAN API , 18.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

Send Feedback