Eplan Platform API
Eplan.EplApi.DataModel Namespace / IPlaceHolder Interface
Properties Methods

In This Topic
    IPlaceHolder Interface Members
    In This Topic

    The following tables list the members exposed by IPlaceHolder.

    Public Properties
     NameDescription
    PropertyAssignedObjectsGets/Sets a list of StorableObject references to a PlaceHolder object. The originally assigned references are replaced.  
    PropertyIsDocumentReferenceActiveActivates the properties of the page/installation space for the place holder object.  
    PropertyNameGets/Sets the name of the Placeholder3D.  
    PropertyNameOfRecordGets/Sets the name of a record, specified by its index.  
    PropertyNumberOfRecordsCount of records.  
    PropertyNumberOfReferencesCount of objects referenced by the Placeholder3D.  
    PropertyNumberOfVariablesCount of Variables.  
    PropertyValueGets/Sets the value of a variable for a record.  
    PropertyVariableNamesNames of all variables in the Placeholder3D.  
    Top
    Public Methods
     NameDescription
    MethodAddRecordAdds a new record with the specified name to the Placeholder3D object.  
    MethodAddVariableAdds a new variable to the Placeholder3D object.  
    MethodApplyRecordOverloaded. Applies a record of values on a PlaceHolder object.  
    MethodDeleteRecordOverloaded. Deletes a record.  
    MethodDeleteUnusedVariablesDeletes all unused variables.  
    MethodDeleteVariableDeletes a variable.  
    MethodFindRecordFinds a record by name.  
    MethodFindVariableFinds a variable, specified by its name.  
    MethodGetAllCurrentValuesGets a list of all current values in Placeholder.  
    MethodGetCurrentValueGets current value for given object, property and index.  
    MethodGetProjectPropertyEntryGets a value or variable of Placeholder project property.  
    MethodGetRecordNames\Returns the names of all records in the nIndex-th PlaceHolder of a Macro.  
    MethodGetValueGets the value of a variable for a record.  
    MethodGetValues\Returns the values of all variables in the nIndex-th PlaceHolder of a Macro variant for a given record.  
    MethodGetVariableNames\Returns the names of all variables in the nIndex-th PlaceHolder of a Macro variant.  
    MethodIsVariableValidVerifies the correctness if a variable name of a placeholder. If a variable name contains invalid characters, this method \returns false.  
    MethodRemoveInvalidObjectReferencesRemoves invalid (e.g. deleted) object references from a PlaceHolder.  
    MethodRemoveObjectReferencesRemoves object references from a PlaceHolder.  
    MethodSetProjectPropertyEntrySets a value or variable on Placeholder project property. The reference of the object will be added to the Placeholder if necessary.  
    MethodSetValueSets the value of a variable for a record.  
    Top
    See Also

    Reference

    IPlaceHolder Interface
    Eplan.EplApi.DataModel Namespace

     

     

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

    Use the Eplan Global Support Portal for feedback and support