OFT.Rendering.Tools.RenderFont Class Reference

Defines a particular format for text, including font face, size, and style attributes. This class cannot be inherited. More...

Inheritance diagram for OFT.Rendering.Tools.RenderFont:

Collaboration diagram for OFT.Rendering.Tools.RenderFont:

Public Member Functions
	RenderFont (string familyName, float emSize)
	Initializes a new T:OFT.Rendering.Font using a specified size.
	RenderFont (string familyName, float emSize, FontStyle style)
	Initializes a new T:OFT.Rendering.Font using a specified size and style.
	RenderFont (string familyName, float emSize, GraphicsUnit unit)
	Initializes a new T:OFT.Rendering.Font using a specified size and unit. The style is set to F:OFT.Rendering.FontStyle.Regular.
	RenderFont (string familyName, float emSize, FontStyle style, GraphicsUnit unit)
	Initializes a new T:OFT.Rendering.Font using a specified size, style, and unit.
	RenderFont (string familyName, float emSize, FontStyle style, GraphicsUnit unit, byte gdiCharSet)
	Initializes a new T:OFT.Rendering.Font using a specified size, style, unit, and character set.
bool	Equals (RenderFont? other)
	Indicates whether the specified object is a T:OFT.Rendering.Font and has the same P:OFT.Rendering.Font.FontFamily, P:OFT.Rendering.Font.GdiVerticalFont, P:OFT.Rendering.Font.GdiCharSet, P:OFT.Rendering.Font.Style, P:OFT.Rendering.Font.Size, and P:OFT.Rendering.Font.Unit property values as this T:OFT.Rendering.Font.
override bool	Equals (object? obj)
override int	GetHashCode ()
override string	ToString ()

Properties
bool	Bold [get]
	Gets a value that indicates whether this T:OFT.Rendering.Font is bold.
string	FontFamily [get]
	Gets the T:OFT.Rendering.FontFamily associated with this T:OFT.Rendering.Font.
bool	Italic [get]
	Gets a value that indicates whether this T:OFT.Rendering.Font is italic.
float	Size [get]
	Gets the size of this T:OFT.Rendering.Font measured in the points (1/72 inch).
FontStyle	Style [get]
	Gets style information for this T:OFT.Rendering.Font.
GraphicsUnit	Unit [get]
	Gets the unit of measure for this T:OFT.Rendering.Font.

Detailed Description

Defines a particular format for text, including font face, size, and style attributes. This class cannot be inherited.

<filterpriority>1</filterpriority>

Constructor & Destructor Documentation

RenderFont() [1/5]

OFT.Rendering.Tools.RenderFont.RenderFont	(	string	familyName,
		float	emSize
	)

Initializes a new T:OFT.Rendering.Font using a specified size.

Parameters

familyName	A string representation of the T:OFT.Rendering.FontFamily for the new T:OFT.Rendering.Font.
emSize	The em-size, in points, of the new font.

RenderFont() [2/5]

OFT.Rendering.Tools.RenderFont.RenderFont	(	string	familyName,
		float	emSize,
		FontStyle	style
	)

Initializes a new T:OFT.Rendering.Font using a specified size and style.

Parameters

familyName	A string representation of the T:OFT.Rendering.FontFamily for the new T:OFT.Rendering.Font.
emSize	The em-size, in points, of the new font.
style	The T:OFT.Rendering.FontStyle of the new font.

RenderFont() [3/5]

OFT.Rendering.Tools.RenderFont.RenderFont	(	string	familyName,
		float	emSize,
		GraphicsUnit	unit
	)

Initializes a new T:OFT.Rendering.Font using a specified size and unit. The style is set to F:OFT.Rendering.FontStyle.Regular.

Parameters

familyName	A string representation of the T:OFT.Rendering.FontFamily for the new T:OFT.Rendering.Font.
emSize	The em-size of the new font in the units specified by the unit parameter.
unit	The T:OFT.Rendering.GraphicsUnit of the new font.

RenderFont() [4/5]

OFT.Rendering.Tools.RenderFont.RenderFont	(	string	familyName,
		float	emSize,
		FontStyle	style,
		GraphicsUnit	unit
	)

Initializes a new T:OFT.Rendering.Font using a specified size, style, and unit.

Parameters

