menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridStyleInfo - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridStyleInfo

    Implements the functionalities that holds all information stored for a cell.

    Inheritance
    System.Object
    ShouldSerializeBasedPersisterType
    StyleInfoBase
    GridStyleInfo
    GridTableCellStyleInfo
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    Inherited Members
    ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)
    ShouldSerializeBasedPersisterType.CheckAllProperties
    ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)
    ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)
    StyleInfoBase.BeginInit()
    StyleInfoBase.BeginUpdate()
    StyleInfoBase.CacheValues
    StyleInfoBase.Changed
    StyleInfoBase.Changing
    StyleInfoBase.ClearCache()
    StyleInfoBase.CopyFrom(IStyleInfo)
    StyleInfoBase.Dispose()
    StyleInfoBase.Dispose(Boolean)
    StyleInfoBase.EndInit()
    StyleInfoBase.EndUpdate()
    StyleInfoBase.Equals(Object)
    StyleInfoBase.EqualsObject(Object, Object)
    StyleInfoBase.GetDefaultStyleInfoStore(StyleInfoProperty)
    StyleInfoBase.GetDefaultValue(StyleInfoProperty)
    StyleInfoBase.GetHashCode()
    StyleInfoBase.GetShortValue(StyleInfoProperty)
    StyleInfoBase.GetValue(StyleInfoProperty)
    StyleInfoBase.HasValue(StyleInfoProperty)
    StyleInfoBase.IConvertible.GetTypeCode()
    StyleInfoBase.IConvertible.ToBoolean(IFormatProvider)
    StyleInfoBase.IConvertible.ToByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToChar(IFormatProvider)
    StyleInfoBase.IConvertible.ToDateTime(IFormatProvider)
    StyleInfoBase.IConvertible.ToDecimal(IFormatProvider)
    StyleInfoBase.IConvertible.ToDouble(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt32(IFormatProvider)
    StyleInfoBase.IConvertible.ToInt64(IFormatProvider)
    StyleInfoBase.IConvertible.ToSByte(IFormatProvider)
    StyleInfoBase.IConvertible.ToSingle(IFormatProvider)
    StyleInfoBase.IConvertible.ToString(IFormatProvider)
    StyleInfoBase.IConvertible.ToType(Type, IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt16(IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt32(IFormatProvider)
    StyleInfoBase.IConvertible.ToUInt64(IFormatProvider)
    StyleInfoBase.Identity
    StyleInfoBase.InheritStyle(IStyleInfo, StyleModifyType)
    StyleInfoBase.IntGetDefaultStyleInfo(StyleInfoProperty)
    StyleInfoBase.IsChanged
    StyleInfoBase.IsEmpty
    StyleInfoBase.IsSubset(IStyleInfo)
    StyleInfoBase.IsValueModified(StyleInfoProperty)
    StyleInfoBase.MergeStyle(IStyleInfo)
    StyleInfoBase.OnStyleChanging(StyleInfoProperty)
    StyleInfoBase.ParseString(String)
    StyleInfoBase.ReadXml(XmlReader)
    StyleInfoBase.ResetValue(StyleInfoProperty)
    StyleInfoBase.SetStore(StyleInfoStore)
    StyleInfoBase.SetValue(StyleInfoProperty, Int16)
    StyleInfoBase.SetValue(StyleInfoProperty, Object)
    StyleInfoBase.ToString()
    StyleInfoBase.ToString(String)
    StyleInfoBase.ToString(String, IFormatProvider)
    StyleInfoBase.Updating
    StyleInfoBase.WeakReferenceChangedListeners
    StyleInfoBase.WriteXml(XmlWriter)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public class GridStyleInfo : StyleInfoBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable
    Remarks

    GridStyleInfo provides user-friendly access to all properties stored in GridStyleInfoStore. It also has Identity information and can inherit properties from base styles (row styles, column styles, table style).

    GridModel provides a very simple way to query and change cell contents using the indexer.

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

    PropertyNameDescription
    AllowEnter (System.Boolean)Gets / sets if pressing the <Enter>-Key should insert a new line into the edited text. (Default: False)
    AutoSize (System.Boolean)Gets / sets if the cell height should automatically increase when the edited text does not fit into the cell and WrapText is True. If WrapText is False, AutoSize will affect the column width. (Default: False)
    BackgroundImage (System.Drawing.Image)Gets / sets the image that the cell displays as background. (Default: NULL)
    BackgroundImageMode (GridBackgroundImageMode)Indicates how the background image is displayed. (Default: GridBackgroundImageMode)
    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)
    Borders (GridBordersInfo)Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
    CellAppearance (GridCellAppearance)Specifies if cell edges shall be drawn raised, sunken, or flat (default). (Default: GridCellAppearance.Flat)
    CellTipText (System.String)ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
    CellType (System.String)The cell type for this style instance. Cell types are accessed in the grid through the CellModels property of a GridModel which returns a GridCellModelBase object. To access cell renderers, use the CellRenderers property of a GridControlBase instance. (Default: Text Box)
    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)
    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, Error will contain error information. (Default: NULL)
    CharacterCasing (System.Windows.Forms.CharacterCasing)Specifies if cell control modifies the case of characters as they are typed when the cell's CellType is "OriginalTextBox". (Default: CharacterCasing.Normal)
    CheckBoxOptions (GridCheckBoxCellInfo)Gets / sets flat look and values that represent checked, unchecked, and indeterminate state of the check box. (Default: NULL)
    ChoiceList (System.Collections.Specialized.StringCollection)Specifies items to be displayed in a drop-down list. (Default: NULL)
    Clickable (System.Boolean)Specifies if the user can click on any cell button elements in this renderer. (Default: true)
    Control (System.Windows.Forms.Control)A custom control you can associate with a cell. (Default: null)
    CultureInfo (System.Globalization.CultureInfo)The culture information holds rules for parsing and formatting the cells value. (Default: null)
    CurrencyEdit (GridCurrencyEditInfo)A nested object with currency text box properties for a cell. (Default: GridCurrencyEditInfo.Default)
    DataSource (System.Object)Specifies a data source that holds items to be displayed in a drop-down list. A data source can be specified instead of manually filling the choicelist with string entries. (Default: NULL)
    Description (System.String)Gets / sets the text that is shown in check box or pushbuttons. (Default: String.Empty)
    DisplayMember (System.String)Names the property in the DataSource that holds the text to be displayed in a cell that depends on a ValueMember. (Default: String.Empty)
    DropDownStyle (GridDropDownStyle)Specifies if user input is restricted to items from the ChoiceList or DataSource. (Default: GridDropDownStyle.Editable)
    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)
    Error (System.String)Holds error information if a value could not be converted to the System.Type specified with CellValueType. (Default: String.Empty)
    ExclusiveChoiceList (System.Boolean)Specifies if user input is restricted to items from the ChoiceList or DataSource. (Default: False)
    FloatCell (System.Boolean)Gets / sets if text can float into the boundaries of a neighboring cell. (Default: True)
    FloodCell (System.Boolean)Gets / sets if this cell can be flooded by a previous cell. (Default: True)
    Font (GridFontInfo)The font for drawing text. (Default: GridFontInfo.Default)
    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)
    FormulaTag (GridFormulaTag)A formula tag that is associated with a cell. (Default: NULL)
    HorizontalAlignment (GridHorizontalAlignment)Specifies horizontal alignment of text in the cell. (Default: GridHorizontalAlignment.Left)
    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)
    ImageIndex (System.Int32)Specifies an index for an image in the ImageList of a GridStyleInfo instance. (Default: -1)
    ImageList (System.Windows.Forms.ImageList)The ImageList that holds a collection of images. Cells can choose images with the ImageIndex property in a GridStyleInfo instance. (Default: NULL)
    Interior (BrushInfo) Lets you specify a solid back color, gradient, or pattern style with both back and fore color for a cell's background. (Default: SystemColors.Window)
    MaskEdit (GridMaskEditInfo)A nested object with masked edit properties for a cell. (Default: GridMaskEditInfo.Default)
    MaxLength (System.Int32)Limits the number of characters the user can type into the cell. Note: When selecting text from a choice list or when pasting text, the text can be longer. Additional validation is necessary on your side. (Default: 0)
    MergeCell (GridMergeCellDirection)Specifies merge behavior for an individual cell when merging cells feature has been enabled in a GridModel with MergeCellsMode. (Default: GridMergeCellDirection.None)
    NumericUpDown (GridNumericUpDownCellInfo)NumericUpDown lets you specify the step, minimum, and maximum value and if the value should start over when you reach the maximum value. (Default: NULL)
    PasswordChar (System.Char)The character used to mask characters of a password in a password-entry cell. The cell's CellType must be "OriginalTextBox". (Default: Blank)
    ProgressBar (GridProgressBarInfo)A nested object with ProgressBar properties for a cell. Default: GridProgressBarInfo.Default)
    ReadOnly (System.Boolean)Specifies if cell contents can be modified by the user. You can programatically change Read-only cells by setting DiscardReadOnly to True. (Default: False)
    ShowButtons (GridShowButtons)Specifies when to show or display the cell buttons. Possible choices are: show the button only for the current cell, always show buttons, or never show buttons. (Default: GridShowButtons.Show)
    StrictValueType (System.Boolean)Indicates whether an exception should be thrown in the ApplyFormattedText(String) method if the formatted text can not be parsed and converted to the type specified with CellValueType. (Default: True)
    Tag (System.Object)A custom tag you can associate with a cell. (Default: NULL)
    Text (System.String)Gets / sets the value as a string. If a CellValueType is specified, the text will be parsed and converted to the type specified with CellValueType using any CultureInfo information. (Default: String.Empty)
    TextAlign (GridTextAlign)Align text left of button elements (which is typical for combo boxes). Or align text right of button elements. (Default: GridTextAlign.Default)
    TextColor (System.Drawing.Color)Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
    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)
    Themed (System.Boolean)Specifies if cell should be drawn using Windows XP themes when ThemesEnabled has been set. (Default: True)
    TriState (System.Boolean)Specifies if this is a Tristate check box that has an additional indeterminate state. (Default: False)
    Trimming (System.Drawing.StringTrimming)Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
    ValidateValue (GridCellValidateValueInfo)Holds validation rules for the cell value that are being checked before any user changes are committed to the grid cells style object. (Default: NULL)
    ValueMember (System.String)Gets / sets a string that specifies the property of the data source from which to draw the value. (Default: String.Empty)
    VerticalAlignment (GridVerticalAlignment)Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top)
    VerticalScrollbar (System.Boolean)Specifies if text box should show a vertical scrollbar when text is being edited and does not fit in cell. WrapText must be initialized to True. (Default: False)
    WrapText (System.Boolean)Specifies if text should be wrapped when it does not fit into a single line. (Default: True)

    Examples

    The following example makes some changes to the grid using the indexer:

                model[2, 2].Text = "Grid Demo";
                model[2, 2].Font.Bold = True;
                model[2, 2].Font.Size = 16;
                model[2, 2].HorizontalAlignment = GridHorizontalAlignment.Center;
                model[2, 2].VerticalAlignment = GridVerticalAlignment.Middle;
                model[2, 2].CellType = "Static";
                model[2, 2].Borders.All = new GridBorder(GridBorderStyle.Solid, Color.FromArgb(100, 238, 122, 3));
                model[2, 2].Interior = new BrushInfo(GradientStyle.PathEllipse, Color.FromArgb(100, 57, 73, 122), Color.FromArgb(237, 240, 247));

    If you query for specific attributes in a cell and these attributes have not been explicitly set for the cell, the GridStyleInfo object that is return by the indexer is smart enough to query base styles for queried information.

                GridStyleInfo standard = model.BaseStylesMap["Standard"].StyleInfo;
                standard.TextColor = Color.FromArgb(0, 21, 84);
                    Color color = model[1, 1].TextColor;
                    // model[1, 1].TextColor will return Color.FromArgb(0, 21, 84));

    Constructors

    GridStyleInfo()

    Initializes the new instance of the GridStyleInfo class.

    Declaration
    public GridStyleInfo()

    GridStyleInfo(StyleInfoIdentityBase)

    Initializes the new instance of the GridStyleInfo class and associates it with an existing GridStyleInfoIdentity.

    Declaration
    public GridStyleInfo(StyleInfoIdentityBase identity)
    Parameters
    Type Name Description
    StyleInfoIdentityBase identity

    A GridStyleInfoIdentity that holds the identity for this GridStyleInfo.

    GridStyleInfo(StyleInfoIdentityBase, GridStyleInfoStore)

    Initializes the new instance of the GridStyleInfo class object and associates it with an existing GridStyleInfoIdentity.

    Declaration
    public GridStyleInfo(StyleInfoIdentityBase identity, GridStyleInfoStore store)
    Parameters
    Type Name Description
    StyleInfoIdentityBase identity

    A GridStyleInfoIdentity that holds the identity for this GridStyleInfo.

    GridStyleInfoStore store

    A GridStyleInfoStore that holds data for this GridStyleInfo. All changes in this style object will be saved in the GridStyleInfoStore object.

    GridStyleInfo(StyleInfoIdentityBase, GridStyleInfoStore, Boolean)

    Initializes the new instance of the GridStyleInfo class and associates it with an existing GridStyleInfoIdentity.

    Declaration
    public GridStyleInfo(StyleInfoIdentityBase identity, GridStyleInfoStore store, bool cacheValues)
    Parameters
    Type Name Description
    StyleInfoIdentityBase identity

    A GridStyleInfoIdentity that holds the identity for this GridStyleInfo.

    GridStyleInfoStore store

    A GridStyleInfoStore that holds data for this GridStyleInfo. All changes in this style object will be saved in the GridStyleInfoStore object.

    System.Boolean cacheValues

    set the bool value for cacheValues

    GridStyleInfo(GridStyleInfo)

    Initializes the new instance of the GridStyleInfo class and copies all data from an existing style object.

    Declaration
    public GridStyleInfo(GridStyleInfo style)
    Parameters
    Type Name Description
    GridStyleInfo style

    The style object that contains the original data.

    GridStyleInfo(GridStyleInfoStore)

    Initializes the new instance of the GridStyleInfo class and associates it with an existing GridStyleInfoStore.

    Declaration
    public GridStyleInfo(GridStyleInfoStore store)
    Parameters
    Type Name Description
    GridStyleInfoStore store

    A GridStyleInfoStore that holds data for this GridStyleInfo. All changes in this style object will be saved in the GridStyleInfoStore object.

    Fields

    Empty

    An empty style object.

    Declaration
    public static readonly GridStyleInfo Empty
    Field Value
    Type
    GridStyleInfo

    Properties

    AllowEnter

    Gets or sets a value indicating whether pressing the <Enter>-Key should insert a new line into the edited text.

    Declaration
    public bool AllowEnter { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the AllowEnter property is False.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    AutoCompleteInEditMode

    Gets or sets the value whether the cell can have AutoComplete, AutoSuggest, Both and None behavior in Editable mode.

    Declaration
    [SerializeProperty(true)]
    public GridComboSelectionOptions AutoCompleteInEditMode { get; set; }
    Property Value
    Type
    GridComboSelectionOptions

    AutoFit

    Provides an option for displaying the cell with symbols when the contents in cell exceeds it's width.

    Declaration
    public AutoFitOptions AutoFit { get; set; }
    Property Value
    Type
    AutoFitOptions
    Examples

    This example shows how to set the AutoFitOptions.

    //Display special characters when the contents in cell exceeds it's width.
    this.gridControl1.TableStyle.AutoFit = AutoFitOptions.Alphabet;
    this.gridControl1.TableStyle.AutoFit = AutoFitOptions.Numeric;
    this.gridControl1.TableStyle.AutoFit = AutoFitOptions.Both;
    this.gridControl1.TableStyle.AutoFit = AutoFitOptions.None;
    'Display special characters when the contents in cell exceeds it's width.
     Me.gridControl1.TableStyle.AutoFit = AutoFitOptions.Alphabet
     Me.gridControl1.TableStyle.AutoFit = AutoFitOptions.Numeric
     Me.gridControl1.TableStyle.AutoFit = AutoFitOptions.Both
     Me.gridControl1.TableStyle.AutoFit = AutoFitOptions.None

    AutoFitChar

    Obtains the desired character to be displayed in cell when the contents in cell exceeds the width.

    Declaration
    public char AutoFitChar { get; set; }
    Property Value
    Type
    System.Char
    Examples

    This example shows how to obtain the desired character to be displayed in cell when the contents in cell exceeds the width.

    //Display special characters when the contents in cell exceeds it's width.
    this.gridControl1.TableStyle.AutoFit = AutoFitOptions.Alphabet;
    //Set the character to display when the contents in cell exceeds it's width. 
    this.gridControl1.TableStyle.AutoFitChar = 's';
    'Display special characters when the contents in cell exceeds it's width.
      Me.gridControl1.TableStyle.AutoFit = AutoFitOptions.Alphabet
    'Set the character to display when the contents in cell exceeds it's width. 
    this.gridControl1.TableStyle.AutoFitChar = 's';

    AutoSize

    Gets or sets a value indicating whether the cell height should automatically increase when the edited text does not fit into the cell and WrapText is True. If WrapText is False, AutoSize will affect the column width.

    Declaration
    public bool AutoSize { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the AutoSize property is False.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    BackColor

    Gets or sets a shortcut to get the backcolor of a cell instead of using Interior.

    Declaration
    public Color BackColor { get; set; }
    Property Value
    Type
    System.Drawing.Color
    Examples

    This example shows how to apply the back color for a cell.

    //Setting the back color for GridTable.
    this.gridControl1.TableStyle.BackColor = Color.Red;
    'Setting the back color for GridTable.
    Me.gridControl1.TableStyle.BackColor = Color.Red

    BackgroundImage

    Gets or sets the image that the cell displays as background.

    Declaration
    public Image BackgroundImage { get; set; }
    Property Value
    Type
    System.Drawing.Image
    Remarks

    The default value for the BackgroundImage property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)
    • langword_csharp_Currency (GridCurrencyTextBoxCellRenderer)
    • langword_csharp_MaskEdit (GridMaskEditCellRenderer)
    • langword_csharp_FormulaCell (GridFormulaCellRenderer)
    • langword_csharp_OriginalTextBox (GridOriginalTextBoxCellRenderer)

    Examples

    This example show how to set the back ground image for the cells.

    Image image = Image.FromFile(@"\...\...\FileName.jpg");
    this.gridControl1.TableStyle.BackgroundImage = image;
    Dim image As Image = Image.FromFile("\...\...\FileName.jpg")
    Me.gridControl1.TableStyle.BackgroundImage = image

    BackgroundImageID

    Gets or sets the Namespace ID that contains the cell's background information id.

    Declaration
    public string BackgroundImageID { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the BackgroundImageID property is "".

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)
    • langword_csharp_Currency (GridCurrencyTextBoxCellRenderer)
    • langword_csharp_MaskEdit (GridMaskEditCellRenderer)
    • langword_csharp_FormulaCell (GridFormulaCellRenderer)
    • langword_csharp_OriginalTextBox (GridOriginalTextBoxCellRenderer)

    BackgroundImageMode

    Gets or sets how the background image is displayed.

    Declaration
    public GridBackgroundImageMode BackgroundImageMode { get; set; }
    Property Value
    Type
    GridBackgroundImageMode
    Remarks

    Valid values for this property are taken from the GridBackgroundImageMode enumeration. By default, in BackgroundImageModeMode.Normal mode, the Image is placed in the upper left corner of the cell(s), and any part of the image too big for the cell(s) is clipped. Using the GridBackgroundImageModeMode.StretchImage value causes the image to stretch to fit the cell(s).

    The default value for the BackgroundImageMode property is GridBackgroundImageMode.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)
    • langword_csharp_Currency (GridCurrencyTextBoxCellRenderer)
    • langword_csharp_MaskEdit (GridMaskEditCellRenderer)
    • langword_csharp_FormulaCell (GridFormulaCellRenderer)
    • langword_csharp_OriginalTextBox (GridOriginalTextBoxCellRenderer)

    BaseStyle

    Gets or sets the base style for this style instance with default values for properties that are not initialized for this style object.

    Declaration
    public string BaseStyle { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the BaseStyle property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    BorderMargins

    Gets or sets extra border margins in pixels. When drawing a cell, this specifies the area between the cell rectangle without border and the inner rectangle of the cell with cell buttons. Is most useful if you want to customize DrawCellFrameAppearance

    Declaration
    public GridMarginsInfo BorderMargins { get; set; }
    Property Value
    Type
    GridMarginsInfo
    Remarks

    The default value for the BorderMargins property is GridMarginsInfo.Empty.

    The property affects the behavior or appearance of call cell types:

    Borders

    Gets or sets Top, left, bottom, and right border settings.

    Declaration
    public GridBordersInfo Borders { get; set; }
    Property Value
    Type
    GridBordersInfo
    Remarks

    The default value for the Borders property is GridBordersInfo.Default.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    CellAppearance

    Gets or sets if cell edges shall be drawn raised, sunken, or flat (default).

    Declaration
    public GridCellAppearance CellAppearance { get; set; }
    Property Value
    Type
    GridCellAppearance
    Remarks

    The default value for the CellAppearance property is GridCellAppearance.Flat.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Examples

    This example shows how to set the appearance of a cell.

    //Set the Cell Appearance.
    this.gridControl1.TableStyle.CellAppearance = GridCellAppearance.Sunken;
    'Set the Cell Appearance.
     Me.gridControl1.TableStyle.CellAppearance = GridCellAppearance.Sunken

    CellIdentity

    Gets or sets identity information such as row and column index for the current GridStyleInfo.

    Declaration
    public GridStyleInfoIdentity CellIdentity { get; set; }
    Property Value
    Type
    GridStyleInfoIdentity

    CellModel

    Gets the associated GridCellModelBase for this style object.

    Declaration
    public GridCellModelBase CellModel { get; }
    Property Value
    Type
    GridCellModelBase

    CellTipText

    Gets or sets ToolTip text to be displayed when user hovers mouse over cell.

    Declaration
    public string CellTipText { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the CellTipText property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    CellType

    Gets or sets the cell type for this style instance. Cell types are accessed in the grid through the CellModels property of a GridModel which returns a GridCellModelBase object. To access cell renderers use the CellRenderers property of a GridControlBase instance.

    Declaration
    public string CellType { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the CellType property is Text Box.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)
    • langword_csharp_Currency (GridCurrencyTextBoxCellRenderer)
    • langword_csharp_MaskEdit (GridMaskEditCellRenderer)
    • langword_csharp_FormulaCell (GridFormulaCellRenderer)
    • langword_csharp_RichText (GridRichTextBoxCellRenderer)
    • langword_csharp_Control (GridGenericControlCellRenderer)
    • langword_csharp_OriginalTextBox (GridOriginalTextBoxCellRenderer)
    • langword_csharp_ProgressBar (GridProgressBarCellRenderer)
    • langword_csharp_RadioButton (GridRadioButtonCellRenderer)

    CellValue

    Gets or sets 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.

    Declaration
    public object CellValue { get; set; }
    Property Value
    Type
    System.Object
    Remarks

    The default value for the CellValue property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    TODO: Explain how to set StylePropertyInfo.IsCloneable = false and StylePropertyInfo.IsDisposable = false or implement IStyleCloneable to avoid cloning and disposing of objects assigned to Tag.

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    CellValueType

    Gets or sets 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, Error will contain error information.

    Declaration
    public Type CellValueType { get; set; }
    Property Value
    Type
    System.Type
    Remarks

    The default value for the CellValueType property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    CharacterCasing

    Gets or sets if cell control modifies the case of characters as they are typed when the cell's CellType is "OriginalTextBox".

    Declaration
    public CharacterCasing CharacterCasing { get; set; }
    Property Value
    Type
    System.Windows.Forms.CharacterCasing
    Remarks

    The default value for the CharacterCasing property is CharacterCasing.Normal.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_OriginalTextBox (GridOriginalTextBoxCellRenderer)

    Examples

    This example shows how to specify the case of characters in a text box.

    //Set the character case          
    this.gridControl1.TableStyle.CharacterCasing = CharacterCasing.Upper;
    'Set the character case       
    Me.gridControl1.TableStyle.CharacterCasing = CharacterCasing.Upper

    CheckBoxOptions

    Gets or sets flat look and values that represent checked, unchecked, and indeterminated state of the check box.

    Declaration
    public GridCheckBoxCellInfo CheckBoxOptions { get; set; }
    Property Value
    Type
    GridCheckBoxCellInfo
    Remarks

    The default value for the CheckBoxOptions property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)

    ChoiceList

    Gets or sets items to be displayed in a drop-down list.

    Declaration
    public StringCollection ChoiceList { get; set; }
    Property Value
    Type
    System.Collections.Specialized.StringCollection
    Remarks

    The default value for the ChoiceList property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)

    Clickable

    Gets or sets a value indicating whether the user can click on any cell button elements in this renderer.

    Declaration
    public bool Clickable { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the Clickable property is True.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)

    CommentTip

    Gets or sets the comment tip for a cell. The CommentTip is itself an expandable object with several properties that can be set individually and participate in style inheritance mechanism.

    Declaration
    public GridCommentTipInfo CommentTip { get; set; }
    Property Value
    Type
    GridCommentTipInfo
    Remarks

    The default value for the CommentTip property is GridCommentTip.Default.

    The property affects the behavior or appearance of the following cell types:

    Control

    Gets or sets a custom control you can associate with a cell.

    Declaration
    [DisposeableProperty(false)]
    [CloneableProperty(false)]
    public Control Control { get; set; }
    Property Value
    Type
    System.Windows.Forms.Control
    Remarks

    The default value for the Control property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_Control (GridGenericControlCellRenderer)

    CultureInfo

    Gets or sets the culture information holds rules for parsing and formatting the cell's value.

    Declaration
    [CloneableProperty(false)]
    [DisposeableProperty(false)]
    public CultureInfo CultureInfo { get; set; }
    Property Value
    Type
    System.Globalization.CultureInfo
    Remarks

    The default value for the CultureInfo property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    CurrencyEdit

    Gets or sets CurrencyEdit state. CurrencyEdit is itself an expandable object with several properties that can be set individually and participate in style inheritance mechanism.

    Declaration
    public GridCurrencyEditInfo CurrencyEdit { get; set; }
    Property Value
    Type
    GridCurrencyEditInfo
    Remarks

    The default value for the CurrencyEdit property is GridCurrencyEditInfo.Default.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_Currency (GridCurrencyTextBoxCellRenderer)

    CustomProperties

    Gets a collection of custom property objects that have at least one initialized value. The primary purpose of this collection is to support design-time code serialization of custom properties.

    Declaration
    public GridStyleInfoCustomPropertiesCollection CustomProperties { get; }
    Property Value
    Type
    GridStyleInfoCustomPropertiesCollection

    DataSource

    Gets or sets a data source that holds items to be displayed in a drop-down list. A datasource can be specified instead of manually filling the choicelist with string entries.

    Declaration
    [CloneableProperty(false)]
    [DisposeableProperty(false)]
    public object DataSource { get; set; }
    Property Value
    Type
    System.Object
    Remarks

    The default value for the DataSource property is null.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)

    Default

    Gets a GridStyleInfo with default settings.

    Declaration
    public static GridStyleInfo Default { get; }
    Property Value
    Type
    GridStyleInfo

    Description

    Gets or sets the text that is shown in check box or pushbuttons.

    Declaration
    public string Description { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the Description property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)

    DisplayMember

    Gets or sets the Name the property in the DataSource that holds the text to be displayed in a cell that depends on a ValueMember.

    Declaration
    public string DisplayMember { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the DisplayMember property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)

    DropDownStyle

    Gets or sets if user input is restricted to items from the ChoiceList or DataSource.

    Declaration
    public GridDropDownStyle DropDownStyle { get; set; }
    Property Value
    Type
    GridDropDownStyle
    Remarks

    The default value for the DropDownStyle property is GridDropDownStyle.Editable.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)

    Enabled

    Gets or sets a value indicating whether the cell can be activated as current cell or if the cell should be skipped when moving the current cell.

    Declaration
    public bool Enabled { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the Enabled property is True.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Error

    Gets or sets error information if a text could not be converted to the System.Type specified with CellValueType in FormattedText or Text setter.

    Declaration
    public string Error { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the Error property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    ExclusiveChoiceList

    Gets or sets a value indicating whether user input is restricted to items from the ChoiceList or DataSource. Use DropDownStyle instead.

    Declaration
    public bool ExclusiveChoiceList { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the ExclusiveChoiceList property is False.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)

    FixSubObjectsDerivedFromRowandColStyle

    Gets or sets a value indicating whether the cells are derived from row and column styles. In the case that the base style that implements a specific sub-object (e.g. Borders, Font, ...) is a row style the column style would be ignored if we return here the sub-object row of the row style in the optimized ReadOnlyBorders property. Returning the normal Borders objects instead fixes this problem.

    Declaration
    public static bool FixSubObjectsDerivedFromRowandColStyle { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    Default value is true. You can set it false if you relied on previous fault behavior.

    Examples

    This example shows how to use the FixSubObjectsDerivedFromRowandColStyle property.

    this.gridControl1.Model.RowStyles[row - 1].Borders.Bottom = new GridBorder(GridBorderStyle.Solid, c, GridBorderWeight.ExtraExtraThick);
    this.gridControl1.Model.ColStyles[col - 1].Borders.Right = new GridBorder(GridBorderStyle.Solid, c, GridBorderWeight.ExtraExtraThick);
    GridBordersInfo b = this.gridControl1.Model[row - 1, col - 1].ReadOnlyBorders;
    Console.WriteLine(b.Right); // will return Default since ReadOnlyBorders is RowStyles[row - 1].Borders which
    has no knowledge about ColStyles if FixSubObjectsDerivedFromRowandColStyle = false.
    

    Setting FixSubObjectsDerivedFromRowandColStyle = true fixes the problem.

    FloatCell

    Gets or sets a value indicating whether text can float into the boundaries of a neighboring cell.

    Declaration
    public bool FloatCell { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the FloatCell property is True.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    FloodCell

    Gets or sets a value indicating whether this cell can be flooded by a previous cell.

    Declaration
    public bool FloodCell { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the FloodCell property is True.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Font

    Gets or sets the font for drawing text.

    Declaration
    public GridFontInfo Font { get; set; }
    Property Value
    Type
    GridFontInfo
    Remarks

    The default value for the font property is GridFontInfo.Default.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Format

    Gets or 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)

    Declaration
    public string Format { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the Format property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    FormatPreview

    Gets a formatted text for the default value for a specified CellValueType.

    Declaration
    public string FormatPreview { get; }
    Property Value
    Type
    System.String

    FormattedText

    Gets or sets the value formatted with the Format mask and custom formatting of the GetFormattedText(GridStyleInfo, Object, Int32) method of the associated GridCellModelBase or sets the value by calling the ApplyFormattedText(GridStyleInfo, String, Int32) of the associated GridCellModelBase.

    Declaration
    public string FormattedText { get; set; }
    Property Value
    Type
    System.String

    FormulaTag

    Gets or sets a formula tag that is associated with a cell.

    Declaration
    [SerializeProperty(true)]
    public GridFormulaTag FormulaTag { get; set; }
    Property Value
    Type
    GridFormulaTag
    Remarks

    The default value for the FormulaTag property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_FormulaCell (GridFormulaCellRenderer)

    GdipFont

    Gets returns or creates a cached GDI+ font generated from font information of the Font object.

    Declaration
    public Font GdipFont { get; }
    Property Value
    Type
    System.Drawing.Font

    HasAllowEnter

    Gets a value indicating whether AllowEnter has been initialized for the current object.

    Declaration
    public bool HasAllowEnter { get; }
    Property Value
    Type
    System.Boolean

    HasAutoFit

    Gets a value indicating whether AutoFit has been initialized for the current object.

    Declaration
    public bool HasAutoFit { get; }
    Property Value
    Type
    System.Boolean

    HasAutoFitChar

    Gets a value indicating whether AutoFitChar has been initialized for the current object.

    Declaration
    public bool HasAutoFitChar { get; }
    Property Value
    Type
    System.Boolean

    HasAutoSize

    Gets a value indicating whether AutoSize has been initialized for the current object.

    Declaration
    public bool HasAutoSize { get; }
    Property Value
    Type
    System.Boolean

    HasBackgroundImage

    Gets a value indicating whether BackgroundImage state has been initialized for the current object.

    Declaration
    public bool HasBackgroundImage { get; }
    Property Value
    Type
    System.Boolean

    HasBackgroundImageID

    Gets a value indicating whether BackgroundImage state has been initialized for the current object.

    Declaration
    public bool HasBackgroundImageID { get; }
    Property Value
    Type
    System.Boolean

    HasBackgroundImageMode

    Gets a value indicating whether BackgroundImageMode state has been initialized for the current object.

    Declaration
    public bool HasBackgroundImageMode { get; }
    Property Value
    Type
    System.Boolean

    HasBaseStyle

    Gets a value indicating whether BaseStyle has been initialized for the current object.

    Declaration
    public bool HasBaseStyle { get; }
    Property Value
    Type
    System.Boolean

    HasBorderMargins

    Gets a value indicating whether BorderMargins has been initialized for the current object.

    Declaration
    public bool HasBorderMargins { get; }
    Property Value
    Type
    System.Boolean

    HasBorders

    Gets a value indicating whether border information has been initialized for the current object.

    Declaration
    public bool HasBorders { get; }
    Property Value
    Type
    System.Boolean

    HasCellAppearance

    Gets a value indicating whether CellAppearance has been initialized for the current object.

    Declaration
    public bool HasCellAppearance { get; }
    Property Value
    Type
    System.Boolean

    HasCellTipText

    Gets a value indicating whether CellTipText has been initialized for the current object.

    Declaration
    public bool HasCellTipText { get; }
    Property Value
    Type
    System.Boolean

    HasCellType

    Gets a value indicating whether CellType has been initialized for the current object.

    Declaration
    public bool HasCellType { get; }
    Property Value
    Type
    System.Boolean

    HasCellValue

    Gets a value indicating whether CellValue has been initialized for the current object.

    Declaration
    public bool HasCellValue { get; }
    Property Value
    Type
    System.Boolean

    HasCellValueType

    Gets a value indicating whether CellValueType has been initialized for the current object.

    Declaration
    public bool HasCellValueType { get; }
    Property Value
    Type
    System.Boolean

    HasCharacterCasing

    Gets a value indicating whether CharacterCasing has been initialized for the current object.

    Declaration
    public bool HasCharacterCasing { get; }
    Property Value
    Type
    System.Boolean

    HasCheckBoxOptions

    Gets a value indicating whether CheckBoxOptions has been initialized for the current object.

    Declaration
    public bool HasCheckBoxOptions { get; }
    Property Value
    Type
    System.Boolean

    HasChoiceList

    Gets a value indicating whether ChoiceList has been initialized for the current object.

    Declaration
    public bool HasChoiceList { get; }
    Property Value
    Type
    System.Boolean

    HasClickable

    Gets a value indicating whether clickable information has been initialized for the current object.

    Declaration
    public bool HasClickable { get; }
    Property Value
    Type
    System.Boolean

    HasCommentTip

    Gets a value indicating whether the CommentTip property has been initialized for the current object.

    Declaration
    public bool HasCommentTip { get; }
    Property Value
    Type
    System.Boolean

    HasControl

    Gets a value indicating whether Control has been initialized for the current Control.

    Declaration
    public bool HasControl { get; }
    Property Value
    Type
    System.Boolean

    HasCultureInfo

    Gets a value indicating whether CultureInfo has been initialized for the current object.

    Declaration
    public bool HasCultureInfo { get; }
    Property Value
    Type
    System.Boolean

    HasCurrencyEdit

    Gets a value indicating whether CurrencyEdit state has been initialized for the current object.

    Declaration
    public bool HasCurrencyEdit { get; }
    Property Value
    Type
    System.Boolean

    HasDataSource

    Gets a value indicating whether DataSource has been initialized for the current object.

    Declaration
    public bool HasDataSource { get; }
    Property Value
    Type
    System.Boolean

    HasDescription

    Gets a value indicating whether Description has been initialized for the current object.

    Declaration
    public bool HasDescription { get; }
    Property Value
    Type
    System.Boolean

    HasDisplayMember

    Gets a value indicating whether DisplayMember has been initialized for the current object.

    Declaration
    public bool HasDisplayMember { get; }
    Property Value
    Type
    System.Boolean

    HasDropDownStyle

    Gets a value indicating whether DropDownStyle has been initialized for the current object.

    Declaration
    public bool HasDropDownStyle { get; }
    Property Value
    Type
    System.Boolean

    HasEnabled

    Gets a value indicating whether Enabled has been initialized for the current object.

    Declaration
    public bool HasEnabled { get; }
    Property Value
    Type
    System.Boolean

    HasError

    Gets a value indicating whether Error has been initialized for the current object.

    Declaration
    public bool HasError { get; }
    Property Value
    Type
    System.Boolean

    HasExclusiveChoiceList

    Gets a value indicating whether ExclusiveChoiceList has been initialized for the current object.

    Declaration
    public bool HasExclusiveChoiceList { get; }
    Property Value
    Type
    System.Boolean

    HasFloatCell

    Gets a value indicating whether FloatCell has been initialized for the current object.

    Declaration
    public bool HasFloatCell { get; }
    Property Value
    Type
    System.Boolean

    HasFloodCell

    Gets a value indicating whether FloodCell has been initialized for the current object.

    Declaration
    public bool HasFloodCell { get; }
    Property Value
    Type
    System.Boolean

    HasFont

    Gets a value indicating whether font information has been initialized for the current object.

    Declaration
    public bool HasFont { get; }
    Property Value
    Type
    System.Boolean

    HasFormat

    Gets a value indicating whether Format has been initialized for the current object.

    Declaration
    public bool HasFormat { get; }
    Property Value
    Type
    System.Boolean

    HasFormulaTag

    Gets a value indicating whether FormulaTag has been initialized for the current FormulaTag.

    Declaration
    public bool HasFormulaTag { get; }
    Property Value
    Type
    System.Boolean

    HasHorizontalAlignment

    Gets a value indicating whether HorizontalAlignment has been initialized for the current object.

    Declaration
    public bool HasHorizontalAlignment { get; }
    Property Value
    Type
    System.Boolean

    HasHotkeyPrefix

    Gets a value indicating whether the HotkeyPrefix has been initialized for the current object.

    Declaration
    public bool HasHotkeyPrefix { get; }
    Property Value
    Type
    System.Boolean

    HasImageFromByteArray

    Gets a value indicating whether Read-only information has been initialized for the current object.

    Declaration
    public bool HasImageFromByteArray { get; }
    Property Value
    Type
    System.Boolean

    HasImageIndex

    Gets a value indicating whether ImageIndex has been initialized for the current object.

    Declaration
    public bool HasImageIndex { get; }
    Property Value
    Type
    System.Boolean

    HasImageList

    Gets a value indicating whether ImageList has been initialized for the current object.

    Declaration
    public bool HasImageList { get; }
    Property Value
    Type
    System.Boolean

    HasImageSizeMode

    Gets a value indicating whether ImageSizeMode has been initialized for the current object.

    Declaration
    public bool HasImageSizeMode { get; }
    Property Value
    Type
    System.Boolean

    HasInterior

    Gets a value indicating whether interior information has been initialized for the current object.

    Declaration
    public bool HasInterior { get; }
    Property Value
    Type
    System.Boolean

    HasMaskEdit

    Gets a value indicating whether MaskedEdit state has been initialized for the current object.

    Declaration
    public bool HasMaskEdit { get; }
    Property Value
    Type
    System.Boolean

    HasMaxLength

    Gets a value indicating whether MaxLength has been initialized for the current object.

    Declaration
    public bool HasMaxLength { get; }
    Property Value
    Type
    System.Boolean

    HasMergeCell

    Gets a value indicating whether MergeCell has been initialized for the current object.

    Declaration
    public bool HasMergeCell { get; }
    Property Value
    Type
    System.Boolean

    HasNumericUpDown

    Gets a value indicating whether NumericUpDown has been initialized for the current object.

    Declaration
    public bool HasNumericUpDown { get; }
    Property Value
    Type
    System.Boolean

    HasParseFormats

    Gets a value indicating whether ParseFormats has been initialized for the current object.

    Declaration
    public bool HasParseFormats { get; }
    Property Value
    Type
    System.Boolean

    HasPasswordChar

    Gets a value indicating whether PasswordChar has been initialized for the current object.

    Declaration
    public bool HasPasswordChar { get; }
    Property Value
    Type
    System.Boolean

    HasProgressBar

    Gets a value indicating whether ProgressBar state has been initialized for the current object.

    Declaration
    public bool HasProgressBar { get; }
    Property Value
    Type
    System.Boolean

    HasPropertyDescriptor

    Gets a value indicating whether PropertyDescriptor has been initialized for the current object.

    Declaration
    public bool HasPropertyDescriptor { get; }
    Property Value
    Type
    System.Boolean

    HasRadioButtonAlignment

    Gets a value indicating whether RadioButtonAlignmentProperty has been initialized for the current object.

    Declaration
    public bool HasRadioButtonAlignment { get; }
    Property Value
    Type
    System.Boolean

    HasReadOnly

    Gets a value indicating whether Read-only information has been initialized for the current object.

    Declaration
    public bool HasReadOnly { get; }
    Property Value
    Type
    System.Boolean

    HasRightToLeft

    Gets a value indicating whether Read-only information has been initialized for the current object.

    Declaration
    public bool HasRightToLeft { get; }
    Property Value
    Type
    System.Boolean

    HasShowButtons

    Gets a value indicating whether ShowButtons has been initialized for the current object.

    Declaration
    public bool HasShowButtons { get; }
    Property Value
    Type
    System.Boolean

    HasStrictValueType

    Gets a value indicating whether StrictValueType has been initialized for the current object.

    Declaration
    public bool HasStrictValueType { get; }
    Property Value
    Type
    System.Boolean

    HasTag

    Gets a value indicating whether Tag has been initialized for the current object.

    Declaration
    public bool HasTag { get; }
    Property Value
    Type
    System.Boolean

    HasText

    Gets a value indicating whether Text has been initialized for the current object.

    Declaration
    public bool HasText { get; }
    Property Value
    Type
    System.Boolean

    HasTextAlign

    Gets a value indicating whether TextAlign has been initialized for the current object.

    Declaration
    public bool HasTextAlign { get; }
    Property Value
    Type
    System.Boolean

    HasTextColor

    Gets a value indicating whether text color has been initialized for the current object.

    Declaration
    public bool HasTextColor { get; }
    Property Value
    Type
    System.Boolean

    HasTextMargins

    Gets a value indicating whether TextMargins has been initialized for the current object.

    Declaration
    public bool HasTextMargins { get; }
    Property Value
    Type
    System.Boolean

    HasThemed

    Gets a value indicating whether Read-only information has been initialized for the current object.

    Declaration
    public bool HasThemed { get; }
    Property Value
    Type
    System.Boolean

    HasTrimming

    Gets a value indicating whether Trimming has been initialized for the current object.

    Declaration
    public bool HasTrimming { get; }
    Property Value
    Type
    System.Boolean

    HasTriState

    Gets a value indicating whetherf TriState has been initialized for the current object.

    Declaration
    public bool HasTriState { get; }
    Property Value
    Type
    System.Boolean

    HasValidateValue

    Gets a value indicating whether ValidateValue has been initialized for the current object.

    Declaration
    public bool HasValidateValue { get; }
    Property Value
    Type
    System.Boolean

    HasValueMember

    Gets a value indicating whether ValueMember has been initialized for the current object.

    Declaration
    public bool HasValueMember { get; }
    Property Value
    Type
    System.Boolean

    HasVerticalAlignment

    Gets a value indicating whether VerticalAlignment has been initialized for the current object.

    Declaration
    public bool HasVerticalAlignment { get; }
    Property Value
    Type
    System.Boolean

    HasVerticalScrollbar

    Gets a value indicating whether VerticalScrollbar has been initialized for the current object.

    Declaration
    public bool HasVerticalScrollbar { get; }
    Property Value
    Type
    System.Boolean

    HasWrapRotatedText

    Gets a value indicating whether WrapRotatedText has been initialized for the current object.

    Declaration
    public bool HasWrapRotatedText { get; }
    Property Value
    Type
    System.Boolean

    HasWrapText

    Gets a value indicating whether WrapText has been initialized for the current object.

    Declaration
    public bool HasWrapText { get; }
    Property Value
    Type
    System.Boolean

    HorizontalAlignment

    Gets or sets horizontal alignment of text in the cell.

    Declaration
    public GridHorizontalAlignment HorizontalAlignment { get; set; }
    Property Value
    Type
    GridHorizontalAlignment
    Remarks

    The default value for the HorizontalAlignment property is GridHorizontalAlignment.Left.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    HotkeyPrefix

    Gets or sets how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable the hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed.

    Declaration
    public HotkeyPrefix HotkeyPrefix { get; set; }
    Property Value
    Type
    System.Drawing.Text.HotkeyPrefix
    Remarks

    The default value for the HotkeyPrefix property is HotkeyPrefix.None.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    ImageFromByteArray

    Gets or sets a value indicating whether cells should check whether a byte array can be converted to a image.

    Declaration
    public bool ImageFromByteArray { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the ImageFromByteArray property is True.

    ImageIndex

    Gets or sets an image index that specifies an image inside a ImageList.

    Declaration
    public int ImageIndex { get; set; }
    Property Value
    Type
    System.Int32
    Remarks

    The default value for the ImageIndex property is -1.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    ImageList

    Gets or sets an System.Windows.Forms.ImageList that holds a collection of images. Cells can choose images with the ImageIndex property in a GridStyleInfo instance.

    Declaration
    [CloneableProperty(false)]
    [DisposeableProperty(false)]
    public ImageList ImageList { get; set; }
    Property Value
    Type
    System.Windows.Forms.ImageList
    Remarks

    The default value for the ImageList property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    ImageSizeMode

    Gets or sets how the image is displayed.

    Declaration
    public GridImageSizeMode ImageSizeMode { get; set; }
    Property Value
    Type
    GridImageSizeMode
    Remarks

    Valid values for this property are taken from the PictureBoxSizeMode enumeration. By default, in PictureBoxSizeMode.Normal mode, the Image is placed in the upper left corner of the PictureBox, and any part of the image too big for the PictureBox is clipped. Using the PictureBoxSizeMode.StretchImage value causes the image to stretch to fit the PictureBox.

    Using the PictureBoxSizeMode.AutoSize value causes the control to resize to always fit the image. Using the PictureBoxSizeMode.CenterImage value causes the image to be centered in the client area.

    Interior

    Gets or sets a solid backcolor, gradient, or pattern style with both back and forecolor for a cell's background.

    Declaration
    public BrushInfo Interior { get; set; }
    Property Value
    Type
    BrushInfo
    Remarks

    The default value for the Interior property is SystemColors.Window.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    MaskEdit

    Gets or sets MaskedEdit state. MaskedEdit is itself an expandable object with several properties that can be set individually and participate in style inheritance mechanism.

    Declaration
    public GridMaskEditInfo MaskEdit { get; set; }
    Property Value
    Type
    GridMaskEditInfo

    MaxLength

    Gets or sets Limits the number of characters the user can type into the cell. Note: When selecting a text from a choice list or when pasting text, the text can be longer. Additional validation is necessary on your side.

    Declaration
    public int MaxLength { get; set; }
    Property Value
    Type
    System.Int32
    Remarks

    The default value for the MaxLength property is 0.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    MergeCell

    Gets or sets if cell edges shall be drawn raised, sunken, or flat (default).

    Declaration
    public GridMergeCellDirection MergeCell { get; set; }
    Property Value
    Type
    GridMergeCellDirection
    Remarks

    The default value for the MergeCell property is GridMergeCellDirection.Flat.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    NumericUpDown

    Gets or sets NumericUpDown to specify the step, minimum, and maximum value and if the value should start over when you reach the maximum value.

    Declaration
    public GridNumericUpDownCellInfo NumericUpDown { get; set; }
    Property Value
    Type
    GridNumericUpDownCellInfo
    Remarks

    The default value for the NumericUpDown property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)

    ParseFormats

    Gets or sets the permissible formats used to parse user entries of cell values.

    Declaration
    public string[] ParseFormats { get; set; }
    Property Value
    Type
    System.String[]
    Remarks

    The default value for the ParseFormats property is NULL.

    The property affects the behavior or appearance of the following cell types:

    It can be used to specify various DateTime formats that are allowed when the user enters a DateTime cell value.

    PasswordChar

    Gets or sets the character used to mask characters of a password in a password-entry cell. The cells CellType must be "OriginalTextBox".

    Declaration
    public char PasswordChar { get; set; }
    Property Value
    Type
    System.Char
    Remarks

    The default value for the PasswordChar property is blank.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_OriginalTextBox (GridOriginalTextBoxCellRenderer)

    ProgressBar

    Gets or sets ProgressBar state. ProgressBar is itself an expandable object with several properties that can be set individually and participate in style inheritance mechanism.

    Declaration
    public GridProgressBarInfo ProgressBar { get; set; }
    Property Value
    Type
    GridProgressBarInfo
    Remarks

    The default value for the ProgressBar property is GridProgressBarInfo.Default.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ProgressBar (GridProgressBarCellRenderer)

    PropertyDescriptor

    Gets or sets a property descriptor that can be used by UITypeEditCell, PropertyGridCell, and StandardValuesCell cell types.

    Declaration
    public PropertyDescriptor PropertyDescriptor { get; set; }
    Property Value
    Type
    System.ComponentModel.PropertyDescriptor

    Provider

    Get the provider for the GridCell UI autommation

    Declaration
    public GridCellUIAProvider Provider { get; }
    Property Value
    Type
    GridCellUIAProvider

    RadioButtonAlignment

    Gets or sets the Alignment of the radio button elements inside the cell rectangle.

    Declaration
    public ButtonAlignment RadioButtonAlignment { get; set; }
    Property Value
    Type
    ButtonAlignment
    Remarks

    The default value for the RadioButtonAlignment property is ButtonAlignment.Horizontal.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_RadioButton (GridRadioButtonCellRenderer)

    ReadOnly

    Gets or sets a value indicating whether cell contents can be modified by the user. You can programmatically change Read-only cells by setting IgnoreReadOnly to True.

    Declaration
    public bool ReadOnly { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the Read-Only property is False.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    ReadOnlyBorderMargins

    Gets readonly border margins. Used internally.

    Declaration
    public GridMarginsInfo ReadOnlyBorderMargins { get; }
    Property Value
    Type
    GridMarginsInfo

    ReadOnlyBorders

    Gets readonly readonly borders. Used internally.

    Declaration
    public GridBordersInfo ReadOnlyBorders { get; }
    Property Value
    Type
    GridBordersInfo

    ReadOnlyCheckBoxOptions

    Gets readonly Checkbox options. Used internally.

    Declaration
    public GridCheckBoxCellInfo ReadOnlyCheckBoxOptions { get; }
    Property Value
    Type
    GridCheckBoxCellInfo

    ReadOnlyFont

    Gets read-only font. Used internally.

    Declaration
    public GridFontInfo ReadOnlyFont { get; }
    Property Value
    Type
    GridFontInfo

    ReadOnlyNumericUpDown

    Gets readonly numeric updown. Used internally.

    Declaration
    public GridNumericUpDownCellInfo ReadOnlyNumericUpDown { get; }
    Property Value
    Type
    GridNumericUpDownCellInfo

    ReadOnlyTextMargins

    Gets readonly text margins. Used internally.

    Declaration
    public GridMarginsInfo ReadOnlyTextMargins { get; }
    Property Value
    Type
    GridMarginsInfo

    ReadOnlyValidateValue

    Gets readonly validate value. Used internally.

    Declaration
    public GridCellValidateValueInfo ReadOnlyValidateValue { get; }
    Property Value
    Type
    GridCellValidateValueInfo

    RightToLeft

    Gets or sets if cell contents read from right to left.

    Declaration
    public RightToLeft RightToLeft { get; set; }
    Property Value
    Type
    System.Windows.Forms.RightToLeft
    Remarks

    The default value for the RightToLeft property is False.

    ShowButtons

    Gets or sets when to show or display the cell buttons. Possible choices are: show the button only for the current cell, always show buttons, or never show buttons.

    Declaration
    public GridShowButtons ShowButtons { get; set; }
    Property Value
    Type
    GridShowButtons
    Remarks

    The default value for the ShowButtons property is GridShowButtons.Show.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)

    Store

    Gets the GridStyleInfoStore object that holds all the data for this style object.

    Declaration
    public GridStyleInfoStore Store { get; }
    Property Value
    Type
    GridStyleInfoStore

    StrictValueType

    Gets or sets a value indicating whether an exception should be thrown in the ApplyFormattedText(String) method if the formatted text can not be parsed and converted to the type specified with CellValueType.

    Declaration
    public bool StrictValueType { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The ApplyFormattedText(String) method will be called when the user enters text into a text box. The method checks if there are event handlers for SaveCellFormattedText. If not, it will continue with its default behavior and try to convert the input text into the type specified with CellValueType.

    If this conversion fails, ApplyFormattedText(String) will check StrictValueType. If it is True, an exception is thrown which itself results in a warning message displayed to the user at the time from CurrentCellValidating.

    If you set StrictValueType to False, ApplyFormattedText(String) will not throw an exception; it will simply store the text as CellValue.

    If you need a more specialized customization of this behavior, you should handle the SaveCellFormattedText event. This lets you parse the text input and change the cell's CellValueType at run-time. See SaveCellFormattedText for an example how to do this.

    The default value for the StrictValueType property is True.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)
    • langword_csharp_Currency (GridCurrencyTextBoxCellRenderer)
    • langword_csharp_MaskEdit (GridMaskEditCellRenderer)
    • langword_csharp_FormulaCell (GridFormulaCellRenderer)
    • langword_csharp_RichText (GridRichTextBoxCellRenderer)
    • langword_csharp_Control (GridGenericControlCellRenderer)
    • langword_csharp_OriginalTextBox (GridOriginalTextBoxCellRenderer)
    • langword_csharp_ProgressBar (GridProgressBarCellRenderer)
    • langword_csharp_RadioButton (GridRadioButtonCellRenderer)

    Tag

    Gets or sets a custom tag you can associate with a cell.

    Declaration
    public object Tag { get; set; }
    Property Value
    Type
    System.Object
    Remarks

    The default value for the Tag property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)

    TODO: Explain how to set StylePropertyInfo.IsCloneable = false and StylePropertyInfo.IsDisposable = false or implement IStyleCloneable to avoid cloning and disposing of objects assigned to Tag.

    Text

    Gets or sets the value as a string. If a CellValueType is specified, the text will be parsed and converted to the type specified with CellValueType using CultureInfo.CurrentCulture information.

    Declaration
    public string Text { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the Text property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    TextAlign

    Gets or sets Align text left of button elements (which is typical for combo boxes). Or align text right of button elements. See HorizontalAlignment how to align text left, centered, and right inside a cell rectangle.

    Declaration
    public GridTextAlign TextAlign { get; set; }
    Property Value
    Type
    GridTextAlign
    Remarks

    Don't confuse this with HorizontalAlignment. TextAlign specifies if text should be displayed left or right of any cell button elements.

    The default value for the TextAlign property is GridTextAlign.Default.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)

    Examples

    This example shows how to specify the alignment of the text.

    this.gridControl1.TableStyle.TextAlign = GridTextAlign.Right;
    Me.gridControl1.TableStyle.TextAlign = GridTextAlign.Right;

    TextColor

    Gets or sets the color for drawing the cell text.

    Declaration
    public Color TextColor { get; set; }
    Property Value
    Type
    System.Drawing.Color
    Remarks

    The default value for the TextColor property is SystemColors.WindowText.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    TextMargins

    Gets or sets 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.

    Declaration
    public GridMarginsInfo TextMargins { get; set; }
    Property Value
    Type
    GridMarginsInfo
    Remarks

    The default value for the TextMargins property is GridMarginsInfo.Default.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Themed

    Gets or sets a value indicating whether cell types that support Windows XP themes should be drawn themed.

    Declaration
    public bool Themed { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the Themed property is True.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DataBoundRowHeader (GridDataBoundRowHeaderCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_RichText (GridRichTextBoxCellRenderer)
    • langword_csharp_ProgressBar (GridProgressBarCellRenderer)

    Trimming

    Gets or sets how text is trimmed when it exceeds the edges of the cell text rectangle.

    Declaration
    public StringTrimming Trimming { get; set; }
    Property Value
    Type
    System.Drawing.StringTrimming
    Remarks

    The default value for the Trimming property is StringTrimming.Character.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Examples

    This example shows how the text is trimmed when it exceeds the edges of the cell text rectangle.

    //sets how text is trimmed when it exceeds the edges of the cell text rectangle.
    this.gridControl1.TableStyle.Trimming = StringTrimming.EllipsisPath;
    'sets how text is trimmed when it exceeds the edges of the cell text rectangle.
     Me.gridControl1.TableStyle.Trimming = StringTrimming.EllipsisPath

    TriState

    Gets or sets a value indicating whether this checkbox is a Tristate check box that has an additional indeterminated state.

    Declaration
    public bool TriState { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the TriState property is False.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)

    ValidateValue

    Gets or sets validation rules for the cell value that are being checked before any user changes are committed to the grid cell's style object.

    Declaration
    public GridCellValidateValueInfo ValidateValue { get; set; }
    Property Value
    Type
    GridCellValidateValueInfo
    Remarks

    The default value for the ValidateValue property is NULL.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    ValueMember

    Gets or sets a string that specifies the property of the data source from which to draw the value.

    Declaration
    public string ValueMember { get; set; }
    Property Value
    Type
    System.String
    Remarks

    The default value for the ValueMember property is String.Empty.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)

    VerticalAlignment

    Gets or sets vertical alignment of text in the cell.

    Declaration
    public GridVerticalAlignment VerticalAlignment { get; set; }
    Property Value
    Type
    GridVerticalAlignment
    Remarks

    The default value for the VerticalAlignment property is GridVerticalAlignment.Top.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Examples

    This example shows how to specify the vertical alignment of the text in the cell.

     //Set the vertical alignment for text in a cell.
     this.gridControl1.TableStyle.VerticalAlignment = GridVerticalAlignment.Middle;
     'Set the vertical alignment for text in a cell.
      Me.gridControl1.TableStyle.VerticalAlignment = GridVerticalAlignment.Middle

    VerticalScrollbar

    Gets or sets a value indicating whether text box should show a vertical scrollbar when text is being edited and does not fit in cell. WrapText must be initialized to True.

    Declaration
    public bool VerticalScrollbar { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the VerticalScrollbar property is False.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    WrapRotatedText

    Gets or sets the value to the WrapRotatedText

    Declaration
    public bool WrapRotatedText { get; set; }
    Property Value
    Type
    System.Boolean

    WrapText

    Gets or sets a value indicating whether text should be wrapped when it does not fit into a single line.

    Declaration
    public bool WrapText { get; set; }
    Property Value
    Type
    System.Boolean
    Remarks

    The default value for the WrapText property is True.

    The property affects the behavior or appearance of the following cell types:

    • langword_csharp_CheckBox (GridCheckBoxCellRenderer)
    • langword_csharp_ComboBox (GridComboBoxCellRenderer)
    • langword_csharp_DropDown (GridDropDownCellRenderer)
    • langword_csharp_DropDownColorUI (GridDropDownColorUICellRenderer)
    • langword_csharp_DropDownGrid (GridDropDownGridCellRenderer)
    • langword_csharp_DropDownGridListControl (GridDropDownGridListControlCellRenderer)
    • langword_csharp_DropDownMonthCalendar (GridDropDownMonthCalendarCellRenderer)
    • langword_csharp_Header (GridHeaderCellRenderer)
    • langword_csharp_NumericUpDown (GridNumericUpDownCellRenderer)
    • langword_csharp_PushButton (GridPushButtonCellRenderer)
    • langword_csharp_SortColumnHeader (GridSortColumnHeaderCellRenderer)
    • langword_csharp_Static (GridStaticCellRenderer)
    • langword_csharp_TextBox (GridTextBoxCellRenderer)

    Methods

    ApplyFormattedText(String)

    Determines whether parses the formatted text using Format and cell value type information stored in the current style object. The text is parsed using GridStyleInfo.CultureInfo information.

    Declaration
    public bool ApplyFormattedText(string text)
    Parameters
    Type Name Description
    System.String text

    The formatted text.

    Returns
    Type Description
    System.Boolean

    True if the text could be parsed correctly and converted to a cell value.

    ApplyFormattedText(String, Int32)

    Determines whether parses the formatted text using Format and cell value type information stored in the current style object. The text is parsed using GridStyleInfo.CultureInfo information.

    Declaration
    public bool ApplyFormattedText(string text, int textInfo)
    Parameters
    Type Name Description
    System.String text

    The formatted text.

    System.Int32 textInfo

    A hint that specifies the current action why the text is parsed.

    Returns
    Type Description
    System.Boolean

    True if the text could be parsed correctly and converted to a cell value.

    ApplyText(String)

    Determines whether parses the text (ignoring any Format settings) and assigns it to CellValue. The text is parsed using CultureInfo.CurrentCulture information.

    Declaration
    public bool ApplyText(string text)
    Parameters
    Type Name Description
    System.String text

    The text to be parsed.

    Returns
    Type Description
    System.Boolean

    True if the text could be parsed correctly and converted to a cell value.

    CreateSubObjectIdentity(StyleInfoProperty)

    Overridden to create a product-specific identity object for the sub object.

    Declaration
    public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)
    Parameters
    Type Name Description
    StyleInfoProperty sip

    StyleInfoProperty descriptor for this sub object.

    Returns
    Type Description
    StyleInfoSubObjectIdentity

    Identity for the sub object.

    Overrides
    StyleInfoBase.CreateSubObjectIdentity(StyleInfoProperty)

    GetActiveGridView()

    Returns the GridControlBase for this style or NULL if style is used outside a grid model.

    Declaration
    public GridControlBase GetActiveGridView()
    Returns
    Type Description
    GridControlBase

    The active GridControlBase for the grid model this style belongs to or NULL.

    GetCulture(Boolean)

    Gets the culture information from the style object or returns CultureInfo.CurrentCulture if CultureInfo is NULL.

    Declaration
    public CultureInfo GetCulture(bool useCurrentCultureIfNull)
    Parameters
    Type Name Description
    System.Boolean useCurrentCultureIfNull

    True if CultureInfo.CurrentUICulture should be returned when CultureInfo is NULL.

    Returns
    Type Description
    System.Globalization.CultureInfo

    The culture information with rules for parsing and formatting the cell's value.

    Examples

    This example shows how to get the culture information of the grid.

    //Getting CultureInfo of Grid.
    CultureInfo cultureInfo = this.gridControl1.TableStyle.GetCulture(true);
    'Getting CultureInfo of Grid.
    Dim cultureInfo As CultureInfo = Me.gridControl1.TableStyle.GetCulture(True)

    GetDefaultStyle()

    Override this method to return a default style object for your derived class.

    Declaration
    protected override StyleInfoBase GetDefaultStyle()
    Returns
    Type Description
    StyleInfoBase

    A default style object.

    Overrides
    StyleInfoBase.GetDefaultStyle()

    GetFormattedText(Object)

    Return formatted text for the specified value.

    Declaration
    public string GetFormattedText(object value)
    Parameters
    Type Name Description
    System.Object value

    The value to be formatted.

    Returns
    Type Description
    System.String

    A string that holds the formatted text.

    GetFormattedText(Object, Int32)

    Return formatted text for the specified value. GridStyleInfo.CultureInfo is used for conversion to string.

    Declaration
    public string GetFormattedText(object value, int textInfo)
    Parameters
    Type Name Description
    System.Object value

    The value to be formatted.

    System.Int32 textInfo

    A hint that specifies the current action why the text is formatted.

    Returns
    Type Description
    System.String

    A string that holds the formatted text.

    GetGridModel()

    Returns the GridModel for this style or NULL if style is used outside a grid model.

    Declaration
    public GridModel GetGridModel()
    Returns
    Type Description
    GridModel

    The GridModel this style belongs to or NULL.

    Examples

    This example shows how to get the GridModel.

    //Get the grid model.
    GridModel model = this.gridControl1.TableStyle.GetGridModel();
    'Get the grid model.
      Dim model As GridModel= Me.gridControl1.TableStyle.GetGridModel()

    GetOffLineCopy()

    Creates a new GridStyleInfo and copies its cell and identity information from the current object. The new instance will be made offline so that changes in this style object are not be stored in the GridData

    Declaration
    public GridStyleInfo GetOffLineCopy()
    Returns
    Type Description
    GridStyleInfo

    A new GridStyleInfo instance.

    Remarks

    Lets a style object load base styles and default values but disables saving changes back to the grid. (see OnStyleChanged below)

    GetText(Object)

    Returns text for the specified value (ignoring any Format settings). CultureInfo.CurrentCulture is used for conversion to string.

    Declaration
    public string GetText(object value)
    Parameters
    Type Name Description
    System.Object value

    The value to be converted to string.

    Returns
    Type Description
    System.String

    A string that represents the value.

    IsAutoComplete()

    Determines whether drop down style is in auto complete mode. Used internally.

    Declaration
    public bool IsAutoComplete()
    Returns
    Type Description
    System.Boolean

    true if [is auto complete]; otherwise, false.

    ModifyStyle(IStyleInfo, StyleModifyType)

    Overridden to apply the specified changes to the style object.

    Declaration
    public override void ModifyStyle(IStyleInfo istyle, StyleModifyType mt)
    Parameters
    Type Name Description
    IStyleInfo istyle

    The style object to modify.

    StyleModifyType mt

    Defines the style operations for the given style object.

    Overrides
    StyleInfoBase.ModifyStyle(IStyleInfo, StyleModifyType)

    OnStyleChanged(StyleInfoProperty)

    Overridden when identity object that a specific property was changed.

    Declaration
    protected override void OnStyleChanged(StyleInfoProperty sip)
    Parameters
    Type Name Description
    StyleInfoProperty sip

    The StyleInfoProperty that identifies the changed style property.

    Overrides
    StyleInfoBase.OnStyleChanged(StyleInfoProperty)

    ResetAllowEnter()

    Resets AllowEnter.

    Declaration
    public void ResetAllowEnter()

    ResetAutoFit()

    Resets AutoFit

    Declaration
    public void ResetAutoFit()
    Examples

    This example shows how to reset the auto fit property.

    //Resets the AutoFit property.
    this.gridControl1.TableStyle.ResetAutoFit();
    'Resets the AutoFit property.
    Me.gridControl1.TableStyle.ResetAutoFit()

    ResetAutoFitChar()

    Resets AutoFitChar

    Declaration
    public void ResetAutoFitChar()
    Examples

    This example shows how to reset the AutoFitChar property.

    //Resets the AutoFitChar property.
    this.gridControl1.TableStyle.ResetAutoFitChar ();
    'Resets the AutoFitChar property.
    Me.gridControl1.TableStyle.ResetAutoFitChar ()

    ResetAutoSize()

    Resets AutoSize.

    Declaration
    public void ResetAutoSize()

    ResetBackColor()

    Resets the Interior back to default.

    Declaration
    public void ResetBackColor()

    ResetBackgroundImage()

    Resets BackgroundImage state.

    Declaration
    public void ResetBackgroundImage()

    ResetBackgroundImageID()

    Resets BackgroundImageID state.

    Declaration
    public void ResetBackgroundImageID()

    ResetBackgroundImageMode()

    Resets BackgroundImageMode state

    Declaration
    public void ResetBackgroundImageMode()

    ResetBaseStyle()

    Resets BaseStyle.

    Declaration
    public void ResetBaseStyle()

    ResetBorderMargins()

    Resets BorderMargins.

    Declaration
    public void ResetBorderMargins()

    ResetBorders()

    Resets the borders information.

    Declaration
    public void ResetBorders()

    ResetCellAppearance()

    Resets CellAppearance.

    Declaration
    public void ResetCellAppearance()

    ResetCellTipText()

    Resets CellTipText.

    Declaration
    public void ResetCellTipText()

    ResetCellType()

    Resets CellType.

    Declaration
    public void ResetCellType()

    ResetCellValue()

    Resets CellValue.

    Declaration
    public void ResetCellValue()

    ResetCellValueType()

    Resets CellValueType.

    Declaration
    public void ResetCellValueType()

    ResetCharacterCasing()

    Resets CharacterCasing.

    Declaration
    public void ResetCharacterCasing()

    ResetCheckBoxOptions()

    Resets CheckBoxOptions.

    Declaration
    public void ResetCheckBoxOptions()

    ResetChoiceList()

    Resets ChoiceList.

    Declaration
    public void ResetChoiceList()

    ResetClickable()

    Resets the clickable information.

    Declaration
    public void ResetClickable()

    ResetCommentTip()

    Resets CommentTip property.

    Declaration
    public void ResetCommentTip()

    ResetControl()

    Resets Control.

    Declaration
    public void ResetControl()

    ResetCultureInfo()

    Resets CultureInfo.

    Declaration
    public void ResetCultureInfo()

    ResetCurrencyEdit()

    Resets CurrencyEdit state.

    Declaration
    public void ResetCurrencyEdit()

    ResetDataSource()

    Resets DataSource.

    Declaration
    public void ResetDataSource()

    ResetDescription()

    Resets Description.

    Declaration
    public void ResetDescription()

    ResetDisplayMember()

    Resets DisplayMember.

    Declaration
    public void ResetDisplayMember()

    ResetDropDownStyle()

    Resets DropDownStyle.

    Declaration
    public void ResetDropDownStyle()

    ResetEnabled()

    Resets Enabled.

    Declaration
    public void ResetEnabled()

    ResetError()

    Resets Error.

    Declaration
    public void ResetError()

    ResetExclusiveChoiceList()

    Resets ExclusiveChoiceList.

    Declaration
    public void ResetExclusiveChoiceList()

    ResetFloatCell()

    Resets FloatCell.

    Declaration
    public void ResetFloatCell()

    ResetFloodCell()

    Resets FloodCell.

    Declaration
    public void ResetFloodCell()

    ResetFont()

    Resets font information.

    Declaration
    public void ResetFont()

    ResetFormat()

    Resets Format.

    Declaration
    public void ResetFormat()

    ResetFormulaTag()

    Resets FormulaTag.

    Declaration
    public void ResetFormulaTag()

    ResetHorizontalAlignment()

    Resets HorizontalAlignment.

    Declaration
    public void ResetHorizontalAlignment()

    ResetHotkeyPrefix()

    Resets the HotkeyPrefix property.

    Declaration
    public void ResetHotkeyPrefix()

    ResetImageFromByteArray()

    Resets Read-only information.

    Declaration
    public void ResetImageFromByteArray()

    ResetImageIndex()

    Resets ImageIndex.

    Declaration
    public void ResetImageIndex()

    ResetImageList()

    Resets ImageList.

    Declaration
    public void ResetImageList()

    ResetImageSizeMode()

    Resets ImageSizeMode.

    Declaration
    public void ResetImageSizeMode()

    ResetInterior()

    Resets interior information.

    Declaration
    public void ResetInterior()

    ResetMaskEdit()

    Resets MaskedEdit state.

    Declaration
    public void ResetMaskEdit()

    ResetMaxLength()

    Resets MaxLength.

    Declaration
    public void ResetMaxLength()

    ResetMergeCell()

    Resets MergeCell.

    Declaration
    public void ResetMergeCell()

    ResetNumericUpDown()

    Resets NumericUpDown.

    Declaration
    public void ResetNumericUpDown()

    ResetParseFormats()

    Resets ParseFormats.

    Declaration
    public void ResetParseFormats()

    ResetPasswordChar()

    Resets PasswordChar.

    Declaration
    public void ResetPasswordChar()

    ResetProgressBar()

    Resets ProgressBar state.

    Declaration
    public void ResetProgressBar()

    ResetPropertyDescriptor()

    Resets PropertyDescriptor.

    Declaration
    public void ResetPropertyDescriptor()

    ResetRadioButtonAlignment()

    Resets RadioButtonAlignmentProperty.

    Declaration
    public void ResetRadioButtonAlignment()

    ResetReadOnly()

    Resets Read-only information.

    Declaration
    public void ResetReadOnly()

    ResetRightToLeft()

    Resets Read-only information.

    Declaration
    public void ResetRightToLeft()

    ResetShowButtons()

    Resets ShowButtons.

    Declaration
    public void ResetShowButtons()

    ResetStrictValueType()

    Resets StrictValueType.

    Declaration
    public void ResetStrictValueType()

    ResetTag()

    Resets Tag.

    Declaration
    public void ResetTag()

    ResetText()

    Resets the Text property.

    Declaration
    public void ResetText()

    ResetTextAlign()

    Resets TextAlign.

    Declaration
    public void ResetTextAlign()

    ResetTextColor()

    Resets text color information.

    Declaration
    public void ResetTextColor()

    ResetTextMargins()

    Resets TextMargins.

    Declaration
    public void ResetTextMargins()

    ResetThemed()

    Resets Read-only information.

    Declaration
    public void ResetThemed()

    ResetTrimming()

    Resets Trimming.

    Declaration
    public void ResetTrimming()

    ResetTriState()

    Resets TriState.

    Declaration
    public void ResetTriState()

    ResetValidateValue()

    Resets ValidateValue.

    Declaration
    public void ResetValidateValue()

    ResetValueMember()

    Resets ValueMember.

    Declaration
    public void ResetValueMember()

    ResetVerticalAlignment()

    Resets VerticalAlignment.

    Declaration
    public void ResetVerticalAlignment()

    ResetVerticalScrollbar()

    Resets VerticalScrollbar.

    Declaration
    public void ResetVerticalScrollbar()

    ResetWrapRotatedText()

    Resets WrapRotatedText.

    Declaration
    public void ResetWrapRotatedText()

    ResetWrapText()

    Resets WrapText.

    Declaration
    public void ResetWrapText()

    Implements

    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStyleInfo
    System.ComponentModel.ISupportInitialize
    System.IFormattable
    System.IConvertible
    System.Xml.Serialization.IXmlSerializable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved