TextHelper Class

Contains various methods for text formatting and transformation.

Inheritance Hierarchy

System.Object
  CMS.Helpers.TextHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 9.0.0

Syntax

public class TextHelper

The TextHelper type exposes the following members.

Constructors

	Name	Description
Public method	TextHelper

Fields

	Name	Description
Public field Static member	DEFAULT_ELLIPSIS	Default ellipsis for the limit length methods.
Public field Static member	NewLine	Newline symbol.

Properties

	Name	Description
Public property	EncodeValues	Indicates whether to encode merged text.
Public property Static member	RegeExWhiteSpaces	Regular expression for white spaces.
Public property Static member	RegExLineBreak	Gets or sets the regular expression for line break method.
Public property Static member	RegExLineEnd	Regular expression for the line ending.
Public property Static member	RegExLineEndWithSpaces	Regular expression for the line ending with the spaces before and after.
Public property Static member	RegExRemoveMultipleCommas	Regular expression to identify multiple occurrences of comma (surrounded by white space).
Public property Static member	RegExRemoveMultipleCommasStartEnd	Regular expression to identify comma at the beginning and at the end of a text.
Public property Static member	RegExSplitPagesSentences	Regular expression for the tag match for SplitPages method.
Public property Static member	RegExSplitPagesTags	Regular expression for the tag match for SplitPages method.
Public property Static member	RegExToTitleCaseWords	Regular expression for the word match for ToTitleCase method.

Methods

	Name	Description
Public method Static member	BreakLine	Add specified break tag into the input text in specified index.
Public method Static member	BulkReplace	Performs bulk replace of given replacements
Public method Static member	ContentEquals(String, String, Boolean, TextNormalizationSettings)	Checks if two text contents are equal. Ignores extra white spaces, and is case insensitive.
Public method Static member	ContentEquals(String, String, Boolean, Boolean)	Obsolete. Checks if two text contents are equal. Ignores extra white spaces, and is case insensitive.
Public method Static member	EncodeRegexSubstitutes	Encodes regex substitutions like $_, $+, ... so they don't apply as substitutes in the replacement string.
Public method Static member	EnsureHTMLLineEndings	Ensures the specified line endings in the given text.
Public method Static member	EnsureIndentation(String, Int32)	Ensures the specified line endings in the given text.
Public method Static member	EnsureIndentation(String, Int32, String)	Ensures the specified line endings in the given text.
Public method Static member	EnsureLineEndings	Ensures the specified line endings in the given text.
Public method Static member	EnsureMaximumLineLength(String, Int32)	Limits the line length of given plain text.
Public method Static member	EnsureMaximumLineLength(String, Int32, String, Boolean)	Limits the line length of given plain text.
Public method Static member	FirstLetterToUpper	Converts the first character to upper case.
Public method Static member	GetAmountText	If amount is equal to 1, expression using singular formatting string is returned, otherwise expression using plural formatting string is returned.
Public method Static member	Join	Joins the given list of values with a given separator.
Public method Static member	LimitFileNameLength	Limits the filename length (leaves extension).
Public method Static member	LimitLength(String, Int32, CutTextEnum)	Limits the string length.
Public method Static member	LimitLength(String, Int32, String, Boolean, CutTextEnum)	Limits the string length.
Public method Static member	Merge	Joins the given list of values with a given separator.
Public method Static member	MergeIfNotEmpty	Joins the given list of values with a given separator. Each value is inserted into the final string only if not empty.
Public method Static member	ReduceWhiteSpaces	Replace whitespaces in input text to specified replacement.
Public method Static member	ReformatCode(String)	Reformats the C# or JS code so it is properly indented.
Public method Static member	ReformatCode(String, Int32)	Reformats the C# or JS code so it is properly indented.
Public method Static member	ReformatCode(String, Int32, String)	Reformats the C# or JS code so it is properly indented.
Public method Static member	RemoveDiacritics	Removes diacritics from Latin characters, non-Latin characters are not changed.
Public method Static member	RemoveMultipleCommas	Removes multiple commas (i.e. transforms text "a,,b,," to "a, b").
Public method Static member	SetLine	Sets the specific line of the text to a new value
Public method Static member	SplitByString	Splits the given string by a defined string separator
Public method Static member	SplitCamelCase	Splits the camel cased input text into separate words.
Public method Static member	SplitPages(String, Int32)	Returns an array of text pages created from the input string according to the page size.
Public method Static member	SplitPages(String, Int32, Boolean)	Returns an array of text pages created from the input string according to the page size.
Public method Static member	ToTitleCase	Converts the specified string to title case.
Public method Static member	TrimEndingWord	Removes specified word from the end of the text (if the text ends with the word). Note: Ignore case enabled.
Public method Static member	TrimNumberSuffix	Trims the number suffix from an identifier

Events

	Name	Description
Public event Static member	OnBeforeRemoveDiacritics	Occurs when the RemoveDiacritics method is called, returns false if original remove method should not be used.