SegmentTemplate Class

In This Topic

TODO

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.Planning.SegmentTemplate

Syntax

C#
C++/CLI

public class SegmentTemplate : Eplan.EplApi.DataModel.StorableObject, Eplan.EplApi.DataModel.IWriteProtection

public ref class SegmentTemplate : public Eplan.EplApi.DataModel.StorableObject, Eplan.EplApi.DataModel.IWriteProtection

Public Constructors

	Name	Description
	SegmentTemplate Constructor	Default constructor.

Top

Public Properties

	Name	Description
	CanHaveArticleData	Check if the SegmentTemplate can have Eplan.EplApi.DataModel.Articles.
	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)
	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)
	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)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	EPLAN properties of the SegmentTemplate object.
	SegmentDefinition	Definition object of this templates.
	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

Top

Public Methods

	Name	Description
	Create	Creates SegmentTemplate object.
	CreateTransient	Creates transient SegmentTemplate object.
	Dispose()	Destructor for deterministic finalization of SegmentTemplate 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
	Remove	Removes object from project with all its children.
	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)

Top

Reference

SegmentTemplate Members
Eplan.EplApi.DataModel.Planning Namespace

Send Feedback