 | Report Class |
The Ranorex reporting service.
Used to log messages to a number of configured loggers.
Used to log messages to a number of configured loggers.
Inheritance HierarchySystemObject
RanorexReport
RanorexReport
Namespace: Ranorex
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06
SyntaxThe Report type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | CurrentReportLevel | Obsolete.
Gets or sets the current report level that is the minimum ReportLevel message
need to have to be included in the report.
|
| CustomCategoryStyles |
Allows setting of custom formatting CSS styles per category. These styles override ReportLevel styles if set.
|
| DefaultCategory |
Gets or sets the default report category to use if not explicitly specified when reporting messages.
|
| MinimumReportLevel |
Gets or sets the current report level that is the minimum ReportLevel message
need to have to be included in the report.
|
Methods| Name | Description | |
|---|---|---|
 | AttachLogger |
Attaches a custom logger to the reporting environment.
|
| Copy(String, String) |
Copies a XML or zipped XML report file and all the external files referenced by the report file to a file.
This method automatically handles copying from and to zipped and unzipped report files.
|
| Copy(ReportEnvironment, String) |
Copies a XML or zipped XML report file and all the external files referenced by the report file to a file.
This method automatically handles copying from and to zipped and unzipped report files.
|
| CopyToFileOrFileStream(String, String, Stream) | Obsolete.
Copies a XML or zipped XML report file and all the external files referenced by the report file to a file or stream.
This method automatically handles copying from and to zipped and unzipped report files.
|
| CopyToFileOrFileStream(ReportEnvironment, String, Stream) | Obsolete.
Copies a XML or zipped XML report file and all the external files referenced by the report file to a file or stream.
This method automatically handles copying from and to zipped and unzipped report files.
|
| Debug(String) |
Logs a debug-level message, using the default category.
|
| Debug(String, String) |
Logs a debug-level message.
|
| DetachLogger |
Detaches a custom logger from the reporting environment.
|
| End |
Ends reporting. It is not required to explicitly call this method before shutdown.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Error(String) |
Logs an error-level message, using the default category.
|
| Error(String, String) |
Logs an error-level message.
|
| Failure(String) |
Logs a logical failure (e.g. test step failure) message, using the default category.
|
| Failure(String, String) |
Logs a logical failure (e.g. test step failure) message.
|
 | Finalize |
Finalizer for automatic logger shutdown.
(Overrides ObjectFinalize.) |
| GetDependentFiles | Obsolete.
Gets all the external files referenced by the report file.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasReportDataFileExtension |
Determines if a file name has the Ranorex Stub View report file extension.
|
| HasReportFileExtension |
Determines if a file name has the Ranorex Xml report file extension.
|
| HasZipReportFileExtension |
Determines if a file name has the Ranorex Zip report file extension.
|
| Info(String) |
Logs an info-level message, using the default category.
|
| Info(String, String) |
Logs an info-level message.
|
| IsReportFile(String) |
Determines if a file is a valid Ranorex report file.
|
| IsReportFile(String, String) |
Determines if a file is a valid Ranorex report file.
|
| Link(String) |
Adds the specified link to the report. If the link is a relative file path or points to a file
within the report directory, the linked file will also be included in zipped or copied versions of the report.
|
| Link(String, String) |
Adds the specified link to the report. If the link is a relative file path or points to a file
within the report directory, the linked file will also be included in zipped or copied versions of the report.
|
| Link(ReportLevel, String, String, String, IReportMetadata) |
Adds the specified link to the report. If the link is a relative file path or points to a file
within the report directory, the linked file will also be included in zipped or copied versions of the report.
|
| Log(ReportLevel, String) |
Logs a message using the DefaultCategory.
|
| Log(ReportLevel, String, String) |
Logs a message.
|
| Log(ReportLevel, String, String, IReportMetadata) |
Logs a message.
|
| LogData(ReportLevel, String, Object) |
Logs a data message.
|
| LogData(ReportLevel, String, String, Object) |
Logs a data message.
|
| LogData(ReportLevel, String, String, Object, IReportMetadata) |
Logs a data message.
|
| LogHtml(ReportLevel, String) |
Logs a message using the DefaultCategory. The message can contain XHTML markup.
|
| LogHtml(ReportLevel, String, String) |
Logs a message. The message must contain valid XHTML markup.
|
| LogHtml(ReportLevel, String, String, IReportMetadata) |
Logs a message. The message must contain valid XHTML markup.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ProcessSummary(Process) |
Logs a message containing a short process summary.
|
| ProcessSummary(Int32) |
Logs a message containing a short process summary.
|
| ProcessSummary(String) |
Logs a message containing a short process summary.
|
| ProcessSummary(Element) |
Logs a message containing a short process summary.
|
| ProcessSummary(RepoItemInfo) |
Logs a message containing a short process summary.
|
| Screenshot |
Logs a message containing a screenshot of the whole desktop.
|
| Screenshot(Element) |
Logs a message containing a screenshot of a specified element.
|
| Screenshot(String, Element) |
Logs a message containing a screenshot of a specified element.
|
| Screenshot(Element, Boolean) |
Logs a message containing a screenshot of a specified element.
|
| Screenshot(String, Element, Boolean) |
Logs a message containing a screenshot of a specified element.
|
| Screenshot(ReportLevel, String, String, Element, Boolean, IReportMetadata) |
Logs a message containing a screenshot of a specified element.
|
| Setup(ReportLevel, String, Boolean) |
Sets up the reporting environment compatible with Ranorex version 2.X.
|
| Setup(ReportLevel, String, Boolean, Boolean) |
Sets up the reporting environment compatible with Ranorex version 2.X.
|
| SetupDefault |
Sets up the reporting environment with Info, XML logging and console logging enabled.
|
| Snapshot(Element) |
Creates and stores a snapshot of the specified target element
and adds a link to the snapshot to the report.
|
| Snapshot(String, Element) |
Creates and stores a snapshot of the specified target element
and adds a link to the snapshot to the report.
|
| Snapshot(ReportLevel, String, String, Element, IReportMetadata) |
Creates and stores a snapshot of the specified target element
and adds a link to the snapshot to the report.
|
| Start |
Starts reporting with the previously configured settings.
|
| Success(String) |
Logs a logical success (e.g. test step success) message, using the default category.
|
| Success(String, String) |
Logs a logical success (e.g. test step success) message.
|
| SystemSummary |
Logs a message containing a short system the summary.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unzip |
Unzips a zipped XML report file (with the extension ".rxzlog") and all the external files references.
|
| Warn(String) |
Logs a warning-level message, using the default category.
|
| Warn(String, String) |
Logs a warning-level message.
|
| Zip(String, String, String) |
Zips the XML report file and all the external files referenced by the report file to a zip file with the extension ".rxzlog".
|
| Zip(ReportEnvironment, String, String) |
Zips the XML report file and all the external files referenced by the report file to a zip file with the extension ".rxzlog".
|
See Also