C# Class FlatRedBall.Utilities.StringFunctions

A class containing common string maniuplation methods.

Show file Open project: vchelaru/FlatRedBall

Public Methods

Method	Description
CharacterCountWithoutWhitespace ( string stringInQuestion ) : int	Returns the number of non-whitespace characters in the argument stringInQuestion. This method is used internally by the TextManager to determine the number of vertices needed to draw a Text object.
Contains ( this listToInvestigate, string whatToSearchFor ) : bool
CountOf ( this instanceToSearchIn, char characterToSearchFor ) : int
CountOf ( this instanceToSearchIn, char characterToSearchFor, int startIndex, int searchLength ) : int
CountOf ( this instanceToSearchIn, string whatToFind ) : int	Returns the number of times that the argument whatToFind is found in the calling string.
FloatToString ( float floatToConvert, int decimalsAfterPoint ) : string	Returns a string of the float with the argument decimalsAfterPoint digits of resolution after the point.
GetCharAfter ( string stringToSearchFor, string whereToSearch ) : char	Returns the character that can be found after a particular sequence of characters. This will return the first character following a particular sequence of characters. For example, GetCharAfter("bcd", "abcdef") would return 'e'.
GetClosingCharacter ( string fullString, int startIndex, char openingCharacter, char closingCharacter ) : int
GetDigitCount ( double x ) : int
GetFloatAfter ( string stringToSearchFor, string whereToSearch ) : float	Returns the float that can be found after a particular sequence of characters. This will return the float following a particular sequence of characters. For example, GetCharAfter("height = 6; width = 3; depth = 7;", "width = ") would return 3.0f.
GetFloatAfter ( string stringToSearchFor, string whereToSearch, int startIndex ) : float
GetIntAfter ( string stringToSearchFor, string whereToSearch ) : int	Returns the first integer found after the argument stringToSearchFor in whereToSearch. This method is used to help simplify parsing of text files and data strings. If stringToSearchFor is "Y:" and whereToSearch is "X: 30, Y:32", then the value of 32 will be returned.
GetIntAfter ( string stringToSearchFor, string whereToSearch, int startIndex ) : int	Returns the first integer found after the argument stringToSearchFor. The search begins at the argument startIndex.
GetLineCount ( string stringInQuestion ) : int	Returns the number of lines in a given string. Newlines '\n' increase the line count.
GetNumberAtEnd ( string stringToGetNumberFrom ) : int	Returns the number found at the end of the argument stringToGetNumberFrom or throws an ArgumentException if no number is found. A stringToGetNumberFrom of "sprite41" will result in the value of 41 returned. A stringToGetNumberFrom of "sprite" will result in an ArgumentException being thrown.
GetStartAndEndOfLineContaining ( string contents, string whatToSearchFor, int &start, int &end ) : void
GetWordAfter ( string stringToStartAfter, StringBuilder entireString ) : string
GetWordAfter ( string stringToStartAfter, StringBuilder entireString, int indexToStartAt ) : string
GetWordAfter ( string stringToStartAfter, StringBuilder entireString, int indexToStartAt, System.StringComparison comparison ) : string
GetWordAfter ( string stringToStartAfter, string entireString ) : string
GetWordAfter ( string stringToStartAfter, string entireString, int indexToStartAt ) : string
GetWordAfter ( string stringToStartAfter, string entireString, int indexToStartAt, System.StringComparison comparison ) : string
HasNumberAtEnd ( string stringToGetNumberFrom ) : bool
IncrementNumberAtEnd ( string originalString ) : string	Increments the number at the end of a string or adds a number if none exists. This method begins looking at the end of a string for numbers and moves towards the beginning of the string until it encounters a character which is not a numerical digit or the beginning of the string. "Sprite123" would return "Sprite124", and "MyString" would return "MyString1".
InsertSpacesInCamelCaseString ( string originalString ) : string	Inserts spaces before every capital letter in a camel-case string. Ignores the first letter. For example "HelloThereIAmCamelCase" becomes "Hello There I Am Camel Case".
IsAscii ( string stringToCheck ) : bool
IsNumber ( string stringToCheck ) : bool
MakeCamelCase ( string originalString ) : string
MakeStringUnique ( string stringToMakeUnique, List stringList ) : string
MakeStringUnique ( string stringToMakeUnique, List stringList, int numberToStartAt ) : string
RemoveDuplicates ( List strings ) : void
RemoveDuplicates ( List strings, bool ignoreCase ) : void
RemoveNumberAtEnd ( string originalString ) : string	Removes the number found at the end of the argument originalString and returns the resulting string, or returns the original string if no number is found.
RemoveWhitespace ( string stringToRemoveWhitespaceFrom ) : string	Removes all whitespace found in the argument stringToRemoveWhitespaceFrom.
ReplaceLine ( string &contents, string contentsOfLineToReplace, string whatToReplaceWith ) : void

