| Name | Description | |
|---|---|---|
 | PlanningSegment Constructor | Default constructor. |
The following tables list the members exposed by PlanningSegment.
| Name | Description | |
|---|---|---|
| PlanningSegment Constructor | Default constructor. |
| Name | Description | |
|---|---|---|
 | ArticleReferences | Returns Eplan.EplApi.DataModel.ArticleReferences that are referenced by PlanningSegment. |
| CanHaveArticleData | Check if the PlanningSegment can have Eplan.EplApi.DataModel.Articles. |
| Children | Returns all children of this object. |
| CrossReferencedObjectsAll | Returns 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) |
| DatabaseIdentifier | Returns 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) |
| Functions | Returns array of functions and 3d functions assigned to this object. |
| IsArticleDataReadOnly | Determines whether the article reference data can be changed for this object. |
| IsFixedDevice | Set or checks if device of this function is fixed. |
| IsLocked | Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsReadOnly | Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsTransient | 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) |
| IsValid | Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| LocalTemplates | Returns set of local templates assigned to this object or to its segment template. |
| Macro | Macro file with window or page macros, used when placing the macro. |
| Name | Returns the name of planning segment. |
| ObjectIdentifier | Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Pages | Returns collection of all pages assigned to the planning segment. |
| Parent | Gets or Sets parent object. |
| PLCAddresses | Returns array of PLC inputs and outputs for this planning object. |
| Project | Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Properties | EPLAN properties of the PlanningSegment object. |
| SegmentDefinition | Returns the SegmentDefinition of the PlanningObject. |
| SegmentPlacement | Returns placed representation of this planning segment. |
| SegmentTemplate | Segment template assigned to this object. |
| SortId | Number used to sort elements in current branch of planning tree. |
| TemplatesFromArticles | Returns set of templates from articles assigned to this object or to its segment template. |
| TypeIdentifier | Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| WriteProtected | Check if object is currently write protected or sets Manual write protection |
| Name | Description | |
|---|---|---|
 | AddArticleReference | Overloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the PlanningSegment. |
| AddLocalTemplate | Add new local template based on function definition. |
| AddPLCAddress | Overloaded. Creates copy of existing PLC inputs or outputs for this planning object. |
| CollectStructureProperties | Returns Eplan.EplApi.DataModel.FunctionBasePropertyList. |
 | Create | Creates PlanningSegment object. |
| CreateTransient | Creates transient PlanningSegment object. |
| Dispose() | Destructor for deterministic finalization of PlanningSegment object. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Equals | Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetHashCode | Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetWriteProtectionFlagSet | Checks if a specific write protection kind was set. |
| LockObject | Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| PauseWriteProtection | Temporarily disables write protection. Note that current write protection flags are not cleared. |
| PlaceAt | Places the segment onto the given page, in the given location. |
| PlaceMacroAt | Places a macro on a given page. |
| Remove | Removes object from PlanningSegment with all its children. |
| RemoveArticleReference | Removes the ArticleReference from the PlanningSegment |
| RemoveLocalTemplate | Removes a local template from this object. |
| RemovePLCAddress | Removes existing PLC input or output from this planning object. |
| RevertToTemplate | Restores information stored in template to planning object. |
| SmartLock | Tries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| ToStringIdentifier | Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject) |