The init-crash-script Element"
From Documentation
Chunfuchang (talk | contribs) (Created page with "{{ZKConfigurationReferencePageHeader}} '''Syntax:''' <init-crash-script>javascript function assigned to '''window.zkShowCrashMessage'''</init-crash-script> [Default: see cras...") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
[Default: see crashmsg.js] | [Default: see crashmsg.js] | ||
| − | |||
| − | + | {{versionSince| 7.0.4}} | |
| + | |||
| + | If the client engine stops working before even the error handling is initialized (e.g. when ZK's core scripts fail to download - <code>zk.wpd</code>), you will see the message below: | ||
| + | |||
| + | [[File:error_handling_crash_screen.png| center]] | ||
| + | |||
| + | This element allows you to show a custom crash message when initiation by writing a javascript function which is assigned to <code>window.zkShowCrashMessage</code>. | ||
| + | |||
For example, | For example, | ||
| − | <source lang="xml" | + | <source lang="xml" highlight="3, 6" > |
<client-config> | <client-config> | ||
<init-crash-script><![CDATA[ | <init-crash-script><![CDATA[ | ||
| − | window.zkShowCrashMessage = function () { | + | window.zkShowCrashMessage = function (code) { |
var h2 = '<h2 style="background: rgb(1,133,174); text-align: center; ' | var h2 = '<h2 style="background: rgb(1,133,174); text-align: center; ' | ||
+ 'color: white; width: 700px; margin: 0 auto;">'; | + 'color: white; width: 700px; margin: 0 auto;">'; | ||
| − | var msg = 'Ooooops!! | + | var msg = 'Ooooops!! ErrorCode: ' + code; |
h2 = h2 + msg + '</h2>'; | h2 = h2 + msg + '</h2>'; | ||
document.body.style.background = 'rgb(1,133,174)'; | document.body.style.background = 'rgb(1,133,174)'; | ||
| Line 23: | Line 29: | ||
</client-config> | </client-config> | ||
</source> | </source> | ||
| − | * Line 6: | + | * Line 3, 6: The error code will be passed as a parameter, and you can take it for further use. |
| + | |||
| + | = Error Code = | ||
| + | The error code has 5 values: | ||
| + | # zk before mounting error | ||
| + | #: ZK client fails to proceed before mounting ZK javascript widgets. | ||
| + | # zk mounting error | ||
| + | #: ZK client fails during mounting ZK javascript widgets | ||
| + | # zk after mounting error | ||
| + | #: ZK client fails after mounting ZK javascript widgets. | ||
| + | # user script error | ||
| + | #: ZK client fails while running your custom javascript code | ||
| + | # server no response error | ||
=Version History= | =Version History= | ||
Latest revision as of 04:03, 19 December 2023
Syntax:
<init-crash-script>javascript function assigned to window.zkShowCrashMessage</init-crash-script>
[Default: see crashmsg.js]
Since 7.0.4
If the client engine stops working before even the error handling is initialized (e.g. when ZK's core scripts fail to download - zk.wpd), you will see the message below:
This element allows you to show a custom crash message when initiation by writing a javascript function which is assigned to window.zkShowCrashMessage.
For example,
<client-config>
<init-crash-script><![CDATA[
window.zkShowCrashMessage = function (code) {
var h2 = '<h2 style="background: rgb(1,133,174); text-align: center; '
+ 'color: white; width: 700px; margin: 0 auto;">';
var msg = 'Ooooops!! ErrorCode: ' + code;
h2 = h2 + msg + '</h2>';
document.body.style.background = 'rgb(1,133,174)';
document.body.innerHTML = h2;
}
]]></init-crash-script>
</client-config>
- Line 3, 6: The error code will be passed as a parameter, and you can take it for further use.
Error Code
The error code has 5 values:
- zk before mounting error
- ZK client fails to proceed before mounting ZK javascript widgets.
- zk mounting error
- ZK client fails during mounting ZK javascript widgets
- zk after mounting error
- ZK client fails after mounting ZK javascript widgets.
- user script error
- ZK client fails while running your custom javascript code
- server no response error
Version History
| Version | Date | Content |
|---|---|---|
| 7.0.4 | November, 2014 | ZK-2495: When ZK init page, the loading animation runs in a endless loop |