Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

GetLeaderFillPosition Function

Overview

The GetLeaderFillPosition function locates the starting position of a leader (including spaces).

Syntax/Parameters

Syntax

int = GetLeaderFillPosition ( string data );

Parameters

data

A string containing text and a leader.

Return Value

Returns an int as the first zero-based position of the left side of the leader or -1 if the parameter does not contain a leader. This function does not set the last error code.

Remarks

Leaders are the fill after a string, such as a table stub, for example:

Current assets
  Cash and cash equivalents.......................     $  9,478   $  3,697
  Accounts receivable, net........................       18,191     24,301
  Inventories     ................................       99,384    103,743
  Prepaid expenses................................       11,635     11,569
  Other current assets............................        4,592      6,436
                                                       --------   --------
      Total current assets........................      143,280    149,746

The string must end with the leader so in the above example, the numbers are removed.

The GetLeaderFillPosition function checks for both dot (‘.’) and ellipse (‘…’) leader fill. There is UNICODE support for ellipse leader fill characters.  Dot leader fill must contain at least three periods to be considered leader fill. A dot leader fill may also contain spaces but only one space can exist between two dots (“. . . . . .”).

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic