Eplan Platform API
Eplan.EplApi.DataModel.Planning Namespace / StructureSegment Class

StructureSegment Class Properties

For a list of all members of this type, see StructureSegment members.

Public Properties
 NameDescription
Public PropertyReturns Eplan.EplApi.DataModel.ArticleReferences that are referenced by PlanningSegment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyCheck if the PlanningSegment can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns all children of this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns array of functions and 3d functions assigned to this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyDetermines whether the article reference data can be changed for this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertySet or checks if device of this function is fixed. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public Property

Determines if the the StorableObject is locked.

The StorableObject is locked when it was explicitly or implicitly locked.

(Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public Property

Determines if the the StorableObject is transient.

The StorableObject is transient when it was created by default constructor and:

it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project,

it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page.

(Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns set of local templates assigned to this object or to its segment template. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyMacro file with window or page macros, used when placing the macro. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns the name of planning segment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns collection of all pages assigned to the planning segment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyGets or Sets parent object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns array of PLC inputs and outputs for this planning object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyEPLAN properties of the StructureSegment object.  
Public PropertyReturns the SegmentDefinition of the PlanningObject. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns placed representation of this planning segment. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertySegment template assigned to this object. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyNumber used to sort elements in current branch of planning tree. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns set of templates from articles assigned to this object or to its segment template. (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyCheck if object is currently write protected or sets Manual write protection (Inherited from Eplan.EplApi.DataModel.Planning.PlanningSegment)
Top
See Also