npZoom plugin

About this plugin

This NeoBook plugin allow you to put Zoom objects attached to rectangles on your publications. This Zoom objects can magnify the screen image under the user cursor. You can customize every Zoom objects in various ways.

You can put every Zoom objects you needs, and, since this objects are placed on NeoBook rectangles, you can use the Zoom objects in a Custom Window, in a Dialog Window or just any place on your publication pages.

Thirparty

This plugin are imposible without the aid of this people:

Thanks a lot!

Plugin actions index

npZoomCreate

Create a new instance of a Zoom object and attach it to a NeoBook rectangle object. You need to specify the Rectangle name (or a variable that contain these name) that you wanted to attach a Zoom object. The result variable store "True" if everthing is OK, or "False" if an error ocurr. In this case the [LastError] variable contain information about the possible error.

↑↑

npZoomDestroy

Destroy a previously Zoom object instance and deattach from their NeoBook rectangle. You need to specify the rentangle name in wich the Zoom object is attached. The result variable store "True" if everthing is OK, or "False" if an error ocurr. In this case the [LastError] variable contain information about the possible error.

↑↑

npZoomDestroyAll

Destroy all previously Zoom objects instances and deattach from their NeoBook rectangles.

↑↑

npZoomOptions

Set various options of a Zoom object instance. With this action you can active, deactive, and set various options of a particular Zoom object, identified with the host rectangle name. Here is the list of options and possible values that you can set with this action:

The result variable store "True" if everthing is OK, or "False" if an error ocurr. In this case the [LastError] variable contain information about the possible error.

↑↑

npZoomIsActive

Find if a particular Zoom object instance are active or not. The result variable store "True" if the zoom object is active, or "False" if not. Also can store "False" if an error ocurr. In this case the [LastError] variable contain information about the possible error.

↑↑

npOnZoomClick

Set a publication subroutine to be executed when the user click an specific Zoom object. The rectangle variable store the Zoom host rectangle object name, in wich the click ocurr. Using this variable you can use the same subroutine with more than one Zoom object. The result variable store "True" if everthing is OK, or "False" if an error ocurr. In this case the [LastError] variable contain information about the possible error.

↑↑

npOnZoomDblClick

Set a publication subroutine to be executed when the user double click an specific Zoom object. The rectangle variable store the Zoom host rectangle object name, in wich the click ocurr. Using this variable you can use the same subroutine with more than one Zoom object. The result variable store "True" if everthing is OK, or "False" if an error ocurr. In this case the [LastError] variable contain information about the possible 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:

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.

↑↑