View on GitHub

BBCodeOptions Class

BBCodeRenderer Option class.

SundownNet : Sundown Namespace

Syntax

public class BBCodeOptions

Remarks

This class is used by BBCodeRenderer to specify options.

Requirements

Namespace: Sundown
Assembly: SundownNet (in SundownNet.dll)
Assembly Versions: 1.15.12.0

Members

See Also: Inherited members from object.

Public Constructors

BBCodeOptions ()

The only constructor of the Options class.

Public Properties

	DefaultHeaderSize	int . The default size of the headers.
	HeaderSizes	Dictionary<int, int> . BBCode pixel sizes for headers.

Member Details

BBCodeOptions Constructor

The only constructor of the Options class.

Syntax

public BBCodeOptions ()

Remarks
It will initialize the class with default values.
C# Example
DefaultHeaderSize = 10;
HeaderSize = new Dictionary<int, int>() {
  { 1, 16 },
  { 2, 14 },
  { 3, 12 },
};
  
Custom option setting is possible like this:
C# Example
DefaultHeaderSize = 10;
var options = new BBCodeOptions() {
  DefaultHeaderSize = 16,
  HeaderSize = new Dictionary<int, int>() {
    { 1, 22 },
    { 2, 20 },
  }
}
  
Requirements

Namespace: Sundown
Assembly: SundownNet (in SundownNet.dll)
Assembly Versions: 1.15.12.0

DefaultHeaderSize Property

The default size of the headers.

Syntax

public int DefaultHeaderSize { get; set; }

Value

An integer representing the header size.

Remarks

This is the default header size value used if Sundown.BBCodeOptions.HeaderSizes doesn't contain the specific size.

Requirements

Namespace: Sundown
Assembly: SundownNet (in SundownNet.dll)
Assembly Versions: 1.15.12.0

HeaderSizes Property

BBCode pixel sizes for headers.

Syntax

public Dictionary<int, int> HeaderSizes { get; set; }

Value

A hashtable which keys represent the indententation in markdown and the values represent the bbcode pixel sizes.

Remarks

The key for #header is 1, for ##header is 2 and so on.

Requirements

Namespace: Sundown
Assembly: SundownNet (in SundownNet.dll)
Assembly Versions: 1.15.12.0