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.
graph BT
Type["IReadOnlyArgumentAttribute"]
class Type type-node
Implementing0["IntegerArgumentAttribute"]-.->Type
click Implementing0 "/api/Cake.ArgumentBinder/IntegerArgumentAttribute"
Implementing1["BasePathAttribute"]-.->Type
click Implementing1 "/api/Cake.ArgumentBinder/BasePathAttribute"
Implementing2["BooleanArgumentAttribute"]-.->Type
click Implementing2 "/api/Cake.ArgumentBinder/BooleanArgumentAttribute"
Implementing3["FilePathArgumentAttribute"]-.->Type
click Implementing3 "/api/Cake.ArgumentBinder/FilePathArgumentAttribute"
Implementing4["EnumArgumentAttribute"]-.->Type
click Implementing4 "/api/Cake.ArgumentBinder/EnumArgumentAttribute"
Implementing5["BaseAttribute"]-.->Type
click Implementing5 "/api/Cake.ArgumentBinder/BaseAttribute"
Implementing6["DirectoryPathArgumentAttribute"]-.->Type
click Implementing6 "/api/Cake.ArgumentBinder/DirectoryPathArgumentAttribute"
Implementing7["StringArgumentAttribute"]-.->Type
click Implementing7 "/api/Cake.ArgumentBinder/StringArgumentAttribute"
Syntax
public interface IReadOnlyArgumentAttribute
Properties
Name | Value | Summary |
---|---|---|
ArgName | string |
The argument name
|
Description | string |
Description of what the argument does.
|
HasSecretValue | bool |
Set to true if the value passed into the argument
should be hidden from any print-outs to the console.
|
Required | bool |
If the value is not specified, this will fail validation.
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|