Report Class Members

In This Topic

The following tables list the members exposed by Report.

Public Properties

	Name	Description
	BackupExists	Does this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	CreatedBy	Overridden. Name of the document author.
	CreatedDate	Overridden. When was the document created.
	Data	Allows you to access the report table. The document must be open.
	Description	Overridden. Description of the document.
	ElectricalConfigurationInfo	Get electrical configuration of this report.
	HasFocus	Does this document have focus in the UI? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	HasRevision	Does this document have a revision? (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
	ID	ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
	IsOpened	Is this document opened? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	IsOpenedAsReadOnly	Is this document open as read only? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	IsRevision	Is this document part of a revision? (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
	IsUpToDate	Was the report updated after the last change of its sources?
	IsValid	Overridden. Tells you whether this object is valid or not.
	LastModified	Overridden. When was the document last modified.
	LastModifiedBy	Overridden. The user who modified the document last.
	LastUpdated	Date and time of the last update. See Update.
	Name	Overridden. Name of the document.
	Path	Overridden. Path to the document file.
	ReportType	Get the type of this report. Document must be open.
	Revisions	List all revisions this document has. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
	RevisionText	Note related to the revision of this document.
	Settings	Settings of the report.
	UserDefinedProperties	Overridden. List of User-defined properties of this document or project.
	Variant	Gets parent variant of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)

Top

Public Methods

	Name	Description
	AddReportSources	Add new sources for this report.
	Close	Close this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	Equals	Is this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	Export	Export this report to a file.
	GetAllCableUnitInfos	Gets all cable units which can be used as report sources of this report.
	GetAllHarnessInfos	Gets all wire harnesses which can be used as report sources of this report.
	GetHashCode	Serves as the default hash function. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	GetReportSources	Gets all sources from which this report is created.
	GetReportTypes	Returns list of report types"/>.
	Open	Overridden. Open this document.
	Promote	If this document is part of a revision, it gets promoted to a normal document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
	Remove	Overridden. Remove the document.
	RemoveReportSources	Remove some sources of this report.
	Restore	Restore this document from backup. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	Revise	Create new revision of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
	Save	Save this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
	SaveAsTemplate	Save this document as template. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
	ToString	Returns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
	Update	Update the report. Any changes in source documents will show up in the report.

Top

Reference

Report Class
EPLAN.Harness.API.Projects.Documents Namespace

Send Feedback