Class Format

Namespace

HeyBox

Assembly

HeyBox.Net.Core.dll

提供用于格式化字符的帮助类。

public static class Format

Inheritance

object

Format

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Bold(string?, bool)

返回一个使用粗体格式的 Markdown 格式化字符串。

public static string Bold(string? text, bool sanitize = true)

Parameters

text string

要格式化的文本。

sanitize bool

是否要先对 text 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的文本。

Remarks

设置 sanitize 为 true 将会对文本中出现的所有 * 字符转义为 *。

BoldItalics(string?, bool)

返回一个使用粗斜体格式的 Markdown 格式化字符串。

public static string BoldItalics(string? text, bool sanitize = true)

Parameters

text string

要格式化的文本。

sanitize bool

是否要先对 text 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的文本。

Remarks

设置 sanitize 为 true 将会对文本中出现的所有 * 字符转义为 *。

Code(string?, string?, bool)

返回一个使用代码格式的 Markdown 格式化字符串。

public static string Code(string? text, string? language = null, bool sanitize = true)

Parameters

text string

要格式化的文本。

language string

代码块的语言。

sanitize bool

是否要先对 text 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的内联代码或代码块。

Remarks

设置 sanitize 为 true 将会对文本中出现的所有 </code> 字符转义为 <code>\。
当 language 不为 null 或 text 中包含换行符时，将返回一个代码块； 否则，将返回一个内联代码块。

CodeBlock(string?, string?, bool)

返回一个使用代码块格式的 Markdown 格式化字符串。

public static string CodeBlock(string? text, string? language = null, bool sanitize = true)

Parameters

text string

要格式化的文本。

language string

代码块的语言。

sanitize bool

是否要先对 text 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的代码块。

Remarks

设置 sanitize 为 true 将会对文本中出现的所有 </code> 字符转义为 <code>\。

H1(string)

返回格式化为 Markdown 一级标题的字符串。

public static string H1(string text)

Parameters

text string

要格式化的文本。

Returns

string

获取格式化后的文本。

H2(string)

返回格式化为 Markdown 二级标题的字符串。

public static string H2(string text)

Parameters

text string

要格式化的文本。

Returns

string

获取格式化后的文本。

H3(string)

返回格式化为 Markdown 三级标题的字符串。

public static string H3(string text)

Parameters

text string

要格式化的文本。

Returns

string

获取格式化后的文本。

Image(FileAttachment)

获取一个 Markdown 格式的图片。

public static string Image(FileAttachment attachment)

Parameters

attachment FileAttachment

图片的附件信息。

Returns

string

Image(string, string?, bool)

获取一个 Markdown 格式的图片。

public static string Image(string url, string? alternative = null, bool sanitize = true)

Parameters

url string

图片的 URL。

alternative string

图片的替代文本。

sanitize bool

是否要先对 alternative 与 url 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的图片。

Remarks

设置 sanitize 为 true，将会对 alternative 中出现的所有 [ 和 ] 字符分别转义为 [ 和 ]，并对 url 中出现的所有 ( 和 ) 字符分别转义为 ( 和 )。

Image(Uri, string?, bool)

获取一个 Markdown 格式的图片。

public static string Image(Uri url, string? alternative = null, bool sanitize = true)

Parameters

url Uri

图片的 URL。

alternative string

图片的替代文本。

sanitize bool

是否要先对 alternative 与 url 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的图片。

Remarks

设置 sanitize 为 true，将会对 alternative 中出现的所有 [ 和 ] 字符分别转义为 [ 和 ]，并对 url 中出现的所有 ( 和 ) 字符分别转义为 ( 和 )。

Italics(string?, bool)

返回一个使用斜体格式的 Markdown 格式化字符串。

public static string Italics(string? text, bool sanitize = true)

Parameters

text string

要格式化的文本。

sanitize bool

是否要先对 text 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的文本。

Remarks

设置 sanitize 为 true 将会对文本中出现的所有 * 字符转义为 *。

OrderedList(IEnumerable<string>, int)