Method Details

CharacterCountWithoutWhitespace() public static method

Returns the number of non-whitespace characters in the argument stringInQuestion.

This method is used internally by the TextManager to determine the number of vertices needed to draw a Text object.

public static CharacterCountWithoutWhitespace ( string stringInQuestion ) : int
stringInQuestion	string	The string to have its non-witespace counted.
return	int

Contains() public static method

public static Contains ( this listToInvestigate, string whatToSearchFor ) : bool
listToInvestigate	this
whatToSearchFor	string
return	bool

CountOf() public static method

public static CountOf ( this instanceToSearchIn, char characterToSearchFor ) : int
instanceToSearchIn	this
characterToSearchFor	char
return	int

CountOf() public static method

public static CountOf ( this instanceToSearchIn, char characterToSearchFor, int startIndex, int searchLength ) : int
instanceToSearchIn	this
characterToSearchFor	char
startIndex	int
searchLength	int
return	int

CountOf() public static method

Returns the number of times that the argument whatToFind is found in the calling string.

public static CountOf ( this instanceToSearchIn, string whatToFind ) : int
instanceToSearchIn	this	The string to search within.
whatToFind	string	The string to search for.
return	int

FloatToString() public static method

Returns a string of the float with the argument decimalsAfterPoint digits of resolution after the point.

public static FloatToString ( float floatToConvert, int decimalsAfterPoint ) : string
floatToConvert	float	The float to convert.
decimalsAfterPoint	int	The number of decimals after the point. For example, 3.14159 becomes "3.14" if the /// decimalsAfterPoint is 2. This method will not append extra decimals to reach the argument decimalsAfterPoint.
return	string

GetCharAfter() public static method

Returns the character that can be found after a particular sequence of characters.

This will return the first character following a particular sequence of characters. For example, GetCharAfter("bcd", "abcdef") would return 'e'.

public static GetCharAfter ( string stringToSearchFor, string whereToSearch ) : char
stringToSearchFor	string	The string to search for.
whereToSearch	string	The string to search in.
return	char

GetClosingCharacter() public static method

public static GetClosingCharacter ( string fullString, int startIndex, char openingCharacter, char closingCharacter ) : int
fullString	string
startIndex	int
openingCharacter	char
closingCharacter	char
return	int

GetDigitCount() public static method

public static GetDigitCount ( double x ) : int
x	double
return	int

GetFloatAfter() public static method

Returns the float that can be found after a particular sequence of characters.

This will return the float following a particular sequence of characters. For example, GetCharAfter("height = 6; width = 3; depth = 7;", "width = ") would return 3.0f.

public static GetFloatAfter ( string stringToSearchFor, string whereToSearch ) : float
stringToSearchFor	string	The string to search for.
whereToSearch	string	The string to search in.
return	float

GetFloatAfter() public static method

public static GetFloatAfter ( string stringToSearchFor, string whereToSearch, int startIndex ) : float
stringToSearchFor	string
whereToSearch	string
startIndex	int
return	float

GetIntAfter() public static method

Returns the first integer found after the argument stringToSearchFor in whereToSearch.

This method is used to help simplify parsing of text files and data strings. If stringToSearchFor is "Y:" and whereToSearch is "X: 30, Y:32", then the value of 32 will be returned.

public static GetIntAfter ( string stringToSearchFor, string whereToSearch ) : int
stringToSearchFor	string	The string pattern to search for.
whereToSearch	string	The string that will be searched.
return	int

GetIntAfter() public static method

Returns the first integer found after the argument stringToSearchFor. The search begins at the argument startIndex.

public static GetIntAfter ( string stringToSearchFor, string whereToSearch, int startIndex ) : int
stringToSearchFor	string	The string pattern to search for.
whereToSearch	string	The string that will be searched.
startIndex	int	The index to begin searching at. This method /// will ignore any instances of stringToSearchFor which begin at an index smaller /// than the argument startIndex.
return	int

GetLineCount() public static method

Returns the number of lines in a given string. Newlines '\n' increase the line count.

public static GetLineCount ( string stringInQuestion ) : int
stringInQuestion	string	The string that will have its lines counted.
return	int

GetNumberAtEnd() public static method

Returns the number found at the end of the argument stringToGetNumberFrom or throws an ArgumentException if no number is found.

