Class CsAttributeParameterValue

Data class that represents an attributes parameter value.

Inheritance
object
CsModel
CsAttributeParameterValue
Implements
Inherited Members
Namespace: CodeFactory.DotNet.CSharp
Assembly: CodeFactory.DotNet.dll
Syntax
public abstract class CsAttributeParameterValue : CsModel, ICsAttributeParameterValue, ICsModel, IDotNetAttributeParameterValue, IDotNetModel, IModelStatus

Constructors

| Improve this Doc View Source

CsAttributeParameterValue(bool, bool, bool, SourceCodeType, AttributeParameterKind, string, string, CsType, IReadOnlyList<CsAttributeParameterValue>, string, ModelStore<ICsModel>, IReadOnlyList<ModelLoadException>)

Constructor for the CsAttributeParameterValue

Declaration
protected CsAttributeParameterValue(bool isLoaded, bool hasErrors, bool loadedFromSource, SourceCodeType language, AttributeParameterKind parameterKind, string value, string enumValue, CsType typeValue, IReadOnlyList<CsAttributeParameterValue> values, string sourceDocument = null, ModelStore<ICsModel> modelStore = null, IReadOnlyList<ModelLoadException> modelErrors = null)
Parameters
Type Name Description
bool isLoaded

Flag that determines if the model was loaded.
bool hasErrors

Flag that determine if errors were found creating the model.
bool loadedFromSource

Flag that determines if the model was loaded from source code or from an existing library.
SourceCodeType language

The target language the model was generated from.
AttributeParameterKind parameterKind

The kind of attribute parameter.
string value

The value of the attribute parameter.
string enumValue

The value of the enumeration if the parameter is an enumeration.
CsType typeValue

The type if the parameter is a single value.
IReadOnlyList<CsAttributeParameterValue> values

The list of values if the parameter has more then one value.
string sourceDocument

The source document that was used to build this model. This is optional parameter and can be null.
ModelStore<ICsModel> modelStore

Optional the lookup storage for models created during the compile or lookup of the model.
IReadOnlyList<ModelLoadException> modelErrors

Optional the error that occurred while creating the model.

Properties

| Improve this Doc View Source

EnumValue

The enum value provides the name of the enumeration value that was provided. This will be populated if the property ParameterKind is set to 'Enum'

Declaration
public string EnumValue { get; }
Property Value
Type Description
string
| Improve this Doc View Source

ParameterKind

Determines the kind of parameter that has been returned.

Declaration
public AttributeParameterKind ParameterKind { get; }
Property Value
Type Description
AttributeParameterKind
| Improve this Doc View Source

TypeValue

The type definition of the parameter that was passed. This will be populated if the property ParameterKind is set to 'Type'

Declaration
public CsType TypeValue { get; }
Property Value
Type Description
CsType
| Improve this Doc View Source

Value

Gets the raw value assigned to the parameter. This will be populated if the property ParameterKind is not set to 'Array'

Declaration
public string Value { get; }
Property Value
Type Description
string
| Improve this Doc View Source

Values

Gets an enumeration of all the parameter values that were assigned to the attribute parameter. This will be populated if the property ParameterKind is set to 'Array'

Declaration
public IReadOnlyList<CsAttributeParameterValue> Values { get; }
Property Value
Type Description
IReadOnlyList<CsAttributeParameterValue>

Explicit Interface Implementations

| Improve this Doc View Source

IDotNetAttributeParameterValue.TypeValue

The type definition of the parameter that was passed. This will be populated if the property ParameterKind is set to 'Type'

Declaration
IDotNetType IDotNetAttributeParameterValue.TypeValue { get; }
Returns
Type Description
IDotNetType
| Improve this Doc View Source

IDotNetAttributeParameterValue.Values

Gets an enumeration of all the parameter values that were assigned to the attribute parameter. This will be populated if the property ParameterKind is set to 'Array'

Declaration
IReadOnlyList<IDotNetAttributeParameterValue> IDotNetAttributeParameterValue.Values { get; }
Returns
Type Description
IReadOnlyList<IDotNetAttributeParameterValue>

Implements

ICsAttributeParameterValue
ICsModel
IDotNetAttributeParameterValue
IDotNetModel
IModelStatus

Extension Methods

CsModelExtensions.FormatCSharpAttributeParameterValueSignatureSyntax(CsAttributeParameterValue)
CsAttributeParameterValueExtensions.CSharpFormatAttributeParameterValueSignature(CsAttributeParameterValue)
CSharpModelExtensions.ToModel<T>(CsModel)
DotNetModelExtensions.FormatCSharpAttributeParameterValueSignatureSyntax(IDotNetAttributeParameterValue)