Eplan Platform API
Eplan.EplApi.DataModel.E3D Namespace / PlaceHolder3D Class
Members

In This Topic
    PlaceHolder3D Class
    In This Topic
    TODO
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.E3D.PlaceHolder3D

    Syntax
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets/Sets a list of StorableObject references to a PlaceHolder3D object. The originally assigned references are replaced.  
    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 InstallationSpace in which this object exists or null.  
    Public PropertyActivates the properties of the installation space for the place holder object.  
    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 PropertyGets/Sets the name of the Placeholder3D.  
    Public PropertyGets/Sets the name of a record, specified by its index.  
    Public PropertyCount of records.  
    Public PropertyCount of objects referenced by the Placeholder3D.  
    Public PropertyCount of Variables.  
    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 the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to EPLAN properties of the PlaceHolder3D object.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets the value of a variable for a record.  
    Public PropertyNames of all variables in the Placeholder3D.  
    Top
    Public Methods
     NameDescription
    Public MethodAdds a new record with the specified name to the Placeholder3D object.  
    Public MethodAdds the reference of a Placement3D object to the Placeholder3D.  
    Public MethodAdds a new variable to the Placeholder3D object.  
    Public MethodOverloaded. Applies a record of values on a PlaceHolder3D object.  
    Public MethodCreates a new PlaceHolder3D object on the specified InstallationSpace.  
    Public MethodCreates transient and not placed PlaceHolder3D object.  
    Public MethodOverloaded. Deletes a record.  
    Public MethodDeletes all unused variables.  
    Public MethodDeletes a variable.  
    Public MethodDestructor for deterministic finalization of PlaceHolder3D object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodFinds a record by name.  
    Public MethodFinds an object in the list of object referenced by a Placeholder3D.  
    Public MethodFinds a variable, specified by its name.  
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGets a value or variable on a property of an object referenced by a Placeholder3D.  
    Public Method\Returns the names of all records in the nIndex-th PlaceHolder3D of a Macro.  
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGets the value of a variable for a record.  
    Public Method\Returns the values of all variables in the nIndex-th PlaceHolder3D of a Macro variant for a given record.  
    Public Method\Returns the names of all variables in the nIndex-th PlaceHolder3D of a Macro variant.  
    Public MethodVerifies the correctness if a variable name of a placeholder. If a variable name contains invalid characters, this method \returns false.  
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodRemoves invalid (e.g. deleted) object references from a PlaceHolder3D.  
    Public MethodRemoves object references from a PlaceHolder3D.  
    Public MethodSets a value or variable on a property of an object referenced by a Placeholder3D. The reference of the object will be added to the Placeholder3D if necessary.  
    Public MethodSets the value of a variable for a record.  
    Public MethodTries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; 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 MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also