System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.ReportBlock
System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.ReportBlock
public class ReportBlock : StorableObject
public ref class ReportBlock : public StorableObject
| Name | Description | |
|---|---|---|
 | ReportBlock Constructor | Default constructor. To use object created by this constructor function Create() is need to be called after that. |
| Name | Description | |
|---|---|---|
 | Action | Gets/Sets a name of an action which may be used for customizing the report through API. |
| CreateDate | Gets creation date |
| CrossReferencedObjectsAll | Returns 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) |
| DatabaseIdentifier | Returns 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) |
| DeviceTag | Names of devices assign to this report separated by a semicolon. |
| DeviceTagNameParts | Array of names of devices assign to this report stored in property lists. |
| FilterSchemaData | Property data represents filter scheme settings for report generation. |
| FilterSchemaName | Name of filter schema. |
| FormName | Name of the form without file extension. |
| FunctionFilterSchemaData | Property data represents function filter scheme settings for report generation. |
| FunctionFilterSchemaName | Name of function filter schema. |
| Functions | Evaluated functions. |
| FunctionSortSchemaData | Property data represents function sort scheme settings for report generation. |
| FunctionSortSchemaName | Name of function sort schema. |
| IsAutomaticPageDescription | Determines if page description is generated automatically. |
| IsLocked | Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsReadOnly | Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsTransient | 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) |
| IsValid | Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| ManualPageDescription | Text used for describing page, if automatic page description if switched off. |
| ObjectIdentifier | Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Project | Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Properties | EPLAN properties of the ReportBlock object. |
| SortSchemaData | Property data represents sort scheme settings for report generation. |
| SortSchemaName | Name of sort schema. |
| Type | Type of evaluation. |
| TypeIdentifier | Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Name | Description | |
|---|---|---|
 | Create | Create a new transient ReportBlock object. |
| Delete | Deletes all report pages belonging to a report block. |
| Dispose() | Destructor for deterministic finalization of ReportBlock object. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Equals | Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Freeze | Removes the selected report block. The associated report pages remain as they are and are no longer updated. |
| GetHashCode | Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| LockObject | Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| SmartLock | Tries 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) |
| ToStringIdentifier | Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject) |