TabLeader$()

Syntax

TabLeader$(Pos)

Remarks

Returns the leader character of the custom tab stop at the position Pos, which is given in points (72 points = 1 inch). If more than one paragraph is selected, TabLeader$() evaluates the settings in the first paragraph.

There are three cases in which TabLeader$() returns an empty string (""): if there is no tab stop at the position Pos, if the tab stop is a default tab stop, or if the document is in outline view. If there is a custom tab stop at Pos, TabLeader$() returns one of the following values.

Value

Explanation

(space)

No leader (corresponds to a tab leader set to "None")

.

Period

-

Hyphen

_

Underscore


To change the tab leader, use FormatTabs.

Example

This example determines whether a tab stop at the three-fourths–inch position has an underscore leader character. If it does, the FormatTabs instruction changes the leader character to "None."


ViewNormal
If TabLeader$(54) = "_" Then
    FormatTabs .Position = "54 pt", .Leader = 0
End If

See Also

FormatTabs, NextTab(), PrevTab(), TabType()