All Objects

ShowObject

Purpose:

Show a hidden object with an optional animated effect.

Category:

Objects

Syntax:

ShowObject "object name" "effect" "speed"

object name

The name of an existing object.

effect

One of the following:


None, Dissolve, Slide Left, Slide Right, Slide Up, Slide Down, Explode, Implode, Weave Horizontal, Weave Vertical, Split Horizontal, Split Vertical, Wipe Left, Wipe Right, Wipe Up, Wipe Down, Circle, Grow, Blocks, Checkerboard, Block Dissolve, Fade, Page Turn or Transparent. (Plug-ins are also available to add additional effects.)

speed

The effect’s speed (0 = fastest, 10 = slowest).

Example:

ShowObject "PushButton1" "Dissolve" "3"


HideObject

Purpose:

Hide an object with an optional animated effect.

Category:

Objects

Syntax:

HideObject "object name" "effect" "speed"

object name

The name of an existing object.

effect

One of the following:


None, Dissolve, Slide Left, Slide Right, Slide Up, Slide Down, Explode, Implode, Weave Horizontal, Weave Vertical, Split Horizontal, Split Vertical, Wipe Left, Wipe Right, Wipe Up, Wipe Down, Circle, Grow, Blocks, Checkerboard, Block Dissolve, Fade, Page Turn or Transparent. (Plug-ins are also available to add additional effects.)

speed

The effect’s speed (0 = fastest, 10 = slowest).

Example:

HideObject "PushButton1" "Dissolve" "3"


EnableObject

Purpose:

Enable an object. An enabled object can respond to mouse and keyboard events. Use in conjunction with DisableObject.

Category:

Objects

Syntax:

EnableObject "object name"

object name

The name of an existing object.

Example:

EnableObject "PushButton1"


DisableObject

Purpose:

Disable an object. Disabled objects ignore all mouse and keyboard events. Disabled objects appear shaded indicating to readers that they are not available for use.

Category:

Objects

Syntax:

DisableObject "object name"

object name

The name of an existing object.

Example:

DisableObject "PushButton1"


GetObjectInfo

Purpose:

Obtain information about an object such as its current size, position, visible state, etc. This is useful if you have changed the state of an object and you wish to determine its current condition.

Category:

Objects

Syntax:

GetObjectInfo "object name" "info type" "variable"

object name

The name of an existing object.

info type

One of the following: Visible, Enabled, Left, Top, Width, Height, FileName, SelectedText, CursorPosition, ImageWidth, ImageHeight, MediaLength, Caption, AbsLeft, AbsTop, FillColor, FillStyle, FillTransparent, LineColor, LineStyle, LineWidth, FontColor, FontName, FontSize, FontStyle, FontCharSet.


Note: Use Left and Top to obtain the object's position relative to its parent. If the object is attached to a Container then the position returned will be relative to the Container's upper left corner. If the object is on the page surface, then the position returned will be relative to the upper left corner of the publication window's client area. Use AbsLeft and AbsTop to obtain the object's position relative to the publication's window regardless of its parent.

variable

The name of the variable to store the requested information. If the info type is Visible or Enabled, the variable will contain either “True” or “False”. Left, Top, Width, Height, CursorPosition, ImageWidth, ImageHeight and MediaLength return numeric values. FileName, SelectedText and Caption return text.


Not all objects will respond to every type of information request. For example, FileName only works for objects that display files (Picture, Article, etc.). SelectedText can be used to copy highlighted from Text Entry or Article objects. CursorPosition returns the position of the cursor for Text Entry objects only. ImageWidth and ImageHeight only work with Picture objects. MediaLength is limited to Media Player and Flash Player objects.

Example:

GetObjectInfo "PushButton1" "Visible" "[Status]"

If "[Status]" "=" "False"

  Showobject "PushButton1" "Dissolve" "3"

EndIf


MoveObject

Purpose:

Change an object’s position on the screen.

Category:

Objects

Syntax:

MoveObject "object name" "x position " "y position"

object name

The name of an existing object.

x position, y position

The new left/top coordinates for the object. Coordinates are relative to the upper left corner of the publication window. If the object is attached to a container then the coordinates are relative to the container's upper left corner.

Example:

This example moves object Rectangle1 to the upper left corner of the publication:

MoveObject "Rectangle1" "5" "5"


