Function Illustrate Values Class

RulerString

Return a string containing a "ruler" of length vLength with style vStyle. Similar to using the RulerStringWithTabStops function with vTabStop set to 0 (zero).

Signature (Visual Basic / VBA)

Public Function RulerString( _
      ByVal vLength As Variant _
    , Optional ByVal vStyle As Variant _
    ) As Variant

Code Example

    ? RulerString(30, 1)
    123456789012345678901234567890
    ? RulerString(30, 2)
    000000000111111111122222222223
    123456789012345678901234567890
    ? RulerString(30, 3)
    000000000000000000000000000000
    000000000111111111122222222223
    123456789012345678901234567890
    ? RulerString(30, 4)
    ----+----|----+----|----+----|
    ? RulerString(30, 5)
        5    10   15   20   25   3
    ----+----|----+----|----+----|

Parameters

Parameter Description
vLength The length of each line with the "ruler" string to be created. Function returns Null if vLength is Null or cannot be fixed up to a number.
vStyle A number describing the style of the ruler string to be created. vStyle defaults to 3 (three) if it is missing or Null or cannot be fixed up to a number. Function returns an empty string if the style is not a number between 1 and 5.