String Script API Type

Ben Tiedt — Tue, 26 Aug 2025 17:13:22 GMT

Current Revision posted to API Documentation by Ben Tiedt on 08/26/2025 17:13:22

Properties

Name	Access	Type	Description
Length	Read	`[[Number Script API Type\|Number]]`	Length

Methods

CompareTo

Velocity

#set($numberResponse = $string.CompareTo($strB))

JavaScript

var numberResponse = string.CompareTo(strB);

Parameters

Name	Type	Description	Required	Default	Options
strB	`[[String Script API Type\|String]]`	Str B	Required

Returns

[[Number Script API Type|Number]]

Contains

Velocity

#set($booleanResponse = $string.Contains($value))

JavaScript

var booleanResponse = string.Contains(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[String Script API Type\|String]]`	Value	Required

Returns

[[Boolean Script API Type|Boolean]]

EndsWith

Velocity

#set($booleanResponse = $string.EndsWith($value))

JavaScript

var booleanResponse = string.EndsWith(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[String Script API Type\|String]]`	Value	Required

Returns

[[Boolean Script API Type|Boolean]]

IndexOf

IndexOf Overload 1

Velocity

#set($numberResponse = $string.IndexOf($value))

JavaScript

var numberResponse = string.IndexOf(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[String Script API Type\|String]]`	Value	Required

IndexOf Overload 2

Velocity

#set($numberResponse = $string.IndexOf($value, $startIndex))

JavaScript

var numberResponse = string.IndexOf(value, startIndex);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[String Script API Type\|String]]`	Value	Required
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required

IndexOf Overload 3

Velocity

#set($numberResponse = $string.IndexOf($value, $startIndex, $count))

JavaScript

var numberResponse = string.IndexOf(value, startIndex, count);

Parameters

Name	Type	Description	Required
value	`[[String Script API Type\|String]]`	Value	Required
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required
count	`[[Number Script API Type\|Number]]`	Count	Required

Returns

[[Number Script API Type|Number]]

Insert

Velocity

#set($stringResponse = $string.Insert($startIndex, $value))

JavaScript

var stringResponse = string.Insert(startIndex, value);

Parameters

Name	Type	Description	Required	Default	Options
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required
value	`[[String Script API Type\|String]]`	Value	Required

Returns

[[String Script API Type|String]]

IsNormalized

Velocity

#set($booleanResponse = $string.IsNormalized())

JavaScript

var booleanResponse = string.IsNormalized();

Returns

[[Boolean Script API Type|Boolean]]

LastIndexOf

LastIndexOf Overload 1

Velocity

#set($numberResponse = $string.LastIndexOf($value))

JavaScript

var numberResponse = string.LastIndexOf(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[String Script API Type\|String]]`	Value	Required

LastIndexOf Overload 2

Velocity

#set($numberResponse = $string.LastIndexOf($value, $startIndex))

JavaScript

var numberResponse = string.LastIndexOf(value, startIndex);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[String Script API Type\|String]]`	Value	Required
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required

LastIndexOf Overload 3

Velocity

#set($numberResponse = $string.LastIndexOf($value, $startIndex, $count))

JavaScript

var numberResponse = string.LastIndexOf(value, startIndex, count);

Parameters

Name	Type	Description	Required
value	`[[String Script API Type\|String]]`	Value	Required
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required
count	`[[Number Script API Type\|Number]]`	Count	Required

Returns

[[Number Script API Type|Number]]

Normalize

Velocity

#set($stringResponse = $string.Normalize())

JavaScript

var stringResponse = string.Normalize();

Returns

[[String Script API Type|String]]

PadLeft

Velocity

#set($stringResponse = $string.PadLeft($totalWidth))

JavaScript

var stringResponse = string.PadLeft(totalWidth);

Parameters

Name	Type	Description	Required	Default	Options
totalWidth	`[[Number Script API Type\|Number]]`	Total Width	Required

Returns

[[String Script API Type|String]]

PadRight

Velocity

#set($stringResponse = $string.PadRight($totalWidth))

JavaScript

var stringResponse = string.PadRight(totalWidth);

Parameters

