Eplan Platform API
Eplan.EplApi.DataModel.MasterData Namespace / FunctionDefinitionLibrary Class
Properties Methods

In This Topic
    FunctionDefinitionLibrary Class Members
    In This Topic

    The following tables list the members exposed by FunctionDefinitionLibrary.

    Public Constructors
     NameDescription
    Public ConstructorFunctionDefinitionLibrary ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    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 PropertyFunctionDefinitionsReturns all Eplan.EplApi.DataModel.FunctionDefinitions from FunctionDefinitionLibrary.  
    Public PropertyIdentifierSetsIdentifier set names.  
    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 PropertyObjectIdentifierReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyProjectOverridden. Returns the project the StorableObject belongs to.  
    Public PropertyPropertiesInternal properties list.  
    Public PropertyTypeIdentifierReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodCloseFor internal use. Closes the library. Note: Should be used only if this object was initialized with Initialize() method and that method returned TRUE.  
    Public MethodDisposeDestructor for deterministic finalization of StorableObject 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 MethodGetEnumeratorReturns an enumerator that iterates through the function definitions of this library.  
    Public MethodGetEnumerator2Returns an enumerator that iterates through the function definitions of this library.  
    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 MethodInitializeOverloaded. For internal use. Opens the standard function definition library from system masterdata. Note: if this method returns true, it means that the library was actually open during the initialization and it is the client responsibility to close it.  
    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 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

    FunctionDefinitionLibrary Class
    Eplan.EplApi.DataModel.MasterData Namespace
    FunctionDefinition Class

     

     

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

    Send Feedback