TextUtils

Wisej.Base.TextUtils

Namespace: Wisej.Base

Assembly: Wisej.Framework (4.0.0.0)

Provides utility methods to measure, encode, and extract mnemonics from text.

C#

public class TextUtils

VB.NET

Public Class TextUtils

Fields

Name	Type	Description
ConvertToString	Func<Object, Object, String>	Pluggable method used to convert user input to a string. Since 3.0.10
MeasureString	Func<String, Font, Size, StringFormat, SizeF>	Pluggable method used to measure strings.

Methods

ApplyCharacterCasing(text, casing)

Applies the specified CharacterCasing rule to the text.

Parameter	Type	Description
text	String	The text to modify according to the CharacterCasing rule.
casing	CharacterCasing	The CharacterCasing rule to apply to the text.

Returns: String.

ConvertToText(owner, value, maxLength)

Returns the correct string representation for value .

Parameter	Type	Description
owner	Object	Component that owns the value to convert to a string.
value	Object	Value to convert to a string.
maxLength	Int32	Maximum length applied to the string; 0 = unlimited.

Returns: String. The correct string representation for value .

EscapeText(text, allowHtml)

Escapes special characters in the specified string.

Parameter	Type	Description
text	String	The text to escape.
allowHtml	Boolean	Indicates that HTML tags should not be escaped. The default is false.

Returns: String. The escaped string. Null if the specified string was null, or empty if it was empty.

EscapeText(text, allowHtml, useMnemonic, translateNewLines)

Removes the ampersand from the text and encodes HTML characters if necessary.

Parameter	Type	Description
text	String	The text to convert.
allowHtml	Boolean	Whether to encode HTML characters.
useMnemonic	Boolean	Whether to convert the first mnemonic to an underlined character.
translateNewLines	Boolean	Whether to convert newlines (CRLF) to <BR/>. The conversion is performed only when allowHtml is false, or, if allowHtml is true and the text doesn't contain any HTML.

Returns: String. The escaped string. Null if the specified string was null, or empty if it was empty.

EscapeTextInternal(text)

Escapes HTML brackets and other HTML entities ready for being assigned to innerHTML without calling unescape() on the client.

Parameter	Type	Description
text	String	Text to escape.

Returns: String. The escaped string, or an empty string if the string is null.

EscapeTextInternal(text, allowHtml, allowMarkdown, useMnemonic, translateNewLines)

Removes the ampersand from the text and encodes HTML characters if necessary.

Parameter	Type	Description
text	String	The text to convert.
allowHtml	Boolean	Whether to encode HTML characters.
allowMarkdown	Boolean	Whether to convert the text to HTML using the markdown syntax.
useMnemonic	Boolean	Whether to convert the first mnemonic to an underlined character.
translateNewLines	Boolean	Whether to convert newlines (CRLF) to <BR/>. The conversion is performed only when allowHtml is false, or, if allowHtml is true and the text doesn't contain any HTML.

Returns: String. The escaped string. Null if the string is empty.

GetFontHeight(font)

Returns the height of the specified font .

Parameter	Type	Description
font	Font	Font to measure.

Returns: Int32. Height of font in pixels.

GetMnemonic(text)

Returns the first character that is preceded by an ampersand (&).

Parameter	Type	Description
text	String	The string from which to extract the mnemonic character.

Returns: String.

GetMnemonicInternal(text)

Returns the mnemonic character from the text.

Parameter	Type	Description
text	String

Returns: String.

MeasureText(text, font)

Returns the size of the specified text when rendered with the specified font.

Parameter	Type	Description
text	String	The text to measure.
font	Font	The Font to apply to the measured text.

Returns: Size. The computed Size of the specified text.

MeasureText(text, font, format)

Returns the size of the specified text when rendered with the specified font.

Parameter	Type	Description
text	String	The text to measure.
font	Font	The Font to apply to the measured text.
format	StringFormat	Formatting information.

Returns: Size. The computed Size of the specified text.

MeasureText(text, font, layoutArea)

Returns the size of the specified text when rendered with the specified font.

Parameter	Type	Description
text	String	The text to measure.
font	Font	The Font to apply to the measured text.
layoutArea	Size	The Size to use as bounding rectangle for the text.

Returns: Size.

MeasureText(text, font, layoutArea, format)

Returns the size of the specified text when rendered with the specified font.

Parameter	Type	Description
text	String	The text to measure.
font	Font	The Font to apply to the measured text.
layoutArea	Size	The Size to use as bounding rectangle for the text.
format	StringFormat	Formatting information.

Returns: Size.

MeasureText(text, allowHtml, font, callback)

Returns the size of the specified text when rendered with the specified font.

Parameter	Type	Description
text	String	The text to measure.
allowHtml	Boolean	The text to measure may contain HTML tags.
font	Font	The Font to apply to the measured text.
callback	Action<Size>	Result callback method, invoked when the client has finished measuring the text.

MeasureText(text, allowHtml, font, width, callback)

Returns the size of the specified text when rendered with the specified font.

Parameter	Type	Description
text	String	The text to measure.
allowHtml	Boolean	The text to measure may contain HTML tags.
font	Font	The Font to apply to the measured text.
width	Int32	The width to use as bounding rectangle for the text.
callback	Action<Size>	Result callback method, invoked when the client has finished measuring the text.

MeasureTextAsync(text, allowHtml, font, width)

Asynchronously returns the size of the specified text when rendered with the specified font. The measurement is performed on the browser. Returns an awaitable Task that contains the measured size.

Parameter	Type	Description
text	String	The text to measure.
allowHtml	Boolean	The text to measure may contain HTML tags.
font	Font	The Font to apply to the measured text.
width	Int32	The optional width to use as bounding rectangle for the text.

Returns: Task<Size>. An awaitable Task that represents the asynchronous operation.