Otter SDK Reference
Version:

RichDescription Class

Descriptive text that can be displayed as plain text or highlighted HTML.

Inheritance Hierarchy

  • object
    • Inedo.Documentation.RichDescription

Syntax

public class RichDescription

Constructors

Name Description
RichDescription

Initializes a new instance of the RichDescription class.

RichDescription(object content)

Initializes a new instance of the RichDescription class.

RichDescription(object[] content)

Initializes a new instance of the RichDescription class.

Methods

Name Description
AppendContent(object content)

Adds content to the end of the description.

AppendContent(object[] content)

Adds content to the end of the description.

ToHtml

Returns an HTML formatted string of the description.

ToString

Returns an undecorated plaintext string of the description.

WriteHtml(System.IO.TextWriter writer)

Writes the description as HTML.

WritePlainText(System.IO.TextWriter writer)

Writes the description as plain text.