Class FlagParameterAttribute
Attribute to define the help for the flag parameter.
Implements
Inherited Members
Namespace: Dnn.PersonaBar.Library.Prompt.Attributes
Assembly: Dnn.PersonaBar.Library.dll
Syntax
[AttributeUsage(AttributeTargets.Field)]
[Obsolete("Deprecated in DotNetNuke 9.7.0. Moved to DotNetNuke.Prompt in the core library project and is now a Property Attribute called CommandParameter. Scheduled for removal in v11.0.0.")]
public class FlagParameterAttribute : Attribute, _AttributeConstructors
FlagParameterAttribute(string, string, string)
Initializes a new instance of the FlagParameterAttribute class.
Declaration
public FlagParameterAttribute(string flag, string description, string type)Parameters
| Type | Name | Description |
|---|---|---|
| string | flag | The flag name. |
| string | description | The description. |
| string | type | The expected type. |
FlagParameterAttribute(string, string, string, bool)
Initializes a new instance of the FlagParameterAttribute class.
Declaration
public FlagParameterAttribute(string flag, string description, string type, bool required)Parameters
| Type | Name | Description |
|---|---|---|
| string | flag | The flag name. |
| string | description | The description. |
| string | type | The expected type. |
| bool | required | Whether the flag is required. |
FlagParameterAttribute(string, string, string, string)
Initializes a new instance of the FlagParameterAttribute class.
Declaration
public FlagParameterAttribute(string flag, string description, string type, string defaultValue)Parameters
| Type | Name | Description |
|---|---|---|
| string | flag | The flag name. |
| string | description | The description. |
| string | type | The expected type. |
| string | defaultValue | The default value. |
FlagParameterAttribute(string, string, string, string, bool)
Initializes a new instance of the FlagParameterAttribute class.
Declaration
public FlagParameterAttribute(string flag, string description, string type, string defaultValue, bool required)Parameters
| Type | Name | Description |
|---|---|---|
| string | flag | The flag name. |
| string | description | The description. |
| string | type | The expected type. |
| string | defaultValue | The default value. |
| bool | required | Whether the flag is required. |
Properties
DefaultValue
Gets or sets default value of the flag.
Declaration
public string DefaultValue { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Description
Gets or sets description of flag.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Flag
Gets or sets name of the flag.
Declaration
public string Flag { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Required
Gets or sets a value indicating whether is flag required or not.
Declaration
public bool Required { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Type
Gets or sets type of the flag value expected.
Declaration
public string Type { get; set; }Property Value
| Type | Description |
|---|---|
| string |