Skip to main content

Text.StartsWith

Indicates whether the text starts with a specified value.

Syntax​

Text.StartsWith(
    text as text,
    substring as text,
    optional comparer as function
) as logical

Remarks​

Returns true if text value text starts with text value substring.

  • text: A text value which is to be searched.
  • substring: A text value which is the substring to be searched for in text.
  • comparer: (Optional) A Comparer used for controlling the comparison. For example, Comparer.OrdinalIgnoreCase may be used to perform case-insensitive searches.

comparer is a Comparer which is used to control the comparison. Comparers can be used to provide case-insensitive or culture and locale-aware comparisons.

The following built-in comparers are available in the formula language:

  • Comparer.Ordinal: Used to perform an exact ordinal comparison.
  • Comparer.OrdinalIgnoreCase: Used to perform an exact ordinal case-insensitive comparison.
  • Comparer.FromCulture: Used to perform a culture-aware comparison.

Examples​

Example #1​

Check if the text "Hello, World" starts with the text "hello".

Text.StartsWith("Hello, World", "hello")

Result:

false

Example #2​

Check if the text "Hello, World" starts with the text "Hello".

Text.StartsWith("Hello, World", "Hello")

Result:

true

Example #3​

Ignoring case, check if the text "Hello, World" starts with the text "hello".

Text.StartsWith("Hello, World", "hello", Comparer.OrdinalIgnoreCase)

Result:

true

Category​

Text.Membership