OGFont Class

OGFont Class

This class represents a text font used in a grid cell.

Inheritance Hierarchy

SystemObject
Stingray.GridOGFont

Namespace: Stingray.Grid
Assembly: Stingray.GridUtils (in Stingray.GridUtils.dll) Version: [TAG_DECIMAL_VERSION]

Syntax

C++

Copy

[SerializableAttribute]
public class OGFont : ICloneable, ISerializable

<SerializableAttribute>
Public Class OGFont
	Implements ICloneable, ISerializable

[SerializableAttribute]
public ref class OGFont : ICloneable, ISerializable

The OGFont type exposes the following members.

Constructors

	Name	Description
	OGFont	Initializes a new empty font, with no properties set.
	OGFont(Font)	Creates an OGFont from a GDI+ font.
	OGFont(OGFont)	Copy constructor.
	OGFont(SerializationInfo, StreamingContext)	Internal.
	OGFont(String, Int32)	Initializes a new font.
	OGFont(String, Int32, Int32)	Initializes a new font.
	OGFont(String, Int32, Int32, Boolean, Boolean, Boolean, Boolean)	Initializes a new font.

Top

Methods

	Name	Description
	ChangeFont	Composes this font using a source font and a ModifyType for the operation.
	Clone	Creates a copy of this font.
	DefaultFont	Returns a font with all default values.
	GetFontKey	Returns the hash key for this OGFont.
	GetGdiPlusFont	Returns a GDI+ font equivalent to this OGFont.
	GetHashCode	Computes the hash key for this OGFont. (Overrides ObjectGetHashCode.)
	GetObjectData	Internal.
	IsSubSet	Indicates if this font is a subset of a specified font.
	SetBold	Internal.
	SetFaceName	Internal.
	SetItalic	Internal.
	SetOrientation	Internal.
	SetSize	Internal.
	SetStrikeOut	Internal.
	SetUnderLine	Internal.
	ToString	Internal. (Overrides ObjectToString.)

Top

Fields

	Name	Description
	includeBold	Bold included
	includeFaceName	FaceName included
	includeItalic	Italics included
	includeOrientation	Orientation included
	includeSize	Size included
	includeStrikeOut	StrikeOut included
	includeUnderLine	UnderLine included

Top

Properties

	Name	Description
	Bold	Gets a value that indicates if this font is bold.
	Description	Internal.
	FaceName	Gets the face name for this font.
	IncludeBold	Gets or sets a value to show that the Bold property is set.
	IncludeFaceName	Gets or sets a value to show that the FaceName property is set.
	IncludeItalic	Gets or sets a value to show that the Italic property is set.
	IncludeOrientation	Gets or sets a value to show that the Orientation property is set.
	IncludeSize	Gets or sets a value to show that the Size property is set.
	IncludeStrikeOut	Gets or sets a value to show that the StrikeOut property is set.
	IncludeUnderLine	Gets or sets a value to show that the UnderLine property is set.
	IsEmpty	Indicates if the font has no properties set.
	Italic	Gets a value that indicates if this font is italicized.
	Orientation	Gets the orientation of this font.
	Size	Gets the point size of this font.
	StrikeOut	Gets a value that indicates if this font is struck out.
	UnderLine	Gets a value that indicates if this font is underlined.

Top

Remarks

An instance of OGFont is available via the TextFont property on a grid Style object. The text font affects the appearance of the text in the grid cell. The following C# code shows how OGFont can be used to set the font for cell 1,1 to bold, underlined, 10pt Arial.

Copy

// Create the style, assign the font, and assign back to the grid
Style fontStyle = new Style();
fontStyle.TextFont = new OGFont("Arial", 10, 0, true, false, true, false);
fontStyle.Value = "Sample";
GridControl1[1, 1].Style = fontStyle;

// Directly assign the TextFont property of grid cell 1, 1
GridControl1[1, 1].Style.TextFont = new OGFont("Arial", 10, 0, true, false, true, false);
GridControl1[1, 1].Style.Value = "Sample";

Note: When creating a font for use in a grid cell style, only properties that are set are specifically applied to the cell's font. Any font properties that are not set are inherited from the table style. The code samples above use the OGFont constructor that sets all properties, causing the exact font to be used in the cell. If only the FaceName and Size are specified, the Orientation, Bold, Italic, UnderLine, and StrikeOut properties are inherited from the Grid's base style.

Reference

Stingray.Grid Namespace