MoveObjectAlongPath

Purpose:

Move an object along a predefined trajectory.

Category:

Objects

Syntax:

MoveObjectAlongPath "object name" "trajectory" "speed" "mode" "subroutine"

object name

The name of an existing object.

trajectory

The path that the object will follow as it moves. The trajectory contains a list of screen coordinates separated by commas. Coordinates must be listed in X/Y pairs. For example: “X1,Y1,X2,Y2,X3,Y3,etc.”. Coordinates are relative to the upper left corner of the publication’s window which is 0,0. If the object is attached to a container then the coordinates are relative to the container's upper left corner.

speed

The speed at which the objects moves along the trajectory. The actual speed is somewhat dependant on the speed of the readers computer and graphics card.

mode

One of the following:

Normal

Start the move and continue executing the current script.

Wait

Start the move and suspend VisualNEO for Windows until the move is complete.

Loop

Repeat the move continuously in the background.


Additionally, you may combine one of the choices above with:

Restore

Move the object back to its original location once the move is complete.

Center

Align the object's center along the trajectory. This is the default.

LeftTop

Align the object's upper-left corner along the trajectory.

subroutine (optional)

The name of a subroutine block to execute after the move is complete. (See App Properties > Actions for more information about subroutines.)

Example:

MoveObjectAlongPath "Picture1" "589,135,74,303,405,365" "10" "Normal+Restore+Center" ""


StopMovingObject

Purpose:

Stop a moving object. The object's movement must have been initiated with the MoveObjectAlongPath Action.

Category:

Objects

Syntax:

StopMovingObject "object name"

object name

The name of an existing object. Leave the object name blank to stop all moving objects.

Example:

StopMovingObject "Picture1"


SizeObject

Purpose:

Change the width and height of an object.

Category:

Objects

Syntax:

SizeObject "object name" "width" "height"

object name

The name of an existing object.

width, height

The object’s new width and height. Use “-1” to keep the object’s current dimensions.

Example:

SizeObject "Rectangle1" "150" "100"


ObjectToFront

Purpose:

Move an object to the foreground in front of all other objects on the page.

Category:

Objects

Syntax:

ObjectToFront "object name"

object name

The name of an existing object.

Example:

ObjectToFront "Picture1"


ObjectToBack

Purpose:

Move an object to the background behind all other objects on the page.

Category:

Objects

Syntax:

ObjectToBack "object name"

object name

The name of an existing object.

Example:

ObjectToBack "Picture1"


FocusObject

Purpose:

Set the keyboard input focus to a specific object. This Action is primarily used to activate Text Entry objects. Objects that don’t accept keyboard input are not affected by this Action.

Category:

Objects

Syntax:

FocusObject "object name"

object name

The name of an existing object.

Example:

FocusObject "TextEntry1"


RefreshObject

Purpose:

Update the contents of an object. Use this Action if the contents of an object change while your publication is running. Objects that don’t support refreshing will ignore this Action.

Category:

Objects

Syntax:

RefreshObject "object name"

object name

The name of an existing object.

Example:

RefreshObject "WebBrowser1"


GetObjectHandle

Purpose:

Get an object’s Windows Handle (HWND). This Action is intended primarily for use by Plug-In developers.

Category:

Objects

Syntax:

GetObjectHandle "object name" "variable"

object name

The name of an existing object.

variable

The name of the variable to store the object’s handle.

Example:

GetObjectHandle "ListBox1" "[Handle]"


SetObjectFill

Purpose:

Set an object's fill color and style.

Category:

Objects

Syntax:

SetObjectFill "object name" "fill color" "fill style" "transparent"

object name

The name of an existing object.

fill color

The fill color. See Defining Colors.

fill style

The desired fill style. Use “Solid” for an opaque object, “Hollow” for a transparent object, or a number between “2” and “48” to use one of VisualNEO for Windows’s built-in patterns.

transparent

If a fill pattern is selected above, use “True” to draw the pattern transparently, or “False” to draw it normally.

Example:

SetObjectFill "PushButton12" "248,192,160" "15" "False"


SetObjectLine

Purpose:

Set an object's line color, width and style.

Category:

Objects

Syntax:

SetObjectLine "object name" "color" "width" "style"

object name

The name of an existing object.

color

The line color. See Defining Colors.

width

