This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.ArgumentBinder.

Summary

This is an argument that should be limited to an string. Note that this attribute can only be attached to a property whose type is a string, or run-time exceptions will occur.

Assembly

Cake.ArgumentBinder.dll

Namespace

Cake.ArgumentBinder

Interfaces

IReadOnlyArgumentAttribute

Base Types

Attribute
BaseAttribute

graph BT Type-->Base0["BaseAttribute"] click Base0 "/api/Cake.ArgumentBinder/BaseAttribute" Base0-->Base1["Attribute"] Type-.->Interface0["IReadOnlyArgumentAttribute"] click Interface0 "/api/Cake.ArgumentBinder/IReadOnlyArgumentAttribute" Type["StringArgumentAttribute"] class Type type-node

Syntax

public sealed class StringArgumentAttribute : BaseAttribute, IReadOnlyArgumentAttribute

Constructors

Name	Summary
StringArgumentAttribute(string, ArgumentSource)
StringArgumentAttribute(string)

Properties

Name	Value	Summary
ArgName	string	The name of the argument that is passed in via the command-line. Inherited from BaseAttribute
ArgumentSource	ArgumentSource	Where to find the argument's value. Inherited from BaseAttribute
BaseDefaultValue	object
DefaultArgumentSource	ArgumentSource	Inherited from BaseAttribute static
DefaultValue	string
Description	string	Description of what the argument does. Inherited from BaseAttribute
HasSecretValue	bool	Set to true if the value passed into the argument should be hidden from any print-outs to the console. Inherited from BaseAttribute
Required	bool	If the value is not specified, this will fail validation when this is set to true. Inherited from BaseAttribute

Methods

Name	Value	Summary
ToString()	string
ToString(StringBuilder)	void	Appends this class's string representation to the passed in string builder object. This should be the first thing called when creating a ToString() function of all child classes. Inherited from BaseAttribute

Extension Methods