Class Request

Namespace

PolarStudio

Assembly

PolarStudio.dll

The Request only lives while one request is processed.

public class Request

Inheritance

object

Request

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Globals.IsNumericType(object)

Fields

ReturnPlainHTML

This property indicates if this request is a 'normal' web session request (thus creating all kind of html headers, a form, etc) or that the request returns plain/raw html.

public bool ReturnPlainHTML

Field Value

bool

Properties

BPserver

Returns the reference to the BPserver object for this project (the presentation layer).

public BPserver BPserver { get; }

Property Value

BPserver

BudaEngine

Returns the reference to the BudaEngine object (the data layer).

public BudaEngine BudaEngine { get; }

Property Value

BudaEngine

BudaSession

Returns the reference to the BudaSession object (the data-layer session that is tied to the WebSession).

public BudaSession BudaSession { get; }

Property Value

BudaSession

CurrentButtonName

This property contains the name of the (custom)button that is currently processed. This property can be cleared if further actions (on higher levels) for this button-event are not wanted anymore.

public string CurrentButtonName { get; set; }

Property Value

string

EncodeMultiPart

This property gets/sets the encoding of the web-form to multi-part. This property can only updated to True, once set, reset not possible. The multi-part encoding is for example required when files are to be uploaded from the browser.

public bool EncodeMultiPart { get; set; }

Property Value

bool

Expires

This property sets the expiration of the web-response in minutes. A value of -1 means expire immediately.

public int Expires { get; set; }

Property Value

int

Form

Returns a FormFields-object that can be used to access all fields that are sent in a post-request.

public FormFields Form { get; }

Property Value

FormFields

LastActiveElementName

Returns the name of the last active element as reported by the browser.

public string LastActiveElementName { get; }

Property Value

string

ModalFormShown

This method returns a boolean indicating a modal form is currently shown.

public bool ModalFormShown { get; }

Property Value

bool

RawPostedData

This property contains the raw data as a binary string as it was posted. It is only available during the processing of a GetBlobScript (so in a ReturnBlob script).

public string RawPostedData { get; }

Property Value

string

RecordCounter_EndRecordNumber

Returns the end recordnumber for the record counter.

public long RecordCounter_EndRecordNumber { get; }

Property Value

long

RecordCounter_FilterOn

Returns a boolean for the record counter indicating a filter is applied.

public bool RecordCounter_FilterOn { get; }

Property Value

bool

RecordCounter_RecordCount

Returns the total record count for the record counter.

public long RecordCounter_RecordCount { get; }

Property Value

long

RecordCounter_StartRecordNumber

Returns the start recordnumber for the record counter.

public long RecordCounter_StartRecordNumber { get; }

Property Value

long

Session

Returns the web-session this request is comming from.

public Session Session { get; }

Property Value

Session

TargetForm

This property contains a reference to the currently targetet form.

public Form TargetForm { get; }

Property Value

Form

Title

This property sets the title as is to be sent to the browser.

public string Title { get; set; }

Property Value

string

WebRequest

Returns the WebRequest for this request. The web-request is the bare layer that processes the browser's http-request.

public clsBPwebRequest WebRequest { get; }

Property Value

clsBPwebRequest

WebResponse

Returns the WebResponse for this request. The web-response is the bare layer that is used to return date for browser's http-request.

public clsBPwebResponse WebResponse { get; }

Property Value

clsBPwebResponse

Methods

AddBrowserSettings(string)

This method is used to add extra BrowserSettings to the HTML that is created. Often used to add scripts or CSS-links. In many cases it is prefered to use the AddClientScript method instead.

public void AddBrowserSettings(string pAdditionalSettingsHTML)

Parameters

pAdditionalSettingsHTML string

The raw html to add to the beginning of the page.

AddBrowserSettings_EndOfPage(string)

This method is used to add extra BrowserSettings to the end of the HTML that is created. Often used to add scripts. In many cases it is prefered to use the AddClientScript method instead.

public void AddBrowserSettings_EndOfPage(string pAdditionalSettingsHTML)

Parameters

pAdditionalSettingsHTML string

The raw html to add to the end of the page.

AddClientScript(string)

This method is used to add a javascript-action to the browser (at the end of the page). The script-tags are added automatically.

public void AddClientScript(string pClientJavaScriptExpression)

Parameters

pClientJavaScriptExpression string

The javascript-expression to run in the browser.

AddHTMLheader(string, string)

This method is used to add a HTML to the head-section of the current response.

public void AddHTMLheader(string pHeaderData, string pKey = "")

Parameters

pHeaderData string

The html that has to be added to the head-section. Can be a script or a css-include html, etc.

pKey string

A key that can be used to prevent duplicates.

FormFieldNames()

Returns an array of strings containing all field names sent in this request.

public string[] FormFieldNames()

Returns

string[]

SendBrowser_Menu()

This method is used to send the menu-html to the browser. Is depricated, but still used to force re-determining all allowed menu-items.

public void SendBrowser_Menu()

SetRecordCounter(long, long, long, bool)

This method sets the RecordCounter as is shown on the bottom of the page. Use SetRecordCounter(-1, -1, -1, False) to clear the counter...

public void SetRecordCounter(long pStartRecordNumber, long pEndRecordNumber, long pRecordCount, bool pFilterOn)

Parameters

pStartRecordNumber long

The start record-number

pEndRecordNumber long

The end record-number. Use -1 to hide.

pRecordCount long

The total number of available records.

pFilterOn bool

A boolean indicating a filter is applied.