A stringToGetNumberFrom of "sprite41" will result in the value of 41 returned. A stringToGetNumberFrom of "sprite" will result in an ArgumentException being thrown.

Throws ArgumentException if no number is found at the end of the argument string.

public static GetNumberAtEnd ( string stringToGetNumberFrom ) : int
stringToGetNumberFrom	string	The number found at the end.
return	int

GetStartAndEndOfLineContaining() public static method

public static GetStartAndEndOfLineContaining ( string contents, string whatToSearchFor, int &start, int &end ) : void
contents	string
whatToSearchFor	string
start	int
end	int
return	void

GetWordAfter() public static method

public static GetWordAfter ( string stringToStartAfter, StringBuilder entireString ) : string
stringToStartAfter	string
entireString	StringBuilder
return	string

GetWordAfter() public static method

public static GetWordAfter ( string stringToStartAfter, StringBuilder entireString, int indexToStartAt ) : string
stringToStartAfter	string
entireString	StringBuilder
indexToStartAt	int
return	string

GetWordAfter() public static method

public static GetWordAfter ( string stringToStartAfter, StringBuilder entireString, int indexToStartAt, System.StringComparison comparison ) : string
stringToStartAfter	string
entireString	StringBuilder
indexToStartAt	int
comparison	System.StringComparison
return	string

GetWordAfter() public static method

public static GetWordAfter ( string stringToStartAfter, string entireString ) : string
stringToStartAfter	string
entireString	string
return	string

GetWordAfter() public static method

public static GetWordAfter ( string stringToStartAfter, string entireString, int indexToStartAt ) : string
stringToStartAfter	string
entireString	string
indexToStartAt	int
return	string

GetWordAfter() public static method

public static GetWordAfter ( string stringToStartAfter, string entireString, int indexToStartAt, System.StringComparison comparison ) : string
stringToStartAfter	string
entireString	string
indexToStartAt	int
comparison	System.StringComparison
return	string

HasNumberAtEnd() public static method

public static HasNumberAtEnd ( string stringToGetNumberFrom ) : bool
stringToGetNumberFrom	string
return	bool

IncrementNumberAtEnd() public static method

Increments the number at the end of a string or adds a number if none exists.

This method begins looking at the end of a string for numbers and moves towards the beginning of the string until it encounters a character which is not a numerical digit or the beginning of the string. "Sprite123" would return "Sprite124", and "MyString" would return "MyString1".

public static IncrementNumberAtEnd ( string originalString ) : string
originalString	string	The string to "increment".
return	string

InsertSpacesInCamelCaseString() public static method

Inserts spaces before every capital letter in a camel-case string. Ignores the first letter.

For example "HelloThereIAmCamelCase" becomes "Hello There I Am Camel Case".

public static InsertSpacesInCamelCaseString ( string originalString ) : string
originalString	string	The string in which to insert spaces.
return	string

IsAscii() public static method

public static IsAscii ( string stringToCheck ) : bool
stringToCheck	string
return	bool

IsNumber() public static method

public static IsNumber ( string stringToCheck ) : bool
stringToCheck	string
return	bool

MakeCamelCase() public static method

public static MakeCamelCase ( string originalString ) : string
originalString	string
return	string

MakeStringUnique() public static method

public static MakeStringUnique ( string stringToMakeUnique, List stringList ) : string
stringToMakeUnique	string
stringList	List
return	string

MakeStringUnique() public static method

public static MakeStringUnique ( string stringToMakeUnique, List stringList, int numberToStartAt ) : string
stringToMakeUnique	string
stringList	List
numberToStartAt	int
return	string

RemoveDuplicates() public static method

public static RemoveDuplicates ( List strings ) : void
strings	List
return	void

RemoveDuplicates() public static method

public static RemoveDuplicates ( List strings, bool ignoreCase ) : void
strings	List
ignoreCase	bool
return	void

RemoveNumberAtEnd() public static method

Removes the number found at the end of the argument originalString and returns the resulting string, or returns the original string if no number is found.

public static RemoveNumberAtEnd ( string originalString ) : string
originalString	string	The string that will have the number at its end removed.
return	string

RemoveWhitespace() public static method

Removes all whitespace found in the argument stringToRemoveWhitespaceFrom.

public static RemoveWhitespace ( string stringToRemoveWhitespaceFrom ) : string
stringToRemoveWhitespaceFrom	string	The string that will have its whitespace removed.
return	string

ReplaceLine() public static method

public static ReplaceLine ( string &contents, string contentsOfLineToReplace, string whatToReplaceWith ) : void
contents	string
contentsOfLineToReplace	string
whatToReplaceWith	string
return	void