npDesk plugin

npDeskCreate

This action creates a new instance of an Desk object. The result variable store the ID of the new Desk object. You can use this ID with other plugin actions.

↑↑

npDeskDestroy

This action destruct a previously created Desk object instance. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskDestroyAll

This action destruct all previously created Desk object instances.

↑↑

npDeskShow

This action show on screen a Desk object. You can determine here too the header text and the message text of the Desk object. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskClose

This action close a visible Desk object. The inmediatly variable determine if the alert window must be closed inmediatly or performing their animation. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskCloseAll

This action close all visibles Desk objects.

↑↑

npDeskStyle

Set the style options of a Desk object. You can determine the following options:

• doEndSteps Specifies the number of steps in the end animation sequence.
• doStartSteps Specifies the number of steps in the start animation sequence.
• doStartInterval Specifies the number of steps in the start animation.
• doMaxAlphaBlend Specifies the maximum alpha blend value of the window (0 to 255).
• doMinAlphaBlend Specifies the minimum alpha blend value of the window (0 to 255).
• doDisplayDuration Specifies how long the window is displayed after it is fully visible in milliseconds. Zero to no be close automatically.

The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskImage

Set the image icon of an Desk object instance. Supported formats are BMP, JPG, PNG and GIF. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskFonts

This action allow you to set a Desk object header text and message text fonts. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskColors

With this action you can determine the colors of a Desk object. All the colors can be provided in a NeoBook type: "R,G,B". The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskOptions

Set the options of a Desk object. You can determine the following options:

• doCanClick Specifies if the alert window allow the user to click in the message text.
• doCanMove Specifies if the alert window can be moved only by drag the mouse in the window caption.
• doCanMoveAny Specifies if the alert window can be moved by drag the mouse in all window point.
• doCanClose Specifies if the alert window can be closed by a close button.
• doAutoFocus Specifies whether the alert window automatically receives focus when shown.

The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskLocation

With this action you can specify the location on the screen of a Desk object. The options are self described. Do you? The only consideration is that if other position rather than "custom" is choosed, then the "Left" and "Top" options values are not taken. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npDeskIsVisible

Find if a Desk object is visible on the screen. The result variable store "True" if the Desk object is visible, or "False" if not. In this last case can be possible that an error occurr. The [LastError] variable contain information about the error.

↑↑

npOnDeskShow

Set a subroutine to be executed when a Desk object is show. The instance variable store the ID of the Desk object that has been show. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npOnDeskShown

Set a subroutine to be executed when a Desk object is shown. The instance variable store the ID of the Desk object that has been shown. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npOnDeskShowing

Set a subroutine to be executed when a Desk object is showing. The instance variable store the ID of the Desk object that has been showing. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npOnDeskClose

Set a subroutine to be executed when a Desk object is close. The instance variable store the ID of the Desk object that has been close. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npOnDeskClick

Set a subroutine to be executed when a Desk object message text is clicked. The instance variable store the ID of the Desk object that message text has clicked. The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

npOnDeskCloseClick

Set a subroutine to be executed when a Desk object close button is clicked. The instance variable store the ID of the Desk object that close button is clicked. With the "can close" variable you can determine if the Desk object is finally closed or not: just set this variable to "False" and the alert window still visible, set this variable to "True", or dont care about this, to allow to close the window.

The result variable store "True" if every is OK, or "False" if not, for example, because no instance is found with the provided ID. The [LastError] variable contain information about the error.

↑↑

Action errors subroutine

All the NeoPlugins deal with errors in the same way that NeoBook does: when the plugin found an action error the [LastError] variable store information about the error, so you can take care about this variable when execute an action.

But all the NeoPlugins also incorporate an advanced way to deal with possible action errors. You can define a subroutine named OnNeoPluginActionError in order to be executed when some action error are found and you can use this variables inside:

• [LastError] The last action error message.
• [PluginName] Store the plugin name which cause the error.

Note that this error handling subroutine are shared for all the NeoPlugins, so you no need to specify a subroutine for every plugin you use in your publication because the same subroutine are recognized and automagically used by every NeoPlugin. Below you can view a sample of this subroutine code:

:OnNeoPluginActionError
  AlertBox "NeoPlugin Error" "Error [LastError] in plugin: [PluginName]"
Return

Also note that the use of this NeoPlugins error handling subroutine is completelly optional. You can continue using the [LastError] variable as usual and even use the both methods at the same time.

↑↑