Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter Five — General Functions (continued)

TrimPaddingEntities Function

Overview

The TrimPaddingEntities function trims the white spaces and HTML/XML spacing character entities from both the left and right side of a string.

Syntax/Parameters

Syntax

string  = TrimPaddingEntities ( string data );

Parameters

data

A string specifying the source data to be trimmed.

Return Value

Returns a string containing data trimmed or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The following white space characters will be trimmed:

  Decimal   Hexadecimal   Escape Code   Description  
  32   0x20   —   Space  
  8   0x08   \b   Backspace  
  9   0x09   \t   Horizontal tab  
  10   0x0A   \n   New line  
  12   0x0C   \f   Form feed  
  13   0x0D   \r   Carriage return  

 

In addition, the following entities are also treated as spaces:

          &#a0;   Non Breaking Space  
      —   —   Non Breaking Space  
              En Space  
              Em Space  
              Em 1/3 Space  
              Em 1/4 Space  
              Figure Space  
              Punctuation Space  
              Thin Space  
      —   —   Thin Space  
              Hair Space  
      —   —   Hair Space  
  ​   ​   ​   Zero Width Space  
  ​   —   —   Zero Width Space  
  ​   —   —   Zero Width Space  
  ​   —   —   Zero Width Space  
  ​   —   —   Zero Width Space  
  —           Non-breaking Fixed Space  
              Medium Mathematical Space  

The size of the returned string can be retrieved by using the GetLastError function. This can reduce processing time for exceptionally large strings.

Related Functions

GetTrimmedStringLength — Gets the length or size of a string as if it were trimmed for spaces.

PadString — Pads a string to a specified size with optional fill string and direction.

TrimString — Trims the trailing spaces from the right side (end) of a string.

Platform Support

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

Legato IDE, Legato Basic

 

GoFiler Legato Script Reference — Generated on 04/22/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.