Template:APIBreadcrumb/documentation

=Template Documentation= This template creates a breadcrumb link in the Synthesis API Reference Documentation pages. It is meant to resemble the navigation element found in VBA and VB.NET's Object Browser window.

This template helps readers navigate the API object library by inserting links to the parent items of an API call, thereby showing the call's place in the hierarchy. In this hierarchy, the API object library itself is the top-level item and is therefore level 0. Classes and enums are at level 1, and methods and properties, as well as sub classes, are at level 2, and so on.

Usage
This template has four optional parameters. The structure is as follows:

where LINK1, LINK2, etc. are the parameters. You must add a period before each link.

Each parameter corresponds to a sub level in the API object library hierarchy. This means that LINK1 is the link to the level 1 item, LINK2 is the link to the level 2 item, and so on.

Example 1
The following code example shows the breadcumb link for a level 1 call. Because the parent item is the API object library itself, the template omits all parameters.

The output of this code shows the level 0 parent item, as follows:

Example 2
The following code example shows the breadcrumb link for a level 2 call. In this case, the template populates the first parameter by adding a link to the call's parent item.

The output of this code shows the level 0 and level 1 parent items, separated by a period: