Eplan Platform API
Eplan.EplApi.DataModel Namespace / ReportBlock Class
Members

In This Topic
    ReportBlock Class
    In This Topic
    This class represents a set of data which is used for report generation or update.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.ReportBlock

    Syntax
    public class ReportBlock : StorableObject 
    public ref class ReportBlock : public StorableObject 
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor. To use object created by this constructor function Create() is need to be called after that.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets/Sets a name of an action which may be used for customizing the report through API.  
    Public PropertyGets creation date  
    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 PropertyNames of devices assign to this report separated by a semicolon.  
    Public PropertyArray of names of devices assign to this report stored in property lists.  
    Public PropertyData of filter schema.  
    Public PropertyName of filter schema.  
    Public PropertyName of the form without file extension.  
    Public PropertyData of function filter schema.  
    Public PropertyName of function filter schema.  
    Public PropertyEvaluated functions.  
    Public PropertyData of function sort schema.  
    Public PropertyName of function sort schema.  
    Public PropertyDetermines if page description is generated automatically.  
    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 Page and it was not assigned a Project,

    it is a Placement or any class derived from it and was not assigned a 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 PropertyText used for describing page, if automatic page description if switched off.  
    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 PropertyEPLAN properties of the ReportBlock object.  
    Public PropertyData of sort schema.  
    Public PropertyName of sort schema.  
    Public PropertyType of evaluation.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    Public Methods
     NameDescription
    Public MethodCreate a new transient ReportBlock object.  
    Public MethodDeletes all report pages belonging to a report block.  
    Public MethodDestructor for deterministic finalization of ReportBlock 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 MethodRemoves the selected report block. The associated report pages remain as they are and are no longer updated.  
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    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 MethodTries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; 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