RelationIndex Property

Eplan.EplApi.DataModel.Graphics Namespace / PropertyPlacement Class / RelationIndex Property

Collapse All

In This Topic

Syntax
Exceptions
Remarks
See Also

EPLAN API

RelationIndex Property

In This Topic

Syntax
Exceptions
Remarks
See Also

Gets/Sets RelationIndex of PropertyPlacement.

Syntax

C#
C++/CLI

public short RelationIndex {get; set;}

public:
property short RelationIndex {
   short get();
   void set (    short value);
}

Property Value

RelationIndex of Property placement.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when property cannot be set/get.
Eplan.EplApi.DataModel.ObjectNotCreatedException	Thrown when the PropertyPlacement object has not been initialized.
Eplan.EplApi.DataModel.InvalidHandleException	Thrown when the object handle that property value will be displayed is invalid.

Remarks

RelationIndex is used when Relation property is set to RelationType associated with Articles (Article, MainFunctionArticle etc.). It allows to choose index of Article from which property will be displayed. RelationIndex corresponds to the Row number in Parts tab in Function Properties dialog in GUI. Setter does not check if the given RelationIndex value is valid for the object. If given value is not valid PropertyPlacement text will be empty.

See Also

Reference

PropertyPlacement Class
PropertyPlacement Members

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

Send Feedback