The line width or 0 (zero) for none.

style

The line style. Use 0 (zero) for solid, or numbers 1 through 6 for other styles.

Example:

SetObjectLine "Rectangle1" "Red" "3" "0"


SetObjectFont

Purpose:

Set an object's font name, size and style. This only affects objects that have caption or text properties.

Category:

Objects

Syntax:

SetObjectFont "object name" "color" "name" "size" "style" "charset"

object name

The name of an existing object.

color

The font color. See Defining Colors.

name

The font name.

size

The size of the font in points.

style

The font style. This can be “Normal” or any combination of the following: Bold, Italic, Underline or Strikeout.

charset

The preferred character set for the font. The default setting is “DEFAULT_CHARSET”.

Example:

SetObjectFont "PushButton1" "Black" "Arial" "10" "Bold+Italic" "DEFAULT_CHARSET"


SetObjectCaption

Purpose:

Replace an object's caption text. This only affects objects that have caption properties.

Category:

Objects

Syntax:

SetObjectCaption "object name" "caption"

object name

The name of an existing object.

caption

The text to be assigned to the object’s caption.

Example:

SetObjectCaption "PushButton1" "Click Me"


SetObjectFileName

Purpose:

Set an object's file name. This only affects objects that have file name properties.

Category:

Objects

Syntax:

SetObjectFileName "object name" "file name"

object name

The name of an existing object.

file name

The name of the file to be loaded into the object.

Example:

SetObjectFileName "Picture1" "[PubDir]customer.jpg"



Animated GIF

GIFPlay

Purpose:

Begin playing an Animated GIF object. 

Category:

Objects

Syntax:

GIFPlay "object name" "loop count"

object name

The name of an existing Animated GIF object.

loop count

The number of times to repeat the animation sequence or 0 (zero) to play the animation continuously.

Example:

GIFPlay "AnimatedGif1" "0"


GIFStop

Purpose:

Stop a playing Animated GIF object.

Category:

Objects

Syntax:

GIFStop "object name"

object name

The name of an existing Animated GIF object.

Example:

GIFStop "AnimatedGIF1"



Media Player

MediaPlayerPlay

Purpose:

Play a media player object.

Category:

Objects

Syntax:

MediaPlayerPlay "object name"

object name

The name of an existing Media Player object.

Example:

MediaPlayerPlay "MediaPlayer1"


MediaPlayerStop

Purpose:

Stop a playing Media Player object.

Category:

Objects

Syntax:

MediaPlayerStop "object name"

object name

The name of an existing Media Player object.

Example:

MediaPlayerStop "MediaPlayer1"


MediaPlayerPause

Purpose:

Pause a playing Media Player object.

Category:

Objects

Syntax:

MediaPlayerPause "object name"

object name

The name of an existing Media Player object.

Example:

MediaPlayerPause "MediaPlayer1"


MediaPlayerRewind

Purpose:

Rewind a Media Player object.

Category:

Objects

Syntax:

MediaPlayerRewind "object name"

object name

The name of an existing Media Player object.

Example:

MediaPlayerRewind "MediaPlayer1"



Timer

TimerStart

Purpose:

Manually start a Timer object.

Category:

Objects

Syntax:

TimerStart "object name" "interval"

object name

The name of an existing Timer object.

interval

The number of milliseconds to wait before executing the Timer’s Action Event. A millisecond is one-thousandth of a second.

Example:

TimerStart "Timer1" "2000"


TimerStop

Purpose:

Manually deactivate an active Timer object.

Category:

Objects

Syntax:

TimerStop "object name"

object name

The name of an existing Timer object.

Example:

TimerStop "Timer1"



ListBox and ComboBox

ListBoxGetItem

Purpose:

Retrieve the text of an item in a List Box or Combo Box object.

Category:

Objects

Syntax:

ListBoxGetItem "object name" "line number" "variable"

object name

The name of an existing List Box or Combo Box object.

line number

The line number of the item to retrieve. The first item in the list is 1, the second item 2 and so on.
Use "all" instead of a number to retrieve all items.

variable

The name of the variable to store the item’s text.

Example:

ListBoxGetItem "ListBox1" "5" "[Result]"


ListBoxAddItem

Purpose:

Add an item to a List Box or Combo Box object.

Category:

Objects

Syntax:

