Class ConfigCommand
Stores the configuration for a CodeFactory command.
Implements
Inherited Members
Namespace: CodeFactory.WinVs.Commands
Assembly: CodeFactory.WinVs.dll
Syntax
public class ConfigCommand : IConfigGuidanceProperties
Category
The target category the command belongs to.
Declaration
public string Category { get; set; }Property Value
| Type | Description |
|---|---|
| string |
CommandType
The fully qualified type name of the command that is used by this configuration.
Declaration
public string CommandType { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ExecutionProject
The project the command is executed in.
Declaration
public ConfigProject ExecutionProject { get; set; }Property Value
| Type | Description |
|---|---|
| ConfigProject |
Guidance
Instructions for what data is to go into the configuration.
Declaration
public string Guidance { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Name
The name assigned to represent the command being executed.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Parameters
Parameters that are used with the command implementation.
Declaration
public ImmutableList<ConfigParameter> Parameters { get; set; }Property Value
| Type | Description |
|---|---|
| ImmutableList<ConfigParameter> |
Projects
Additional projects that will provide source and target projects used by the executing command.
Declaration
public ImmutableList<ConfigProject> Projects { get; set; }Property Value
| Type | Description |
|---|---|
| ImmutableList<ConfigProject> |
Methods
AddParameter(ConfigParameter)
Fluent method that adds a parameter to the command.
Declaration
public ConfigCommand AddParameter(ConfigParameter parameter)Parameters
| Type | Name | Description |
|---|---|---|
| ConfigParameter | parameter | The parameter to add to the command. |
Returns
| Type | Description |
|---|---|
| ConfigCommand | Updated command source. |
AddProject(ConfigProject)
Fluent method that adds a project to the command.
Declaration
public ConfigCommand AddProject(ConfigProject project)Parameters
| Type | Name | Description |
|---|---|---|
| ConfigProject | project | The project to add to the command. |
Returns
| Type | Description |
|---|---|
| ConfigCommand | Updated command source. |
Parameter(string)
Gets the target parameter that has been assigned to this command source.
Declaration
public ConfigParameter Parameter(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the parameter to lookup. |
Returns
| Type | Description |
|---|---|
| ConfigParameter | The parameter source or null if the parameter was not found. |
ParameterValue(string)
Gets the target parameter value that has been assigned to a parameter source assigned to this command source.
Declaration
public string ParameterValue(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the parameter to lookup. |
Returns
| Type | Description |
|---|---|
| string | The parameter value or null. |
Project(string)
Gets a project configured from this command by the name of the target project.
Declaration
public ConfigProject Project(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the project to retrieve. |
Returns
| Type | Description |
|---|---|
| ConfigProject | The project source or null if the target project could not be found. |
UpdateExecutionProject(ConfigProject)
Fluent method that updates the commands execution project.
Declaration
public ConfigCommand UpdateExecutionProject(ConfigProject executionProject)Parameters
| Type | Name | Description |
|---|---|---|
| ConfigProject | executionProject | Project configuration for the execution project. |
Returns
| Type | Description |
|---|---|
| ConfigCommand | Updated command source. |