Message

FastGrid documentation

Message

Shows modal message inside the grid. And disables grid.
The message can be:
a) string as the message text, it equals to { Text:message }
b) object as the Message object, for example { Text:"Are you sure?",Header:"Confirmation",Buttons:["OK"] }
default is default message set to message D attribute.

func(string id,int index,string input) is called after the message is closed.
id is clicked button id, index is clicked button index from left (first = 0), input is entered text.
translate can be an object with attributes to use is in text translation of code in {}, see Text.
Returns true if the message is shown, otherwise returns false. Use to show message inside JavaScript code, the next code in laterfunc is delayed and is run after the message is shown.
To just postpone the laterfunc to run before paint without message use Later method instead.
Shows message by ShowMessage with parameters message, default, func, translate.
Next calls the function laterfunc with parameters parameters in setTimeout. After function finishes, hides message and calls Paint.
The laterfunc is called as a method of the Grid object.
Returns true if the message is shown, otherwise returns false. But the laterfunc is called always.
Hides actual grid message, if any. And enables grid.
If set now, it hides the message immediately without animation.
Disables the grid. If the grid is already disabled does nothing.
Disabled grid is disabled for a user, but still can be changed by API.
If set opaque, does not set the grid semi transparent.
Enables disabled grid. If the grid is not disabled does nothing. FastGrid root tag with all predefined messages. It contains named array of all the Message objects their names can be used in D when showing message.
Default message definition used for the message. The default message defines the attributes that the message has not set.
Predefined defaults in Defaults.js:

Base	Base default used for all messages
Message	Simple message displayed forever. Default message used for messages without specified default
Time	Message displayed for 2 seconds
ShortTime	Message displayed for 1 second
Ok	Message displayed forever with Ok button to close
Warning	Message displayed forever with Ok button to close and orange highlight used for warning
WarningTime	Message displayed displayed for 2 seconds and orange highlight used for warning
WarningShortTime	Message displayed displayed for 1 second and orange highlight used for warning
Error	Message displayed forever with Ok button to close and red highlight used for error
ErrorTime	Message displayed displayed for 2 seconds and orange red used for error
ErrorShortTime	Message displayed displayed for 1 second and orange red used for error
Progress	Message with progress bar
ProgressCancel	Message with progress bar and Cancel button
PromptSimple	Simple prompt for user input
Prompt	Prompt for user input with Ok and Cancel buttons
PromptReadOnly	Read only Prompt for user input with only Cancel buttons
PromptLines	Multiline textarea Prompt for user input with Ok and Cancel buttons
Confirm	Message to confirm or cancel action with Ok and Cancel buttons
Result	Message used for ResultMessage, it is displayed forever with Ok button to close
ResultError	Message used for ResultMessage with ResultError, it is displayed forever with Ok and Cancel buttons.

Main message text displayed in the middle of the message. It can contain HTML code. Message header text displayed on top of the message, if any. It can contain HTML code.
If set, the message displays progress bar in its bottom.
It can be object as the Progress object definition with attributes Value as actual progress number and Max as maximal progress number, for example { Value:3, Max:10 }
Or it can be int as shortcut for { Value:Progress, Max:100 }.
If the grid already shows message with Progress attribute, the next call of ShowMessage just updates the progress bar and does not re-create the message.
If set (including empty string), the message displays an <input> in its bottom to enter single line text.
The Prompt string is filled to the <input> on start.
If set (either to 1), permits entering multiline string in Prompt.
Specifies number of rows of the textarea.
Enter key in textarea inputs new line and Ctrl+Enter or Alt+Enter finishes editing, except the message has defined Button with Default:1.
If set, the Prompt input / textarea is read only and cannot be changed. If set to not zero number it hides the message after given number of milliseconds.
List of buttons shown in the bottom of the message, from left to right.
It can be string as comma separated list of button ids, e.g. "Ok,Cancel" = [ {id:"Ok"}, {id:"Cancel"} ]
It can be array of strings as array of button ids, e.g. ["Ok","Cancel"] = [ {id:"Ok"}, {id:"Cancel"} ]
It can be array of objects as array of Button objects, every Button object can have these attributes:
id - id of the button, passed as the first parameter to the func in ShowMessage when the button is clicked.
Text - button caption. If not set, the id is used. It can be also an identification string to the grid Text, read with "$Button" prefix, e.g. "Ok" is read from Text["$ButtonOk"].
Default - default button, for 1 it is clicked by Enter key, 2 it is clicked by Esc key.
If and how long (in milliseconds) animates the showing and hiding the message.
If and how long (in milliseconds) animates the showing when the grid already showed some message.
If and how the Message Text, Header and Button.Text will be translated by grid Text.
Can use the same values as cell Translate.
CSS opacity of the whole grid when grid is disabled.

