Interface IConsoleResultModel

This is used to return the results of the execution of a command to the client.

Namespace: DotNetNuke.Abstractions.Prompt
Assembly: DotNetNuke.Abstractions.dll
Syntax
public interface IConsoleResultModel

Properties

| Improve this Doc View Source

Data

Gets or sets if the response contains data to be formatted by the client.

Declaration
object Data { get; set; }
Property Value
Type Description
System.Object
| Improve this Doc View Source

FieldOrder

Gets or sets the field order.

Declaration
string[] FieldOrder { get; set; }
Property Value
Type Description
System.String[]
Remarks

Optionally tell the client in what order the fields should be displayed.

| Improve this Doc View Source

IsError

Gets or sets a value indicating whether the output message is an error message.

Declaration
bool IsError { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsHtml

Gets or sets a value indicating whether output is HTML.

Declaration
bool IsHtml { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Let the client know if the output is HTML or not.

| Improve this Doc View Source

MustReload

Gets or sets a value indicating whether the prompt must reload.

Declaration
bool MustReload { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Should the client reload after processing the command.

| Improve this Doc View Source

NextPageCommand

Gets or sets the next page command.

Declaration
string NextPageCommand { get; set; }
Property Value
Type Description
System.String
Remarks

Command to be used to display the next page of data. This is set in the WebAPI handler.

| Improve this Doc View Source

Output

Gets or sets the returned result - text or HTML.

Declaration
string Output { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PagingInfo

Gets or sets the IPagingInfo.

Declaration
IPagingInfo PagingInfo { get; set; }
Property Value
Type Description
IPagingInfo
Remarks

Information about paging of data. This allows the client to prompt the user to load the next page of data.

| Improve this Doc View Source

Records

Gets or sets the number of records retrieved (for this page).

Declaration
int Records { get; set; }
Property Value
Type Description
System.Int32

Extension Methods