Interface ICommandHelp
This is used to send the result back to the client when a user asks help for a command.
Namespace: DotNetNuke.Abstractions.Prompt
Assembly: DotNetNuke.Abstractions.dll
Syntax
public interface ICommandHelpProperties
| Improve this Doc View SourceDescription
Gets or sets the description of the command.
Declaration
string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Error
Gets or sets any error produced while trying to retrieve help for this command.
Declaration
string Error { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
Gets or sets the name of the command.
Declaration
string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Options
Gets or sets the Command parameter list, each with their own help text.
Declaration
IEnumerable<ICommandOption> Options { get; set; }Property Value
| Type | Description |
|---|---|
| IEnumerable<ICommandOption> |
ResultHtml
Gets or sets the html formatted block of text that describes what this command does.
Declaration
string ResultHtml { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |