Syncfusion.Grid.Windows
Members 


Syncfusion.Windows.Forms.Grid Namespace : GridStaticCellRenderer Class

GridStaticCellRenderer Class

Defines the renderer part of a static cell. A static cell renderer is also a base class for many other cell types and provides the inactive cell rendering for cell types that support editing (such as a text box or combo box).
Object Model
GridStaticCellRenderer ClassGridCurrentCell ClassGridStyleInfo ClassGridCellButton ClassIGridDropDownContainer InterfaceIGridDropDownCellImp InterfaceIGridDropDownCellImp InterfaceGridControlBase ClassGridCellModelBase ClassGridStyleInfo Class
Syntax
Remarks

A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridStaticCellModel if several views display the same GridModel.

The following table lists some characteristics about the Static cell type.

Item Description
CellType Static
Renderer GridStaticCellRenderer
Model GridStaticCellModel
XP Themes Support NA
Interactive Click Only
Floating Support Both
Base Type GridCellRendererBase

The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class.

PropertyName Description
GridStyleInfo.BackgroundImage (System.Drawing.Image) Gets / sets the image that the cell displays as background. (Default: NULL)
GridStyleInfo.BackgroundImageMode (GridBackgroundImageMode) Indicates how the background image is displayed. (Default: GridBackgroundImageMode)
GridStyleInfo.BaseStyle (System.String) The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
GridStyleInfo.Borders (GridBordersInfo) Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
GridStyleInfo.CellAppearance (GridCellAppearance) Specifies if cell edges shall be drawn raised, sunken, or flat (default). (Default: GridCellAppearance.Flat)
GridStyleInfo.CellTipText (System.String) ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
GridStyleInfo.CellType (System.String) Static. (Default: TextBox)
GridStyleInfo.CellValue (System.Object) This property holds the cell value. Although the cell value is typically a string, it can also be any other primitive type such as int, byte, enum, or any custom type that is derived from System.Object. (Default: String.Empty)
GridStyleInfo.CellValueType (System.Type) Specifies the preferred System.Type for cell values. When you assign a value to the GridStyleInfo object, the value will be converted to this type. If the value cannot be converted, GridStyleInfo.Error will contain error information. (Default: null)
GridStyleInfo.CultureInfo (System.Globalization.CultureInfo) The culture information holds rules for parsing and formatting the cells value. (Default: null)
GridStyleInfo.Enabled (System.Boolean) Specifies if the cell can be activated as current cell or if the cell should be skipped when moving the current cell. (Default: true)
GridStyleInfo.Error (System.String) Holds error information if a value could not be converted to the System.Type specified with GridStyleInfo.CellValueType. (Default: String.Empty)
GridStyleInfo.FloatCell (System.Boolean) Gets / sets if text can float into the boundaries of a neighboring cell. (Default: true)
GridStyleInfo.FloodCell (System.Boolean) Gets / sets if this cell can be flooded by a previous cell. (Default: true)
GridStyleInfo.Font (GridFontInfo) The font for drawing text. (Default: GridFontInfo.Default)
GridStyleInfo.Format (System.String) Gets / sets the format mask for formatting the cell value. You can specify numeric format strings, date format strings, or enumeration format strings as discussed in the section "Format Specifiers and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty)
GridStyleInfo.HorizontalAlignment (GridHorizontalAlignment) Specifies horizontal alignment of text in the cell. (Default: GridHorizontalAlignment.Left)
GridStyleInfo.HotkeyPrefix (System.Drawing.Text.HotkeyPrefix) Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show)
GridStyleInfo.ImageIndex (System.Int32) Specifies an index for an image in the GridStyleInfo.ImageList of a GridStyleInfo instance. (Default: -1)
GridStyleInfo.ImageList (System.Windows.Forms.ImageList) The GridStyleInfo.ImageList that holds a collection of images. Cells can choose images with the GridStyleInfo.ImageIndex property in a GridStyleInfo instance. (Default: NULL)
GridStyleInfo.Interior (Syncfusion.Drawing.BrushInfo) Lets you specify a solid backcolor, gradient, or pattern style with both back and forecolor for a cell's background. (Default: SystemColors.Window)
GridStyleInfo.MergeCell (GridMergeCellDirection) Specifies merge behavior for an individual cell when merging cells feature has been enabled in a GridModel with MergeCellsMode. (Default: GridMergeCellDirection.None)
GridStyleInfo.ReadOnly (System.Boolean) Specifies if cell contents can be modified by the user. You can programatically change Read-only cells by setting GridModel.DiscardReadOnly to True. (Default: False)
GridStyleInfo.Text (System.String) Gets / sets the value as a string. If a GridStyleInfo.CellValueType is specified, the text will be parsed and converted to the type specified with GridStyleInfo.CellValueType using any GridStyleInfo.CultureInfo information. (Default: String.Empty)
GridStyleInfo.TextColor (System.Drawing.Color) Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
GridStyleInfo.TextMargins (GridMarginsInfo) Holds text margins in pixels. When drawing a cell, this specifies the empty area between the text rectangle and the client rectangle of the cell without borders and cell buttons. (Default: GridMarginsInfo.Default)
GridStyleInfo.Trimming (System.Drawing.StringTrimming) Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
GridStyleInfo.ValidateValue (GridCellValidateValueInfo) Holds validation rules for the cell values that are being checked before any user changes are committed to the grid cell's style object. (Default: NULL)
GridStyleInfo.VerticalAlignment (GridVerticalAlignment) Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top)
GridStyleInfo.WrapText (System.Boolean) Specifies if text should be wrapped when it does not fit into a single line. (Default: true)

Inheritance Hierarchy

System.Object
   Syncfusion.ComponentModel.NonFinalizeDisposable
      Syncfusion.Windows.Forms.Grid.GridCellRendererBase
         Syncfusion.Windows.Forms.Grid.GridStaticCellRenderer
            Syncfusion.GridHelperClasses.DateTimeCellRenderer
            Syncfusion.GridHelperClasses.DoubleTextBoxCellRenderer
            Syncfusion.GridHelperClasses.IntegerTextBoxCellRenderer
            Syncfusion.Windows.Forms.Grid.GridCurrencyTextBoxCellRenderer
            Syncfusion.Windows.Forms.Grid.GridGenericControlCellRenderer
            Syncfusion.Windows.Forms.Grid.GridHeaderCellRenderer
            Syncfusion.Windows.Forms.Grid.GridImageCellRenderer
            Syncfusion.Windows.Forms.Grid.GridMaskEditCellRenderer
            Syncfusion.Windows.Forms.Grid.GridProgressBarCellRenderer
            Syncfusion.Windows.Forms.Grid.GridRadioButtonCellRenderer
            Syncfusion.Windows.Forms.Grid.GridRichControlEditCellRenderer
            Syncfusion.Windows.Forms.Grid.GridTextBoxCellRenderer
            Syncfusion.Windows.Forms.Grid.Grouping.GridNestedTableControlCellRenderer
            Syncfusion.Windows.Forms.Grid.Grouping.GridTableHeaderCellRenderer
            Syncfusion.Windows.Forms.PivotAnalysis.PivotGridExpandCellCellRenderer
            Syncfusion.Windows.Forms.PivotAnalysis.PivotGridHeaderCellRenderer
            Syncfusion.Windows.Forms.PivotAnalysis.PivotGridHyperlinkCellRenderer

AssemblyVersion

Syncfusion.Grid.Windows: 17.3460.0.26

See Also