Name	Type	Description	Required	Default	Options
totalWidth	`[[Number Script API Type\|Number]]`	Total Width	Required

Returns

[[String Script API Type|String]]

Remove

Remove Overload 1

Velocity

#set($stringResponse = $string.Remove($startIndex, $count))

JavaScript

var stringResponse = string.Remove(startIndex, count);

Parameters

Name	Type	Description	Required	Default	Options
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required
count	`[[Number Script API Type\|Number]]`	Count	Required

Remove Overload 2

Velocity

#set($stringResponse = $string.Remove($startIndex))

JavaScript

var stringResponse = string.Remove(startIndex);

Parameters

Name	Type	Description	Required	Default	Options
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required

Returns

[[String Script API Type|String]]

Replace

Velocity

#set($stringResponse = $string.Replace($oldValue, $newValue))

JavaScript

var stringResponse = string.Replace(oldValue, newValue);

Parameters

Name	Type	Description	Required	Default	Options
oldValue	`[[String Script API Type\|String]]`	Old Value	Required
newValue	`[[String Script API Type\|String]]`	New Value	Required

Returns

[[String Script API Type|String]]

ReplaceLineEndings

ReplaceLineEndings Overload 1

Velocity

#set($stringResponse = $string.ReplaceLineEndings())

JavaScript

var stringResponse = string.ReplaceLineEndings();

ReplaceLineEndings Overload 2

Velocity

#set($stringResponse = $string.ReplaceLineEndings($replacementText))

JavaScript

var stringResponse = string.ReplaceLineEndings(replacementText);

Parameters

Name	Type	Description	Required	Default	Options
replacementText	`[[String Script API Type\|String]]`	Replacement Text	Required

Returns

[[String Script API Type|String]]

StartsWith

Velocity

#set($booleanResponse = $string.StartsWith($value))

JavaScript

var booleanResponse = string.StartsWith(value);

Parameters

Name	Type	Description	Required	Default	Options
value	`[[String Script API Type\|String]]`	Value	Required

Returns

[[Boolean Script API Type|Boolean]]

Substring

Substring Overload 1

Velocity

#set($stringResponse = $string.Substring($startIndex))

JavaScript

var stringResponse = string.Substring(startIndex);

Parameters

Name	Type	Description	Required	Default	Options
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required

Substring Overload 2

Velocity

#set($stringResponse = $string.Substring($startIndex, $length))

JavaScript

var stringResponse = string.Substring(startIndex, length);

Parameters

Name	Type	Description	Required	Default	Options
startIndex	`[[Number Script API Type\|Number]]`	Start Index	Required
length	`[[Number Script API Type\|Number]]`	Length	Required

Returns

[[String Script API Type|String]]

ToLower

Velocity

#set($stringResponse = $string.ToLower())

JavaScript

var stringResponse = string.ToLower();

Returns

[[String Script API Type|String]]

ToLowerInvariant

Velocity

#set($stringResponse = $string.ToLowerInvariant())

JavaScript

var stringResponse = string.ToLowerInvariant();

Returns

[[String Script API Type|String]]

ToString

Velocity

#set($stringResponse = $string.ToString())

JavaScript

var stringResponse = string.ToString();

Returns

[[String Script API Type|String]]

ToUpper

Velocity

#set($stringResponse = $string.ToUpper())

JavaScript

var stringResponse = string.ToUpper();

Returns

[[String Script API Type|String]]

ToUpperInvariant

Velocity

#set($stringResponse = $string.ToUpperInvariant())

JavaScript

var stringResponse = string.ToUpperInvariant();

Returns

[[String Script API Type|String]]

Trim

Velocity

#set($stringResponse = $string.Trim())

JavaScript

var stringResponse = string.Trim();

Returns

[[String Script API Type|String]]

TrimEnd

Velocity

#set($stringResponse = $string.TrimEnd())

JavaScript

var stringResponse = string.TrimEnd();

Returns

[[String Script API Type|String]]

TrimStart

Velocity

#set($stringResponse = $string.TrimStart())

JavaScript

var stringResponse = string.TrimStart();

Returns

[[String Script API Type|String]]