Class BrowserMessage

Namespace

PolarStudio

Assembly

PolarStudio.dll

This class contains info about one message that is queued to be sent to the browser.

public class BrowserMessage

Inheritance

object

BrowserMessage

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

MessageIsHtmlFormatted

This property indicates the message is HTML formatted (True) or text-formatted (False)

public bool MessageIsHtmlFormatted

Field Value

bool

Properties

CancelButtonCaption

Returns the caption of the Cancel button.

public string CancelButtonCaption { get; }

Property Value

string

Caption

Returns the caption of the message

public string Caption { get; }

Property Value

string

IconURL

Returns the URL for the icon of the message.

public string IconURL { get; }

Property Value

string

Message

Returns the contents of the message

public string Message { get; }

Property Value

string

OkButtonCaption

Returns the caption of the OK button.

public string OkButtonCaption { get; }

Property Value

string

OnCancelScript

Returns the script or action to perform when Cancel is clicked.

public string OnCancelScript { get; }

Property Value

string

OnCloseScript

Returns the script or action to perform when Close button is clicked.

public string OnCloseScript { get; }

Property Value

string

OnOkScript

Returns the script or action to perform when OK is clicked.

public string OnOkScript { get; }

Property Value

string

ReverseButtons

This property indicates if the OK and Cancel buttons are to be reversed.

public bool ReverseButtons { get; }

Property Value

bool

Style

Returns the additional class that is added to the container of the message.

public string Style { get; }

Property Value

string

Methods

MessageIsEqual(BrowserMessage)

This property compares the properties of this message with the given message.

public bool MessageIsEqual(BrowserMessage pBrowserMessageToCompare)

Parameters

pBrowserMessageToCompare BrowserMessage

The message to compare with.

Returns

bool

Returns True if the given message is equal to the current message.