Style Class

Style Class

Represents the content and appearance of a grid cell.

Inheritance Hierarchy

SystemObject
Stingray.GridStyle

Namespace: Stingray.Grid
Assembly: Stingray.GridControl (in Stingray.GridControl.dll) Version: 14.0.0.0

Syntax

C++

Copy

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class Style : IDisposable

<TypeConverterAttribute(GetType(ExpandableObjectConverter))>
Public Class Style
	Implements IDisposable

[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class Style : IDisposable

The Style type exposes the following members.

Methods

	Name	Description
	Clone	Creates a new Style that is a copy of the current instance.

Top

Properties

	Name	Description
	AllowEnter	Gets or sets the Allow enter property.
	AutoSize	Gets or sets the auto size property.
	Borders	Gets or sets the appearance of cell borders.
	ChoiceList	Gets or sets choice list values.
	Control	Gets or sets the type of the embedded control.
	CustomControl	Sets the custom control to use with this cell.
	CustomControlHandle	Gets the custom control handle for the custom control used in this style.
	Draw3dFrame	Gets or sets the 3D effect of the cell.
	EllipseType	Gets or sets the type of ellipsis used when the text is longer than the cell.
	Enabled	Gets or sets the enabled state for the cell.
	FloatCell	Gets or sets the float cell property.
	FloodCell	Gets or sets the flood cell property.
	Format	Gets or sets the numeric format for the cell.
	HorzAlign	Gets or sets the horizontal alignment for a cell .
	IncludeAllowEnter	Gets or sets the state of the AllowEnter property.
	IncludeAutoSize	Gets or sets the state of the AutoSize property.
	IncludeBorders	Gets or sets the state of the Borders property.
	IncludeChoiceList	Gets or sets the state of the ChoiceList property.
	IncludeControl	Gets or sets the state of the Control property.
	IncludeDraw3dFrame	Gets or sets the state of the Draw3dFrame property.
	IncludeEnabled	Gets or sets the state of the Enabled property.
	IncludeFloatCell	Gets or sets state of the FloatCell property.
	IncludeFloodCell	Gets or sets the state of the FloodCell property.
	IncludeFormat	Gets or sets whether the Format property is set.
	IncludeHorzAlign	Gets or sets the state of the HorzAlign property.
	IncludeInterior	Gets or sets the state of the Interior property.
	IncludeItemData	Gets or sets the state of the ItemData property.
	IncludeMaxLength	Gets or sets the state of the MaxLength property.
	IncludeMergeCell	Gets or sets the state of the MergeCell property.
	IncludePlaces	Gets or sets whether the Places property is set.
	IncludeReadOnly	Gets or sets the state of the ReadOnly property.
	IncludeTextColor	Gets or sets the state of the TextColor property.
	IncludeTextFont	Gets or sets the state of the TextFont property.
	IncludeTriState	Gets or sets the state of the TriState property.
	IncludeValue	Gets or sets the state of the Value property.
	IncludeVertAlign	Gets or sets the state of the VertAlign property.
	IncludeVerticalScroll	Gets or sets the state of the VerticalScroll property.
	IncludeWrapText	Gets or sets the state of the WrapText property.
	InitialValue	Gets or sets the initial value of the spin control.
	Interior	Gets or sets the brush that is used to draw the interior area of a cell.
	ItemData	Gets or sets a pointer to a user defined item data.
	LowerBound	Gets or sets the lower bound of the spin control.
	Mask	Gets or sets a user-specified mask string.
	MaxLength	Gets or sets the maximum length of the stored value.
	MergeCell	Gets or sets how neighboring cells can be merged.
	OnlyNumericValues	Gets or sets whether the cell(s) contain only numeric values.
	Places	Gets or sets the number of decimal places displayed in numeric cells.
	Prompt	Gets or sets the user-specified input prompt.
	ReadOnly	Gets or sets the cell's read-only state.
	TextColor	Gets or sets the color of text in a cell.
	TextFont	Gets or sets the cell's text font.
	ToolTip	Gets or sets the string used for the cell tool tip.
	TriState	Gets or sets the tri-state property of the cell
	TypeOf	Gets or sets the type of the value.
	UpperBound	Gets or sets the upper bound of the spin control.
	ValidateMessage	Gets or sets the message to be displayed if the Style value is invalid.
	ValidMaximum	Gets or sets the highest valid value.
	ValidMinimum	Gets or sets the lowest valid value.
	Value	Gets or sets the value stored in the cell.
	VertAlign	Gets or sets the vertical alignment for the cell.
	VerticalScroll	Gets or sets the vertical scroll bar in a cell.
	WrapText	Gets or sets text wrap.
	WrapValue	Gets or sets the wrap property of a spin control.

Top

Remarks

A Style object contains all the information necessary for formatting a grid cell. A style consists of several attributes such as the text color, borders, control type, and font attributes. These styles can be modified by the end user using a .NET property grid.

An important feature of GridControl is its support for combining style objects. For example, you can copy only those attributes from one style to another style that are not initialized in the other style. This feature enables a kind of inheritance. By specifying a base style, GridControl inherits attributes from the base style at run time.

Base styles make it possible to group specific kinds of cells and give them similar attributes. The predefined base styles are:

row-header-style
column-header-style
standard-style

Row header cells inherit their attributes from row-header-style. Column headers inherit from column-header-style. standard-style is the base style for all cells in the grid.

Properties in the Style class are combined with an include-bit. This include-bit is true when an attribute is initialized and false if the attribute is not initialized. When the grid is drawn uninitialized, style properties of the cell's style object are filled with the base style's properties. If the Include<*> properties are false, Stingray Grid .NET tries to initialize the properties with the base style's setting. If Include<*> properties return true, the specific setting is used for drawing.

Note
The values returned from Style properties are to be considered valid ONLY if the corresponding Include<*> property returns true. For example, the value of the ReadOnly property is valid ONLY if the IncludeReadOnly property is true.

Most of the properties of a Style can be configured at design time in the designer property grid. However, at this time, the following properties can be configured only at run time through source code manipulation:

Reference

Stingray.Grid Namespace