OpenTap.MetaDataAttribute Class Reference

Indicates that a property contains metadata which may be saved into results. More...

Inherits Attribute.

Classes
struct	MetaDataParameter
	Contains metadata for one property. More...

Public Member Functions
	MetaDataAttribute (bool promptUser=false, string macroName=null)
	Constructor for MetaDataAttribute. More...

Static Public Member Functions
static List< MetaDataParameter >	GetMetaDataParameters (object obj)
	Gets the name and value for each metadata property in this object that is not null. More...

Properties
bool	PromptUser [get]
	Which options are enabled for this attribute.
string	MacroName [get]
	Name of the macro.
bool	Frozen [getset]
	These properties does not change during test plan run.
string	Group [getset]
	The group of this metadata. Generally this does not need to be set. Common values for this is "Plan", "Step", "DUT".
string	Name [getset]
	The name of this metadata. Mostly this can be set to null to inherit Display Name.

Detailed Description

Indicates that a property contains metadata which may be saved into results.

ResultListeners can use this attribute to determine whether to save a property.

Constructor & Destructor Documentation

MetaDataAttribute()

OpenTap.MetaDataAttribute.MetaDataAttribute ( bool  promptUser = false, string  macroName = null  )

inline

Constructor for MetaDataAttribute.

Parameters

promptUser	The options for use with MetaData.
macroName	The text for use as macroname if the Macro option is selected.

Member Function Documentation

GetMetaDataParameters()

static List< MetaDataParameter > OpenTap.MetaDataAttribute.GetMetaDataParameters ( object  obj )

inlinestatic

Gets the name and value for each metadata property in this object that is not null.

Returns

Name and value for each metadata property in this object that is not null as a MetaDataParameter object.