StringExtensionReplaceWhiteSpaceWith Method

public static string ReplaceWhiteSpaceWith(
	this string s,
	ReadOnlySpan<char> replacement,
	bool skipNewLines = false
)

<ExtensionAttribute>
Public Shared Function ReplaceWhiteSpaceWith ( 
	s As String,
	replacement As ReadOnlySpan(Of Char),
	Optional skipNewLines As Boolean = false
) As String

public:
[ExtensionAttribute]
static String^ ReplaceWhiteSpaceWith(
	String^ s, 
	ReadOnlySpan<wchar_t> replacement, 
	bool skipNewLines = false
)

[<ExtensionAttribute>]
static member ReplaceWhiteSpaceWith : 
        s : string * 
        replacement : ReadOnlySpan<char> * 
        ?skipNewLines : bool 
(* Defaults:
        let _skipNewLines = defaultArg skipNewLines false
*)
-> string 

Parameters

s  String

The source String.

replacement  ReadOnlySpanChar

A read-only character span that is the replacement for all white space sequences. If an empty span is passed to the parameter, each white space will be completely removed.

skipNewLines  Boolean  (Optional)

Pass true to exclude newline characters from the replacement. The default value is false.

Return Value

Usage Note

The method uses IsWhiteSpace(Char) to identify white space characters and works more thoroughly with it than Regex.Replace(string input, @"\s+", string replacement).

IsNewLine(Char) is used to identify newline characters.

Reference