familyName	A string representation of the T:OFT.Rendering.FontFamily for the new T:OFT.Rendering.Font.
emSize	The em-size of the new font in the units specified by the unit parameter.
style	The T:OFT.Rendering.FontStyle of the new font.
unit	The T:OFT.Rendering.GraphicsUnit of the new font.

RenderFont() [5/5]

OFT.Rendering.Tools.RenderFont.RenderFont	(	string	familyName,
		float	emSize,
		FontStyle	style,
		GraphicsUnit	unit,
		byte	gdiCharSet
	)

Initializes a new T:OFT.Rendering.Font using a specified size, style, unit, and character set.

Parameters

familyName	A string representation of the T:OFT.Rendering.FontFamily for the new T:OFT.Rendering.Font.
emSize	The em-size of the new font in the units specified by the unit parameter.
style	The T:OFT.Rendering.FontStyle of the new font.
unit	The T:OFT.Rendering.GraphicsUnit of the new font.
gdiCharSet	A T:System.Byte that specifies a GDI character set to use for this font.

Member Function Documentation

Equals() [1/2]

override bool OFT.Rendering.Tools.RenderFont.Equals

(

object?

obj

)

Equals() [2/2]

bool OFT.Rendering.Tools.RenderFont.Equals

(

RenderFont?

other

)

Indicates whether the specified object is a T:OFT.Rendering.Font and has the same P:OFT.Rendering.Font.FontFamily, P:OFT.Rendering.Font.GdiVerticalFont, P:OFT.Rendering.Font.GdiCharSet, P:OFT.Rendering.Font.Style, P:OFT.Rendering.Font.Size, and P:OFT.Rendering.Font.Unit property values as this T:OFT.Rendering.Font.

Returns

true if the other parameter is a T:OFT.Rendering.Font and has the same P:OFT.Rendering.Font.FontFamily, P:OFT.Rendering.Font.GdiVerticalFont, P:OFT.Rendering.Font.GdiCharSet, P:OFT.Rendering.Font.Style, P:OFT.Rendering.Font.Size, and P:OFT.Rendering.Font.Unit property values as this T:OFT.Rendering.Font; otherwise, false.

Parameters

other

The object to test.

<filterpriority>1</filterpriority>

GetHashCode()

override int OFT.Rendering.Tools.RenderFont.GetHashCode

(

)

ToString()

override string OFT.Rendering.Tools.RenderFont.ToString

(

)

Property Documentation

Bold

bool OFT.Rendering.Tools.RenderFont.Bold

get

Gets a value that indicates whether this T:OFT.Rendering.Font is bold.

Returns

true if this T:OFT.Rendering.Font is bold; otherwise, false.

<filterpriority>1</filterpriority>

FontFamily

string OFT.Rendering.Tools.RenderFont.FontFamily

get

Gets the T:OFT.Rendering.FontFamily associated with this T:OFT.Rendering.Font.

Returns

The T:OFT.Rendering.FontFamily associated with this T:OFT.Rendering.Font.

<filterpriority>1</filterpriority>

Italic

bool OFT.Rendering.Tools.RenderFont.Italic

get

Gets a value that indicates whether this T:OFT.Rendering.Font is italic.

Returns

true if this T:OFT.Rendering.Font is italic; otherwise, false.

<filterpriority>1</filterpriority>

Size

float OFT.Rendering.Tools.RenderFont.Size

get

Gets the size of this T:OFT.Rendering.Font measured in the points (1/72 inch).

Returns

The em-size of this T:OFT.Rendering.Font.

<filterpriority>1</filterpriority>

Style

FontStyle OFT.Rendering.Tools.RenderFont.Style

get

Gets style information for this T:OFT.Rendering.Font.

Returns

A T:OFT.Rendering.FontStyle enumeration that contains style information for this T:OFT.Rendering.Font.

<filterpriority>1</filterpriority>

Unit

GraphicsUnit OFT.Rendering.Tools.RenderFont.Unit

get

Gets the unit of measure for this T:OFT.Rendering.Font.

Returns

A T:OFT.Rendering.GraphicsUnit that represents the unit of measure for this T:OFT.Rendering.Font.

<filterpriority>1</filterpriority>

---

The documentation for this class was generated from the following file:

• RenderFont.cs