获取有序列表的 Markdown 格式化字符串。

public static string OrderedList(IEnumerable<string> items, int indentLevel = 0)

Parameters

items IEnumerable<string>

要格式化的列表项。

indentLevel int

列表项的缩进级别。

Returns

string

获取格式化后的列表。

Sanitize(string?, params string[])

转义字符串，安全地转义任何 Markdown 序列。

public static string? Sanitize(string? text, params string[] sensitiveCharacters)

Parameters

text string

要转义的文本。

sensitiveCharacters string[]

要转义的字符。

Returns

string

获取转义后的文本。

Strikethrough(string?, bool)

返回一个使用删除线格式的 Markdown 格式化字符串。

public static string Strikethrough(string? text, bool sanitize = true)

Parameters

text string

要格式化的文本。

sanitize bool

是否要先对 text 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的文本。

Remarks

设置 sanitize 为 true 将会对文本中出现的所有 ~ 字符转义为 ~。

StripMarkdown(string)

移除文本中的 Markdown 格式字符。

public static string StripMarkdown(string text)

Parameters

text string

要移除 Markdown 格式字符的文本。

Returns

string

获取移除 Markdown 格式字符后的文本。

Remarks

此方法不会过多地分析 Markdown 的复杂格式，只会简单地移除 Markdown 中的以下字符：
<sup>、</sup>、<sub>、</sub>、 #、*、`、~、<、>、</code>。

SubScript(string)

返回一个使用下标格式的 Markdown 格式化字符串。

public static string SubScript(string text)

Parameters

text string

要格式化的文本。

Returns

string

获取格式化后的文本。

SuperScript(string)

返回一个使用上标格式的 Markdown 格式化字符串。

public static string SuperScript(string text)

Parameters

text string

要格式化的文本。

Returns

string

获取格式化后的文本。

UnorderedList(IEnumerable<string>, int)

获取无序列表的 Markdown 格式化字符串。

public static string UnorderedList(IEnumerable<string> items, int indentLevel = 0)

Parameters

items IEnumerable<string>

要格式化的列表项。

indentLevel int

列表项的缩进级别。

Returns

string

获取格式化后的列表。

Url(string, bool)

返回格式化为 Markdown 链接的字符串。

public static string Url(string url, bool sanitize = true)

Parameters

url string

要链接到的 URL。

sanitize bool

是否要先对 url 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的链接文本。

Remarks

设置 sanitize 为 true，将会对 URL 中出现的所有 < 和 > 字符分别转义为 < 和 >。

Url(string, string, bool)

返回格式化为 Markdown 链接的字符串。

public static string Url(string url, string text, bool sanitize = true)

Parameters

url string

要链接到的 URL。

text string

要格式化的文本。

sanitize bool

是否要先对 text 与 url 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的链接文本。

Remarks

设置 sanitize 为 true，将会对文本中出现的所有 [ 和 ] 字符分别转义为 [ 和 ]，并对 URL 中出现的所有 ( 和 ) 字符分别转义为 ( 和 )。

Url(Uri, bool)

返回格式化为 Markdown 链接的字符串。

public static string Url(Uri url, bool sanitize = true)

Parameters

url Uri

要链接到的 URL。

sanitize bool

是否要先对 url 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的链接文本。

Remarks

设置 sanitize 为 true，将会对 URL 中出现的所有 < 和 > 字符分别转义为 < 和 >。

Url(Uri, string, bool)

返回格式化为 Markdown 链接的字符串。

public static string Url(Uri url, string text, bool sanitize = true)

Parameters

url Uri

要链接到的 URL。

text string

要格式化的文本。

sanitize bool

是否要先对 text 与 url 中与当前格式化操作有冲突的字符进行转义。

Returns

string

获取格式化后的链接文本。

Remarks

设置 sanitize 为 true，将会对文本中出现的所有 [ 和 ] 字符分别转义为 [ 和 ]，并对 URL 中出现的所有 ( 和 ) 字符分别转义为 ( 和 )。