The Ranorex reporting service.
Used to log messages to a number of configured loggers.
Used to log messages to a number of configured loggers.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class Report
Public Class Report
public ref class Report
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
  | AttachLogger(IReportLogger) |
Attaches a custom logger to the reporting environment.
|
| CopyToFileOrFileStream(String, String, Stream) |
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) |
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.
|
 | CurrentReportLevel |
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.
|
| Debug(String, String) |
Logs a debug-level message.
|
| Debug(String) |
Logs a debug-level message, using the default category.
|
| DefaultCategory |
Gets or sets the default report category to use if not explicitly specified when reporting messages.
|
| DetachLogger(IReportLogger) |
Detaches a custom logger from the reporting environment.
|
| End()()() |
Ends reporting. It is not required to explicitly call this method before shutdown.
|
| Equals(Object) | (Inherited from Object.) |
| Error(String, String) |
Logs an error-level message.
|
| Error(String) |
Logs an error-level message, using the default category.
|
| Failure(String, String) |
Logs a logical failure (e.g. test step failure) message.
|
| Failure(String) |
Logs a logical failure (e.g. test step failure) message, using the default category.
|
 | Finalize()()() |
Finalizer for automatic logger shutdown.
(Overrides Object.Finalize()()().) |
| GetDependentFiles(String) | Obsolete.
Gets all the external files referenced by the report file.
|
| GetHashCode()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()() | Gets the type of the current instance. (Inherited from Object.) |
| HasReportDataFileExtension(String) |
Determines if a file name has the Ranorex Stub View report file extension.
|
| HasReportFileExtension(String) |
Determines if a file name has the Ranorex Xml report file extension.
|
| HasZipReportFileExtension(String) |
Determines if a file name has the Ranorex Zip report file extension.
|
| Info(String, String) |
Logs an info-level message.
|
| Info(String) |
Logs an info-level message, using the default category.
|
| 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.
|
| Log(ReportLevel, String) |
Logs a message using the DefaultCategory.
|
| Log(ReportLevel, String, String) |
Logs a message.
|
| Log(ReportLevel, String, String, array<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, array<IReportMetadata>[]()[]) |
Logs a data message.
|
| LogHtml(ReportLevel, String, String) |
Logs a message. The message must contain valid HTML markup.
|
| LogHtml(ReportLevel, String, String, array<IReportMetadata>[]()[]) |
Logs a message. The message must contain valid HTML markup.
|
| LogHtml(ReportLevel, String) |
Logs a message using the DefaultCategory. The message can contain HTML markup.
|
| MemberwiseClone()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Screenshot()()() |
Logs a message containing a screenshot of the whole desktop.
|
| Screenshot(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) |
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, array<IReportMetadata>[]()[]) |
Logs a message containing a screenshot of a specified element.
|
| Setup(ReportLevel, String, Boolean, Boolean) |
Sets up the reporting environment compatible with Ranorex version 2.X.
|
| Setup(ReportLevel, String, 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, array<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, String) |
Logs a logical success (e.g. test step success) message.
|
| Success(String) |
Logs a logical success (e.g. test step success) message, using the default category.
|
| SystemSummary()()() |
Logs a message containing a short system the summary.
|
| ToString()()() | Returns a string that represents the current object. (Inherited from Object.) |
| Unzip(String, String) |
Unzips a zipped XML report file (with the extension ".rxzlog") and all the external files references.
|
| Warn(String, String) |
Logs a warning-level message.
|
| Warn(String) |
Logs a warning-level message, using the default category.
|
| 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".
|
| Zip(ReportEnvironment, Stream) |
Zips the XML report file and all the external files referenced by the report file to a zip file with the extension ".rxzlog".
|
Inheritance Hierarchy| Object | |
 | Report |