Interface IHasName

Namespace

CSF.Screenplay

Assembly

CSF.Screenplay.Abstractions.dll

A part of a Screenplay performance which has a human-readable name.

public interface IHasName

Remarks

Use this interface for any object within an IPerformance which could benefit from having a human-readable name. For example, static parameter values like Web API endpoints, web page URLs or elements on a web UI. By referring to an object by its name, and using that name in report-generating logic, reports generated from a Screenplay can become much easier to read and comprehend.

The Name property is used to provide a human-readable string which represents the object in the report text. This interface is a part of the mechanism for formatting values in reports in Screenplay.

Properties

Name

Gets the human-readable name of the current object.

string Name { get; }

Property Value

string

Remarks

null is strongly discouraged here. All types which implement IHasName should return a non-null response from this property.

See Also

IFormattableValue

IValueFormatter