ListBoxAddItem "object name" "line number" "item text"

object name

The name of an existing List Box or Combo Box object.

line number

The line number where the new item is to be inserted or 0 (zero) to append the item to the end of the list.

item text

The text of the item to be added.

Example:

ListBoxAddItem "ListBox1" "0" "George Washington"


ListBoxMoveItem

Purpose:

Move an item in a List Box or Combo Box object.

Category:

Objects

Syntax:

ListBoxMoveItem "object name" "source line" "destination line"

object name

The name of an existing List Box or Combo Box object..

source line

The line number of the item to move. The first item in the list is 1, the second item 2 and so on.

destination line

The line number of the item’s new position.

Example:

ListBoxMoveItem "ListBox1" "1" "5"


ListBoxDeleteItem

Purpose:

Remove an item from a List Box or Combo Box object.

Category:

Objects

Syntax:

ListBoxDeleteItem "object name" "line number"

object name

The name of an existing List Box or Combo Box object.

line number

The line number of the item to delete. The first item in the list is 1, the second item 2 and so on. All items after the deleted item will move up one. You can delete the entire list by using “All” instead of a specific line number.

Example:

ListBoxDeleteItem "ListBox1" "3"


ListBoxChangeItem

Purpose:

Modify an existing item in a List Box or Combo Box object.

Category:

Objects

Syntax:

ListBoxChangeItem "object name" "line number" "new item text"

object name

The name of an existing List Box or Combo Box object.

line number

The line number of the item to change. The first item in the list is 1, the second item 2 and so on.

new item text

The item’s new text.

Example:

ListBoxChangeItem "ListBox1" "3" "Abraham Lincoln"


ListBoxSize

Purpose:

Count the total number of items in a List Box or Combo Box object.

Category:

Objects

Syntax:

ListBoxSize "object name" "variable"

object name

The name of an existing List Box or Combo Box object.

variable

The name of the variable to store the list size.

Example:

ListBoxSize "ListBox1" "[Count]"

AlertBox "Info" "The list contains [Count] item(s)."


ListBoxFindItem

Purpose:

Search for an item in a List Box or Combo Box object.

Category:

Objects

Syntax:

ListBoxFindItem "object name" "item text" "variable"

object name

The name of an existing List Box or Combo Box object.

item text

The text of the item to find.

variable

The name of the variable to store the number of the found item. If no match is found, variable will contain 0 (zero).

Example:

The example below searches for a specific item and, if found, deletes the item:


ListBoxFindItem "ListBox1" "Herbert Hoover" "[Found]"

If "[Found]" ">" "0"

  ListBoxDeleteItem "ListBox1" "[Found]"

EndIf


ListBoxSort

Purpose:

Arrange the items in a List Box or Combo Box object in alphabetical order.

Category:

Objects

Syntax:

ListBoxSort "object name" "sort state"

object name

The name of an existing List Box or Combo Box object.

sort state

Specify “True” to turn the sort feature on, or “False” to turn it off.

Example:

ListBoxSort "ListBox1" "True"



TrackBar

TrackbarSetMax

Purpose:

Set the maximum range for a Track Bar object.

Category:

Objects

Syntax:

TrackBarSetMax "object name" "maximum value"

object name

The name of an existing Track Bar object.

maximum value

The value to assign as the Track Bar’s maximum range.

Example:

TrackBarSetMax "Trackbar1" "100"


TrackbarSetMin

Purpose:

Set the minimum range for a Track Bar object.

Category:

Objects

Syntax:

TrackBarSetMin "object name" "minimum value"

object name

The name of an existing Track Bar object.

maximum value

The value to assign as the Track Bar’s minimum range.

Example:

TrackBarSetMin "TrackBar1" "0"



Web Browser

BrowserGoTo

Purpose:

Display an HTML file or website in a Web Browser object.

Category:

Objects

Syntax:

BrowserGoTo "object name" "url or file name"

object name

The name of an existing Web Browser object.

url or file name

The address of a website or path to a local HTML file.

Example:

BrowserGoTo "WebBrowser1" "www.visualneo.com"


BrowserBack

Purpose:

Navigate to the previous item in a Web Browser’s navigation history.

Category:

Objects

Syntax:

BrowserBack "object name"

object name

The name of an existing Web Browser object.

Example:

BrowserBack "WebBrowser1"


