Class
FormattedText

Definition

Namespace:Telerik.WinControls.TextPrimitiveUtils

Assembly:Telerik.WinControls.dll

Syntax:

cs-api-definition
public class FormattedText

Inheritance: objectFormattedText

Constructors

FormattedText()

Default constructor

Declaration

cs-api-definition
public FormattedText()

FormattedText(FormattedText)

Copy constructor

Declaration

cs-api-definition
public FormattedText(FormattedText prototypeFormattedText)

Parameters

prototypeFormattedText

FormattedText

Fields

prevListType

Declaration

cs-api-definition
protected FormattedText.HTMLLikeListType prevListType

Field Value

FormattedText.HTMLLikeListType

Properties

BaseLine

Gets or sets the baseline.

Declaration

cs-api-definition
public float BaseLine { get; set; }

Property Value

float

BgColor

Gets or sets the background color.

Declaration

cs-api-definition
public Color? BgColor { get; set; }

Property Value

Color?

BlockSize

Get or sets the Size of current text block

Declaration

cs-api-definition
public SizeF BlockSize { get; }

Property Value

SizeF

BulletFontName

Gets or sets the font name of the bullets.

Declaration

cs-api-definition
public string BulletFontName { get; set; }

Property Value

string

BulletFontSize

Gets or sets the font size of the bullets.

Declaration

cs-api-definition
public float BulletFontSize { get; set; }

Property Value

float

BulletFontStyle

Gets or sets the font style of the bullets.

Declaration

cs-api-definition
public FontStyle BulletFontStyle { get; set; }

Property Value

FontStyle

BulletSize

Gets the size of bullets.

Declaration

cs-api-definition
public SizeF BulletSize { get; }

Property Value

SizeF

ContentAlignment

Gets or sets the content alignment.

Declaration

cs-api-definition
public ContentAlignment ContentAlignment { get; set; }

Property Value

ContentAlignment

DrawingRectangle

Gets the drawing rectangle.

Declaration

cs-api-definition
public RectangleF DrawingRectangle { get; }

Property Value

RectangleF

FontColor

Gets or sets the font color.

Declaration

cs-api-definition
public Color FontColor { get; set; }

Property Value

Color

FontName

Gets or sets the font name.

Declaration

cs-api-definition
public string FontName { get; set; }

Property Value

string

FontSize

Get or sets size of the font. Note: recreate the font

Declaration

cs-api-definition
public float FontSize { get; set; }

Property Value

float

FontStyle

Gets or sets the font style.

Declaration

cs-api-definition
public FontStyle FontStyle { get; set; }

Property Value

FontStyle

HtmlTag

Get or sets HTML tag of the current text block.

Declaration

cs-api-definition
public string HtmlTag { get; set; }

Property Value

string

Image

Get or sets Image for the current text block Current block should be named Image block

Declaration

cs-api-definition
public Image Image { get; set; }

Property Value

Image

IsClosingTag

Gets or sets a value indicating whether is closing tag.

Declaration

cs-api-definition
public bool IsClosingTag { get; set; }

Property Value

bool

Gets or sets the link that is opened when the item is clicked.

Declaration

cs-api-definition
public string Link { get; set; }

Property Value

string

ListType

Gets or sets the list type.

Declaration

cs-api-definition
public FormattedText.HTMLLikeListType ListType { get; set; }

Property Value

FormattedText.HTMLLikeListType

Number

Gets or sets the number used in ordered list with numbering.

Declaration

cs-api-definition
public int Number { get; set; }

Property Value

int

Offset

Gets or sets the offset of the text.

Declaration

cs-api-definition
public int Offset { get; set; }

Property Value

int

OffsetSize

Gest the offset size of the text.

Declaration

cs-api-definition
public float OffsetSize { get; }

Property Value

float

ShouldDisplayBullet

Gets or sets a value indicating whether to display a bullet.

Declaration

cs-api-definition
public bool ShouldDisplayBullet { get; set; }

Property Value

bool

StartNewLine

Gets or sets a value indicating whether to start a new line.

Declaration

cs-api-definition
public bool StartNewLine { get; set; }

Property Value

bool

Text

Get or set the text.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

Methods

GetTextBlockSize(bool, TextFormatFlags)

Gets the size of the text block.

Declaration

cs-api-definition
public SizeF GetTextBlockSize(bool useCompatibleTextRendering, TextFormatFlags textFormatFlags)

Parameters

useCompatibleTextRendering

bool

textFormatFlags

TextFormatFlags

Returns

SizeF

PaintFormatText(IGraphics, RectangleF, bool, TextFormatFlags, PointF, float, float, bool)

Declaration

cs-api-definition
public void PaintFormatText(IGraphics graphics, RectangleF paintingRectangle, bool useCompatibleTextRendering, TextFormatFlags flags, PointF currentLineBeginLocation, float lineHeight, float lineBaseLine, bool clipText)

Parameters

graphics

IGraphics

paintingRectangle

RectangleF

useCompatibleTextRendering

bool

flags

TextFormatFlags

currentLineBeginLocation

PointF

lineHeight

float

lineBaseLine

float

clipText

bool