Interface IArgument
Unit
Declaration
type IArgument = interface(IInterface)
Description
Interface representing an argument that can be registered in CommandBuilder for later use by the user.
Attributes
- GUID['{930DA68E-6B31-4A05-A20E-C0056BFDE1AA}']
Hierarchy
- IInterface
- IArgument
Overview
Methods
| Public | function GetDescription: string; |
| Public | procedure SetDescription(const AValue: string); |
| Public | function GetConstraint: TArgumentConstraint; |
| Public | procedure SetConstraint(const AValue: TArgumentConstraint); |
| Public | function GetValue: string; |
| Public | procedure SetValue(const AValue: string); |
Properties
| Public | property Description: string read GetDescription write SetDescription; |
| Public | property Constraint: TArgumentConstraint read GetConstraint write SetConstraint; |
| Public | property Value: string read GetValue write SetValue; |
Description
Methods
| Public | function GetDescription: string; |
|
This item has no description. | |
| Public | procedure SetDescription(const AValue: string); |
|
This item has no description. | |
| Public | function GetConstraint: TArgumentConstraint; |
|
This item has no description. | |
| Public | procedure SetConstraint(const AValue: TArgumentConstraint); |
|
This item has no description. | |
| Public | function GetValue: string; |
|
returns the value of argument provided via parameter, this value should assigned after parse | |
| Public | procedure SetValue(const AValue: string); |
|
This item has no description. | |
Properties
| Public | property Description: string read GetDescription write SetDescription; |
|
Description of the argument that best describes its purpose. It can be displayed to the user when he requests help information for the application. | |
| Public | property Constraint: TArgumentConstraint read GetConstraint write SetConstraint; |
|
Argument constraints that will be validated against the arguments provided by the user in order to guarantee that the command is being used correctly. | |
| Public | property Value: string read GetValue write SetValue; |
|
Returns the value of an argument after parsing the parameters informed via the command line. If a given command line parameter has not been classified as a command, it will be assigned to an argument in the order of configuration. | |
Generated by PasDoc 1.0.4.