Text.PadStr(Text, Integer [, Text]) Method

Artículo
02/26/2024

Version: Available or changed with runtime version 1.0.

Changes the length of a string to a specified length. If the string is shorter than the specified length, length spaces are added at the end of the string to match the length. If the string is longer than the specified length, the string is truncated. If the specified length is less than 0, an exception is thrown.

Syntax

NewString :=   Text.PadStr(String: Text, Length: Integer [, FillCharacter: Text])

Note

This method can be invoked without specifying the data type name.

Parameters

String
Type: Text
The string that you want to increase or decrease.

Length
Type: Integer
The new length of the output string. If Length is less than the length of String, then String is truncated. Otherwise String is expanded with filler characters. If Length is less than 0, then an error is returned.

[Optional] FillCharacter
Type: Text
This is a string of length 1. This character is used to fill empty spaces at the end of the output string. If not specified, spaces are used as default. If the length of FillCharacter is not 1, an error is returned.

Return Value

NewString
Type: Text
A copy of the string with the expected length.

Remarks

If you omit FillCharacter and String is shorter than Length, then spaces are added at the end of String to match Length.

If you omit FillCharacter and String is longer than Length, then String is truncated.

Example

var
    Str1: Text[30];
    Str2: Text[30];
    Len1: Integer;
    Len2: Integer;
    Text000: Label '13 characters';
    Text001: Label 'Four';
    Text002: Label 'Before PadStr is called:\\';
    Text003: Label '>%1< has the length %2\\';
    Text004: Label '>%3< has the length %4\\';  
    Text005: Label 'After PadStr is called:\\';    
begin
    Str1 := Text000;  
    Str2 := Text001;  
    Len1 := StrLen(Str1);  
    Len2 := StrLen(Str2);  
    Message(Text002 + Text003 + Text004, Str1, Len1, Str2, Len2);  
    Str1 := PadStr(Str1, 5); // Truncate the length to 5  
    Str2 := PadStr(Str2, 15, 'w'); // Concatenate w until length = 15  
    Len1 := StrLen(Str1);  
    Len2 := StrLen(Str2);  
    Message(Text005 + Text003 + Text004, Str1, Len1, Str2, Len2);  
end;

The first message window displays the following:

Before PadStr is called:

>13 characters< has the length 13

>Four< has the length 4

The second message window displays the following:

After PadStr is called:

>13 ch< has the length 5

>Fourwwwwwwwwwww< has the length 15