BrowserForward

Purpose:

Navigate to the next item in a Web Browser’s navigation history.

Category:

Objects

Syntax:

BrowserForward "object name"

object name

The name of an existing Web Browser object.

Example:

BrowserForward "WebBrowser1"


BrowserHome

Purpose:

Display the system’s default home page in a Web Browser object.

Category:

Objects

Syntax:

BrowserHome "object name"

object name

The name of an existing Web Browser object.

Example:

BrowserHome "WebBrowser1"


BrowserSearch

Purpose:

Display the system’s default search site in a Web Browser object.

Category:

Objects

Syntax:

BrowserSearch "object name"

object name

The name of an existing Web Browser object.

Example:

BrowserSearch "WebBrowser1"


BrowserPrint

Purpose:

Print the page currently displayed in a Web Browser object.

Category:

Objects

Syntax:

BrowserPrint "object name" "options"

object name

The name of an existing Web Browser object.

options

Use "PrintPreview" to preview the page prior to printing or leave this parameter blank to skip the preview.

Example:

BrowserPrint "WebBrowser1"


Note: If the Web Browser’s Silent Mode is disabled, the BrowserPrint Action will display the Windows Print screen before printing. When Silent Mode is on, the document will print immediately without showing the Print screen. See The Tool Palette for information on configuring Web Browser properties.


BrowserStop

Purpose:

Cancel a Web Browser object’s pending navigation or download.

Category:

Objects

Syntax:

BrowserStop "object name"

object name

The name of an existing Web Browser object.

Example:

BrowserStop "WebBrowser1"


BrowserExport

Purpose:

Copy the contents of a Web Browser object to a variable.

Category:

Objects

Syntax:

BrowserExport "object name" "variable"

object name

The name of an existing Web Browser object.

variable

The name of the variable to store the HTML code.

Example:

BrowserExport "WebBrowser1" "[Code]"


BrowserFind

Purpose:

Display a Find dialog box and allow the reader to search for text within a Web Browser object.

Category:

Objects

Syntax:

BrowserFind "object name"

object name

The name of an existing Web Browser object.

Example:

BrowserFind "WebBrowser1"


BrowserLoadFromStr

Purpose:

Manually load HTML source code into a Web Browser object.

Category:

Objects

Syntax:

BrowserLoadFromStr "object name" "code"

object name

The name of an existing Web Browser object.

code

The HTML code to display in the Web Browser object.

Example:

BrowserLoadFromStr "WebBrowser1" "<html>....</html>"


BrowserExecScript

Purpose:

Execute Java or VB scripts inside a Web Browser object. This action requires that the Internet Security/Active Scripting option be enabled. See also: Passing Information Between the Browser and VisualNEO for Windows.

Category:

Objects

Syntax:

BrowserExecScript "object name" "script code" "script language"

object name

The name of an existing Web Browser object.

script code

This is the actual written in the scripting language specified below.

script language

One of the following:

JavaScript
JScript
VBScript

Example:

The following action will replace the contents of the object WebBowser1 with "Hello from VisualNEO for Windows!":


BrowserExecScript "WebBrowser1" "text=[#34]Hello from VisualNEO for Windows![#34];|document.write(text);" "JavaScript"


BrowserGetElement

Purpose:

Copy the contents of an HTML-based element to a VisualNEO for Windows variable. This action can be used to retrieve information from web-based forms. See also: Passing Information Between the Browser and VisualNEO for Windows.

Category:

Objects

Syntax:

BrowserGetElement "object name" "element name" "variable"

object name

The name of an existing Web Browser object.

element name

This is the name of the HTML element. Optionally, the element name may also include the name of the frame and/or form the element belongs to. If the element name includes a frame, separate the frame and the element name with a period. If the element name includes a form, separate the form and the element name with a colon. For example:


HTML element only:


  "Element"


frame+element:


  "Frame.Element"


form+element:


  "Form:Element"


frame+form+element:


  "Frame.Form:Element"


variable

The name of the VisualNEO for Windows variable to store the returned data.

Example:

The following will copy the contents of the HTML Text Box FirstName from WebBrowser1 to the VisualNEO for Windows variable [Name]:


BrowserGetElement "WebBrowser1" "FirstName" "[Name]"


BrowserSetElement

Purpose:

