of_addLink

Description

Adds a link item to the XPListBar under the indicated group.

Syntax

of_addLink(String group, String text, {String image}, {String toolTip})
of_addLink(Long group, String text, {String image}, {String toolTip})

Parameter(s)

Name Type Description
group String or Long The group index or name to which a link is to be added. The name of the group is the name the programmer gave when of_addGroup was called or when of_setText was last called. The group index is the same as the value returned when of_addGroup was called.
text String The text of the link to be added.
image String The name of the image file to be displayed for the link. This parameter is optional and has no default value. The valid fileTypes are GIF, PNG, JPG, BMP, WMF and RLE. Support for PB internal pictures has been added, i.e. Open!, Comment!, etc.
toolTip String The text to be used when displaying the link's toolTip. This parameter is optional and defaults to the link's text

Return Value

Returns a long containing the index assigned of the link.

Usage

When using this method, links are added sequentially to the indicated group.

A link differs from a label only in the presentation on the XPListBar. A link is underlined as the cursor moves over the item.

Examples

Long                   ll_group
ll_group               = of_addGroup('File', '', '')

of_addLabel(ll_group, 'Open', 'Open!', 'Open File')
of_addLabel('File', 'Save', 'Save!')

of_addSeparator('File')

of_addLink(ll_group, 'Preview', 'Preview!', 'Preview File')
of_addLink('File', 'Print', 'Print!')


Cannot resolve image macro, invalid image name or id.

See Also

Last edited Sep 24, 2016 at 3:53 PM by cjharris02892, version 6