Message style

Message style attributes can be set in these tags:
Message - in main message object for the whole message and all sections without setting the styles,
BodyStyle - for Text section and text,
HeaderStyle - for Header section and text,
PromptStyle - for Prompt input and its text,
PromptOuterStyle - for Prompt section,
ProgressStyle - for Progress section and bar,
ButtonsStyle - for Buttons section,
ButtonStyle - default style for every button and its text in Buttons section,
Button - in every message button object in Buttons and its text.
CSS background-color. It can be CSS color or FastGrid color name.
CSS border. It can contain also FastGrid color names and border width names. For example: Border:"2px solid red" or Border:"wgrid solid grid".
Unlike CSS it can contain more values separated by comma for top, right, bottom, left border in this order. For example: Border:",,wgrid solid grid,3px solid red" defines left and bottom border.
CSS box-shadow. It can contain also FastGrid color names and border width names. For example: Shadow:"0px 0px 0px 3px red" or Shadow:"2px 2px 0px 3px grid".
CSS padding. It can contain up to four values. For example: Padding:"10px 0px 5px 3px"
CSS margin. It can contain up to four values. For example: Margin:"10px 0px 5px 3px"
CSS color. It can be CSS color or FastGrid color name.
CSS settings for font-weight and font-style, bit array. 1. bit &1 Bold, 2. bit &2 Italic.
CSS settings for text-decoration, bit array.
1. bit &1 Underline, 2. bit &2 Strike, 3. bit &4 Overline,
4+5+6. bit &56 Line decoration (0 - solid, 8 - double, 16 - dotted, 24 - dashed, 32 - wavy),
7+8. bit &192 Line thickness (0 - 1px, 64 - 2px, 128 - 3px, 192 - 5px).
Color for TextLine. If not set, the line has the same color as the text. It can be CSS color or FastGrid color name.
CSS settings for text-shadow, bit array.
It contains only reference to TextShadows, there are predefined 0 - 30 number shadows, the 0 is no shadow.
Color for TextShadow. If not set, the shadow has the same color as the text. It can be CSS color or FastGrid color name.
CSS font-size. It can be number as value in pixels. The line-height is calculated as TextSize*LineHeightRatio.
Or it can be full CSS font-size / line-height, for example "12px/15px".
CSS font-family. It can be standard CSS font-family string like '"myfont",Arial,sans-serif'.
For PromptStyle only. CSS background-color of selected text in the prompt input / textarea. It can be CSS color or FastGrid color name.
For PromptStyle only. CSS color of selected text in the prompt input / textarea. It can be CSS color or FastGrid color name.
For ProgressStyle only. CSS background-color of the progress bar. It can be CSS color or FastGrid color name.
For ProgressStyle only. CSS background-color of the stripes on the progress bar. It can be CSS color or FastGrid color name.
For ProgressStyle only. Height in pixels of the progress bar. For ProgressStyle only. Width of the progress stripes in pixels. For ProgressStyle only. Duration of the animation cycle in milliseconds. 0 means no animation.