Properties Property

Eplan.EplApi.DataModel Namespace / Function Class / Properties Property

Example Collapse All

In This Topic

Syntax
Exceptions
Remarks
Example
See Also

EPLAN API

Properties Property

In This Topic

Syntax
Exceptions
Remarks
Example
See Also

EPLAN properties of the Function object.

Syntax

C#
C++/CLI

public new FunctionPropertyList Properties {get;}

public:
new property FunctionPropertyList^ Properties {
   FunctionPropertyList^ get();
}

Exceptions

Exception	Description
ForbiddenOperationException	Thrown when this property is used for Eplan.EplApi.DataModel.EObjects.TerminalStrip or Eplan.EplApi.DataModel.EObjects.PlugStrip objects

Remarks

Do NOT use this function for TerminalStrip and PlugStrip objects. Those classes have their own 'Properties' members which hide the 'Properties' member of the Function class. When getting/setting the FUNC_CONNECTIONDESIGNATION, FUNC_CONNECTIONDESCRIPTION and FUNC_CONNECTIONCROSSSECTIONS properties, note that the maximum index which can be used is not only determined by the maximum index defined in the properties' definitions but also depends on the count of the function's connection points (i.e. cannot be higher than that).

Example

C#

Function func;
func.Properties[Properties.Function.DESIGNATION_PLANT] = "AP";
func.Properties[Properties.Function.FUNC_COMMENT] = "that is a good function";
string s = func.Properties[Properties.Function.FUNC_DEVICETAG_FULL];

See Also

Reference

Function Class
Function Members
FunctionPropertyList Class
Function Class

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

Send Feedback