PadOrTruncate.ps1
19 Sep 2025Description
Purpose
Pad or truncate a string to a specified length.
Detailed Description
This function takes a string and a length as input parameters.
-
If the length of the string is less than or equal to the specified length, it pads the string with spaces (or a specified character) on the right side to make it equal to the specified length.
-
If the length of the string is greater than the specified length, it truncates the string and appends “…” (or a specified truncation indicator) at the end.
Usage
Example 1
PadOrTruncate -s "Hello, world!" -length 15
Output: “Hello, world! “
Example 2
PadOrTruncate -s "Hello, world!" -length 10
Output: “Hello, wo…”
Example 3
PadOrTruncate -s "Hello, world!" -length 20 -PaddingChar "-"
Output: “Hello, world!——-“
Example 4
PadOrTruncate -s "Hello, world!" -length 10 -TruncationIndicator ">>>"
Output: “Hello, w»>”
Notes
No additional notes.
Script
<#
.SYNOPSIS
Pad or truncate a string to a specified length.
.DESCRIPTION
This function takes a string and a length as input parameters.
- If the length of the string is less than or equal to the specified length, it pads the string with spaces (or a specified character) on the right side to make it equal to the specified length.
- If the length of the string is greater than the specified length, it truncates the string and appends "..." (or a specified truncation indicator) at the end.
.PARAMETER s
The input string to be padded or truncated.
.PARAMETER length
The desired length of the string.
.PARAMETER PaddingChar
The character to use for padding the string. Defaults to a space.
.PARAMETER TruncationIndicator
The string to use to indicate truncation. Defaults to "...".
.OUTPUTS
System.String
.EXAMPLE
PadOrTruncate -s "Hello, world!" -length 15
# Output: "Hello, world! "
.EXAMPLE
PadOrTruncate -s "Hello, world!" -length 10
# Output: "Hello, wo..."
.EXAMPLE
PadOrTruncate -s "Hello, world!" -length 20 -PaddingChar "-"
# Output: "Hello, world!-------"
.EXAMPLE
PadOrTruncate -s "Hello, world!" -length 10 -TruncationIndicator ">>>"
# Output: "Hello, w>>>"
#>
function PadOrTruncate {
[CmdletBinding()]
param (
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[string]$s,
[Parameter(Mandatory = $true)]
[ValidateRange(1, [int]::MaxValue)]
[int]$length,
[Parameter(Mandatory = $false)]
[ValidateLength(1, 1)]
[char]$PaddingChar = ' ',
[Parameter(Mandatory = $false)]
[string]$TruncationIndicator = '...'
)
begin {
# Calculate the max length of the string before truncation indicator
$maxLengthBeforeTruncation = $length - $TruncationIndicator.Length
}
process {
if ($s.Length -le $length) {
# Pad the string if it is shorter than or equal to the specified length
$result = $s.PadRight($length, $PaddingChar)
}
else {
# Truncate the string and append the truncation indicator if it is longer than the specified length
$truncated = $s.Substring(0, $maxLengthBeforeTruncation)
$result = "$truncated$TruncationIndicator"
}
# Output the result
return $result
}
}
Download
Please feel free to copy parts of the script or if you would like to download the entire script, simply click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.
Report Issues
You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.