Set the contents of an HTML-based element. This action can be used to fill in web-based forms. See also: Passing Information Between the Browser and VisualNEO for Windows.

Category:

Objects

Syntax:

BrowserSetElement "object name" "element name" "data"

object name

The name of an existing Web Browser object.

element name

This is the name of the HTML element to set. Optionally, the element name may also include the name of the frame and/or form the element belongs to. If the element name includes a frame, separate the frame and the element name with a period. If the element name includes a form, separate the form and the element name with a colon. For example:


HTML element only:


  "Element"


frame+element:


  "Frame.Element"


form+element:


  "Form:Element"


frame+form+element:


  "Frame.Form:Element"

data

The data to be stored in the HTML element.

Example:

The following will set the contents of the HTML Text Box FirstName to "Joe":


BrowserSetElement "WebBrowser1" "FirstName" "Joe"



Article and Linked-Article

ArticleJumpTo

Purpose:

Jump to a bookmark in an Article or Linked-Article object.

Category:

Objects

Syntax:

ArticleJumpTo "object name" "bookmark name"

object name

The name of an Article or Linked-Article object.

bookmark name

The bookmark name as created in the Text Editor.

Example:

ArticleJumpTo "Article1" "Top"



Picture

PictureMagnify

Purpose:

Change the magnification/zoom level of a Picture object.

Category:

Objects

Syntax:

PictureMagnify "object name" "magnification percentage"

object name

The name of an existing Picture object.

magnification percentage

To view a picture in its normal resolution use “100” To increase the magnification, enter a number greater than 100. Numbers smaller than 100 will reduce the picture’s size. The magnification level only affects how the picture is displayed on screen. The original image file is not altered.

Example:

The following example displays an image twice its normal size:


PictureMagnify "Picture1" "200"



Flash Player

FlashPlay

Purpose:

Begin playing a Flash object.

Category:

Objects

Syntax:

FlashPlay "object name" "mode"

object name

The name of an existing Flash Player object.

mode

Leave this parameter blank to play normally or use “Loop” to play the file repeatedly.

Example:

FlashPlay "Flash1" "Loop"


FlashPause

Purpose:

Pause a playing Flash object. If object is already paused, then the Flash file will start playing from the current frame.

Category:

Objects

Syntax:

FlashPause "object name"

object name

The name of an existing Flash Player object.

Example:

FlashPause "Flash1"


FlashStop

Purpose:

Stop a playing Flash object.

Category:

Objects

Syntax:

FlashStop "object name"

object name

The name of an existing Flash Player object.

Example:

FlashStop "Flash1"


FlashRewind

Purpose:

Rewind a Flash object.

Category:

Objects

Syntax:

FlashRewind "object name"

object name

The name of an existing Flash Player object.

Example:

FlashRewind "Flash1"


FlashGotoFrame

Purpose:

Jump to a specific frame in a Flash object.

Category:

Objects

Syntax:

FlashGotoFrame "object name" "frame"

object name

The name of an existing Flash Player object.

frame

The number of the frame to display.

Example:

FlashGotoFrame "Flash1" "10"


FlashForward

Purpose:

Move a Flash object ahead one frame.

Category:

Objects

Syntax:

FlashForward "object name"

object name

The name of an existing Flash Player object.

Example:

FlashForward "Flash1"


FlashBack

Purpose:

Move a Flash object back one frame.

Category:

Objects

Syntax:

FlashBack "object name"

object name

The name of an existing Flash Player object.

Example:

FlashBack "Flash1"


FlashGetVar

Purpose:

Copy a Flash variable to a VisualNEO for Windows variable.

Category:

Objects

Syntax:

FlashGetVar "object name" "flash variable" "VisualNEO for Windows variable"

object name

The name of an existing Flash Player object.

flash variable

The name of the Flash variable to copy.

VisualNEO for Windows variable

The name of the VisualNEO for Windows variable to store the Flash data.

Example:

FlashGetVar "Flash1" "Counter" "[Result]"


FlashSetVar

Purpose:

Set a Flash object variable.

Category:

Objects

Syntax:

FlashSetVar "object name" "flash variable" "value"

object name

The name of an existing Flash Player object.

flash variable

The name of the Flash variable to copy.

value

The value to assign to the Flash variable.

Example:

FlashSetVar "Flash1" "Counter" "50"