Luciad.Text.TextStyle.Builder Class Reference

A builder class for creating text styles. More...

Inheritance diagram for Luciad.Text.TextStyle.Builder:

Public Member Functions
	Builder (Luciad.Text.TextStyle.Builder other)
Luciad.Text.TextStyle	Build ()
	Creates a newly created text style, based on the properties set on this builder. More...
void	Dispose ()
Luciad.Text.TextStyle.Builder	FontName (string fontName)
	Sets the font name used for text rendering (possible values: Serif, Sans, Arial, Arial Black, Arial Narrow, Calibri, Console, Noto). More...
Luciad.Text.TextStyle.Builder	FontSize (uint fontSize)
	Sets the font size in pixels , where a pixel is defined as 1/96th of 1 inch (https://www.w3.org/TR/css-values-4/#absolute-lengths). More...
Luciad.Text.TextStyle.Builder	HaloColor (System.Drawing.Color haloColor)
	Sets the color of the halo (outline) around the text. More...
Luciad.Text.TextStyle.Builder	HaloWidth (double haloWidth)
	Sets the width of the halo (outline) around the text in pixels. More...
Luciad.Text.TextStyle.Builder	TextColor (System.Drawing.Color textColor)
	Sets the text color. More...

Detailed Description

A builder class for creating text styles.

2020.2

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::TextStyle::Builder.

Constructor & Destructor Documentation

Builder()

Luciad.Text.TextStyle.Builder.Builder ( Luciad.Text.TextStyle.Builder  other )

inline

Member Function Documentation

Build()

Luciad.Text.TextStyle Luciad.Text.TextStyle.Builder.Build ( )

inline

Creates a newly created text style, based on the properties set on this builder.

a newly created text style, based on the properties set on this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::TextStyle::Builder::build.

Dispose()

void Luciad.Text.TextStyle.Builder.Dispose ( )

inline

FontName()

Luciad.Text.TextStyle.Builder Luciad.Text.TextStyle.Builder.FontName ( string  fontName )

inline

Sets the font name used for text rendering (possible values: Serif, Sans, Arial, Arial Black, Arial Narrow, Calibri, Console, Noto).

If not specified, then the Serif font will be used to display text. The Noto font has support for the following alphabets: Arabic, Armenian, Bengali, Cyrillic, Devanagari, Georgian, Greek, Gujarati, Gurmukhi, Hangul, Han, Hebrew, Hiragana, Kanji, Kannada, Katakana, Lao, Latin, Malayalam, Oriya, Tamil, Telugu and Thai. Other fonts only support Latin alphabets.

fontName

identifier of the font used for text rendering.

this builder

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::TextStyle::Builder::fontName.

FontSize()

Luciad.Text.TextStyle.Builder Luciad.Text.TextStyle.Builder.FontSize ( uint  fontSize )

inline

Sets the font size in pixels , where a pixel is defined as 1/96th of 1 inch (https://www.w3.org/TR/css-values-4/#absolute-lengths).

The font size value must be > 0. If not specified, a size of 14 is used.

fontSize

the font size in pixels, where a pixel is defined as 1/96th of 1 inch.

this builder

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::TextStyle::Builder::fontSize.

HaloColor()

Luciad.Text.TextStyle.Builder Luciad.Text.TextStyle.Builder.HaloColor ( System.Drawing.Color  haloColor )

inline

Sets the color of the halo (outline) around the text.

The default value is white.

haloColor

the color of the halo (outline) around the text.

this builder

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::TextStyle::Builder::haloColor.

HaloWidth()

Luciad.Text.TextStyle.Builder Luciad.Text.TextStyle.Builder.HaloWidth ( double  haloWidth )

inline

Sets the width of the halo (outline) around the text in pixels.

This value must be greater then or equal to zero. If this value is equal to zero, no halo is drawn. Text halo width is 1 pixel wide by default.

haloWidth

the size of the halo (outline) around text in pixels.

this builder

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::TextStyle::Builder::haloWidth.

TextColor()

Luciad.Text.TextStyle.Builder Luciad.Text.TextStyle.Builder.TextColor ( System.Drawing.Color  textColor )

inline

Sets the text color.

By default, this is black.

textColor

The text color.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::TextStyle::Builder::textColor.