Public Class BaliStrings

Methods Detail

• alphanumericOnly

  Public Function alphanumericOnly(source As String) As String
  Removes all non-alphanumeric (a-z, A-Z, 0-9) characters from String
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which to remove non-alphanumeric characters

• ampersandDecode

  Public Function ampersandDecode(source As String) As String
  Replaces ampersand sequences in a string with special characters (quote, apostrophe, less than, greater than, ampersand, etc)
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to decode

• ampersandEncode

  Public Function ampersandEncode(source As String) As String
  Replaces special characters (quote, apostrophe, less than, greater than, ampersand, etc) in a string with ampersand sequences
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to encode

• asciiFilterByRange

  Public Function asciiFilterByRange(source As String, ranges As Variant) As String
  Removes all non-allowed characters from a string
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which to remove non-allowed characters
  2	ranges	Variant		IntegerPair, List As IntegerPair, or Array of IntegerPair objects. ascii range(s) definining the allowed characters.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_INVALID	1195	if ranges is not an IntegerPair, a List As IntegerPair, nor an Array of IntegerPair objects.

• beginsWith

  Public Function beginsWith(source As String, searchfor As String) As Boolean
  Tests a string to determine if it begins with another string
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to test
  2	searchfor	String		Substring to check if source string begins with

• condcat

  Public Function condcat(string1 As String, string2 As String, delimiter As String) As String
  Conditionally Concatenates two strings with a delimiter
  idx	Argument	Data Type	Attributes	Comments
  1	string1	String		First string for the concatenation
  2	string2	String		Second string for the concatenation
  3	delimiter	String		String used to conditionally concatenate string1 and string2

• endsWith

  Public Function endsWith(source As String, searchfor As String) As Boolean
  Tests a string to determine if it ends with another string
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to test
  2	searchfor	String		Substring to check if source string ends with

• escapeSingleBackslashes

  Public Function escapeSingleBackslashes(source As String) As String
  Parses a source string and replaces and single backslash characters (\) with escaped backslashes (\\)
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to search for single backslash characters

• fieldnamefy

  Public Function fieldnamefy(source As String) As String
  Removes all non "fieldnamey" characters from String "Fieldname" characters are (a-z, A-Z, 0-9, _)
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which to remove non-fieldnamey characters

• filenameify

  Public Function filenameify(source As String) As String
  Removes all non "filenamey" (a-z, A-Z, 0-9, _, -, .) characters from String
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which to remove non-filenamey characters

• getAlphanumericRanges

  Public Function getAlphanumericRanges() As Variant
  Gets a List of alphanumeric ASCII ranges

• getFieldNameyRanges

  Public Function getFieldNameyRanges() As Variant
  Gets a List of fieldnamey ASCII ranges

• getFilenameyRanges

  Public Function getFilenameyRanges() As Variant
  Gets a List of filenamey ASCII ranges

• getScalarString

  Public Function getScalarString(source As Variant) As String
  Gets the scalar value of an object as a string
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		variant from which to get the scalar value

• hasMoustacheTags

  Public Function hasMoustacheTags(source As String) As Boolean
  Tests a string to determine if it has one or more moustache tags. Note: a moustache tag is any substring that follows the pattern {{substring}}
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to check

• isStringArrayEmpty

  Public Function isStringArrayEmpty(source As Variant) As BaliStrings
  Tests a String array to determine if it is empty. Empty is defined as having no elements, or all elements are blank
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		String array to test

• padLeft

  Public Function padLeft(source As String, length As Integer) As String
  Conditionally pads a source string with leading blank spaces.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to be padded
  2	length	Integer		Requested Length of the resulting string

• properCase

  Public Function properCase(source As String) As String
  Converts a source string to Proper Case
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to be converted to Proper Case

• replaceCRLF

  Public Function replaceCRLF(source As String, replacement As String) As String
  Replaces Carriage Returns and Line Feeds in a string with a new string and returns a new string.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which Carriage Returns and Line Feeds should be removed.
  2	replacement	String		New string to replace all Carriage Returns and Line Feeds.

• replaceHT

  Public Function replaceHT(source As String, replacement As String) As String
  Replaces Horizontal Tabs in a string with a new string and returns a new string.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which Horizontal Tabs should be removed.
  2	replacement	String		New string to replace all Tabs

• replaceSubstring

  Public Function replaceSubstring(source As String, searchfor As String, replacewith As String) As String
  Replaces a substring with another string and returns the result
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String within which to search
  2	searchfor	String		String to search for within source
  3	replacewith	String		String used to replace all instances of searchfor

• stripCRLF

  Public Function stripCRLF(source As String) As String
  Strips Carriage Returns and Line Feeds from a string and returns the result as a new string. NOTE: This is a convenience wrapper for replaceCRLF(source$, ||)
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which Carriage Returns and Line Feeds should be removed.

• stripFirstSubstr

  Public Function stripFirstSubstr(source As String, searchfor As String) As String
  Strips the first substring from a string and returns the result
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String within which to search
  2	searchfor	String		String to search for within source

• stripHT

  Public Function stripHT(source As String) As String
  Strips Tabs from a string and returns the result as a new string. NOTE: This is a convenience wrapper for replaceHT(source$, ||)
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which Tabs should be removed.

• stripHTML

  Public Function stripHTML(source As String, stripOrphans As Boolean) As String
  Replaces all html tags from a string
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String within which to search
  2	stripOrphans	Boolean		Flag indicating if Orphan HTML tags should also be stripped

• New

  Public Sub New()

• shellSortStrings

  Public Sub shellSortStrings(source As Variant)
  Performs a "divide and conquer" sort of a String Array, based on an insertion sort algorithm.
  idx	Argument	Data Type	Attributes	Comments
  1	source	Variant		Array of Strings to be sorted. This is an IN-OUT argument, passed by reference.