TextListFormat Class

Namespace:
GemBox.Spreadsheet.Drawing
Assembly:
GemBox.Spreadsheet.dll

Represents a set of formatting properties related to bulleted or numbered lists that can be applied to a TextParagraph.

public sealed class TextListFormat
Public NotInheritable Class TextListFormat
Inheritance:
System.Object
TextListFormat

Properties

BulletCharacter

Gets or sets the character to be used in place of the standard bullet point.

Default value is System.String.Empty.

public string BulletCharacter { get; set; }
Public Property BulletCharacter As String
Property Value
System.String

The character to be used in place of the standard bullet point.

BulletPicture

Gets or sets the picture to be applied to a set of bullets.

Default value is null.

public PictureContent BulletPicture { get; set; }
Public Property BulletPicture As PictureContent
Property Value
PictureContent

The picture to be applied to a set of bullets.

BulletType

Gets or sets the bullet scheme of the bulleted list.

Default value is None.

This allows specifying character and font of predefined list bullets.

public ListBulletType BulletType { get; set; }
Public Property BulletType As ListBulletType
Property Value
ListBulletType

The bullet scheme of the bulleted list.

Exceptions
System.ArgumentException

Value Custom is not supported. Set BulletCharacter property instead.

Color

Gets or sets the color to be used on bullet characters within a given TextParagraph.

public DrawingColor Color { get; set; }
Public Property Color As DrawingColor
Property Value
DrawingColor

The color to be used on bullet characters within a given TextParagraph.

Font

Gets or sets the font to be used on bullet characters within a given TextParagraph.

public string Font { get; set; }
Public Property Font As String
Property Value
System.String

The font to be used on bullet characters within a given TextParagraph.

Exceptions
System.ArgumentException

Value is null or System.String.Empty.

Level

Gets or sets the list indent level.

Default value is 0.

public int Level { get; set; }
Public Property Level As Integer
Property Value
System.Int32

The list indent level.

Exceptions
System.ArgumentOutOfRangeException

Value is not between 0 and 8 (inclusive).

ListType

Gets the type of the list.

Default value is None.

Use members NumberType, BulletType, BulletCharacter or SetBulletPicture(Stream, PictureContentType) to set list type.

public ListType ListType { get; }
Public ReadOnly Property ListType As ListType
Property Value
ListType

The type of the list.

NumberStartAt

Gets or sets the number that starts a given sequence of a numbered list.

Default value is 1 if ListType is Number; otherwise, -1.

When the numbering is alphabetical, the number should map to the appropriate letter. For instance 1 maps to 'a', 2 to 'b' and so on. If the numbers are larger than 26, then multiple letters should be used. For instance 27 should be represented as 'aa' and similarly 53 should be 'aaa'.

public int NumberStartAt { get; set; }
Public Property NumberStartAt As Integer
Property Value
System.Int32

The number that starts a given sequence of a numbered list.

Exceptions
System.ArgumentOutOfRangeException

Value is not between 1 and 32767 (inclusive).

NumberType

Gets or sets the numbering scheme of the numbered list.

Default value is None.

This allows specifying formats other than strictly numbers. For instance, a set of bullets can be represented by a series of Roman numerals instead of the standard 1,2,3, etc. number set.

public ListNumberType NumberType { get; set; }
Public Property NumberType As ListNumberType
Property Value
ListNumberType

The numbering scheme of the numbered list.

RelativeSize

Gets or sets the size in percentage of the surrounding text to be used on bullet characters within a given TextParagraph.

public double RelativeSize { get; set; }
Public Property RelativeSize As Double
Property Value
System.Double

The size in percentage of the surrounding text to be used on bullet characters within a given TextParagraph.

Exceptions
System.ArgumentOutOfRangeException

Value is not between 25% and 400% (inclusive).

Size

Gets or sets the absolute size to be used on bullet characters within a given TextParagraph.

public Length Size { get; set; }
Public Property Size As Length
Property Value
Length

The absolute size to be used on bullet characters within a given TextParagraph.

Exceptions
System.ArgumentOutOfRangeException

Value is not between 1 pt and 4000 pt (inclusive).

Methods

SetBulletPicture(Stream, PictureContentType)

Sets the bullet picture.

public void SetBulletPicture(Stream stream, PictureContentType contentType)
Public Sub SetBulletPicture(stream As Stream, contentType As PictureContentType)
Parameters
stream
System.IO.Stream

The picture stream.

contentType
PictureContentType

Content type of the picture stream.

Exceptions
System.ArgumentException

contentType is Unknown.

SetBulletPicture(Stream, String)

Sets the bullet picture.

public void SetBulletPicture(Stream stream, string contentType)
Public Sub SetBulletPicture(stream As Stream, contentType As String)
Parameters
stream
System.IO.Stream

The picture stream.

contentType
System.String

Content type (MIME type) of the picture stream.

Exceptions
System.ArgumentException

contentType is null or System.String.Empty.