of_addtouritem

Description:

Adds a stop of the feature tour. All tour items correspond to a control on your screen.

Syntax:

of_addtouritem (graphicobject atarget, integer aposition, string acontent)
of_addtouritem (graphicobject atarget, integer aposition, string acontent, string acolor)
of_addtouritem (graphicobject atarget, integer aposition, string acontent, featuretouroffset apositionoffset)
of_addtouritem (graphicobject atarget, integer aposition, string acontent, string acolor, featuretouroffset apositionoffset)

Argument	Description
atarget	A reference to a PowerBuilder object. This can be anything from a window, button, datawindow, treeview, listview, etc. Make sure the control is valid and visible to the user.
aposition	The position of the call out (bubble text) in relation to the target: Left, Right, Top, Bottom
acontent	The text to display in the call out (bubble).
acolor (optional)	The color of the call out. Use one of the pre-defined colors: "BLUE", "OLIVE", "SILVER", "BLACK", "CLASSIC", "PINK", "DEEPBLUE", "PURPLE", "GREEN", "ORANGE", "RED"
apositionoffset (optional)	The offset value of the tour reveal. More details below.

Left, Right, Top, and Bottom are constants on the n_cst_featuretour object.

Return Value:

Always returns 1.

Usage:

By default, the control passed in the aTarget parameter will be highlighted when the tour item displays. You can display a portion of that control by using an offset.

//Use the FeatureTourOffset struction to define coordinates for the reveal (the part of the tour that appears highlighted
FeatureTourOffset fto

fto.Y = 22 //pixel value relative to the top of your control

fto.X = 399 //pixel value relative to the left of your control

fto.Width = 80 //the width of the reveal

fto.Height = 98 //the height of the reveal

lnv_tour.of_AddTourItem(uo_ribbon, lnv_tour.Bottom, "PowerSnip lets you take screenshots of your application, directly in your application. This is a great tool for trouble shooting issues.", fto)

Full list of colors:

	Blue
	Black
	Olive
	Silver
	Classic
	Amber
	Cobalt
	Crimson
	Emerald
	Indigo
	Magenta
	Mauve
	Orange
	Pink
	Purple
	Red
	Teal
	Violet

See example below:

The outer red rectangle is the uo_ribbon control. The revealed part is based on the above offset.