Eplan Platform API
Eplan.EplApi.DataModel.Planning Namespace / SegmentTemplate Class
Properties Methods

In This Topic
    SegmentTemplate Class Members
    In This Topic

    The following tables list the members exposed by SegmentTemplate.

    Public Constructors
     NameDescription
    Public ConstructorSegmentTemplate ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyCanHaveArticleDataCheck if the SegmentTemplate can have Eplan.EplApi.DataModel.Articles.  
    Public PropertyCrossReferencedObjectsAllReturns 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 PropertyDatabaseIdentifierReturns 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 PropertyIsLocked

    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 PropertyIsReadOnlyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyIsTransient

    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 PropertyIsValidDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyNameReturns the name of planning segment.  
    Public PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyProjectReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPropertiesEPLAN properties of the SegmentTemplate object.  
    Public PropertySegmentDefinitionDefinition object of this templates.  
    Public PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyWriteProtectedCheck if object is currently write protected or sets Manual write protection  
    Top
    Public Methods
     NameDescription
    Public MethodCreateCreates SegmentTemplate object.  
    Public MethodCreateTransientCreates transient SegmentTemplate object.  
    Public MethodDispose()Destructor for deterministic finalization of SegmentTemplate object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodEqualsOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetTypeNameReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGetWriteProtectionFlagSetChecks if a specific write protection kind was set.  
    Public MethodLockObjectTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodPauseWriteProtectionTemporarily disables write protection. Note that current write protection flags are not cleared.  
    Public MethodRemoveRemoves object from project with all its children.  
    Public MethodSmartLockTries 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)
    Public MethodToStringIdentifierReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also

    Reference

    SegmentTemplate Class
    Eplan.EplApi.DataModel.Planning Namespace

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Send Feedback