WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridTableOptionsStyleInfo

    Show / Hide Table of Contents

    Class GridTableOptionsStyleInfo

    Properties in this class let you control the look and behavior of the top level group, child groups, and nested child tables. You can control the caption text, where and if AddNewRow will be displayed, or whether captions, footers, previews, and summaries will be displayed.

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

    GridGroupOptionsStyleInfo supports inheritance properties from parent elements.

    Examples for inheritance of properties from parent elements are:

    • Group inherits from GridColumnDescriptor.GroupByOptions.
    • GridColumnDescriptor.GroupByOptions inherits from GridTableDescriptor.GroupOptions.
    • GridTableDescriptor.GroupOptions inherits from GridGroupingControl.GroupOptions

    A GridGroupingControl distinguishes between three different kinds of group options:

    • TopLevelGroup lets you control the look and behavior of the top level group.
    • ChildGroupOptions lets you control the look and behavior of the child groups.
    • NestedTableGroupOptions lets you control the look and behavior of the nested child relations.

    Constructors

    GridTableOptionsStyleInfo()

    Initializes a new style object.

    Declaration
    public GridTableOptionsStyleInfo()

    GridTableOptionsStyleInfo(StyleInfoIdentityBase)

    Initializes a new style object and associates it with an existing GridTableOptionsStyleInfoIdentity.

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

    A GridTableOptionsStyleInfoIdentity that holds the identity for this GridTableOptionsStyleInfo.

    GridTableOptionsStyleInfo(StyleInfoIdentityBase, GridTableOptionsStyleInfoStore)

    Initializes a new style object and associates it with an existing GridTableOptionsStyleInfoIdentity.

    Declaration
    public GridTableOptionsStyleInfo(StyleInfoIdentityBase identity, GridTableOptionsStyleInfoStore store)
    Parameters
    Type Name Description
    StyleInfoIdentityBase identity

    A GridTableOptionsStyleInfoIdentity that holds the identity for this GridTableOptionsStyleInfo.

    GridTableOptionsStyleInfoStore store

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

    GridTableOptionsStyleInfo(GridTableOptionsStyleInfo)

    Initializes a new style object and copies all data from an existing style object.

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

    The style object that contains the original data.

    GridTableOptionsStyleInfo(GridTableOptionsStyleInfoStore)

    Initializes a new style object and associates it with an existing GridTableOptionsStyleInfoStore.

    Declaration
    public GridTableOptionsStyleInfo(GridTableOptionsStyleInfoStore store)
    Parameters
    Type Name Description
    GridTableOptionsStyleInfoStore store

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

    Fields

    Empty

    An empty style object.

    Declaration
    public static readonly GridTableOptionsStyleInfo Empty
    Field Value
    Type Description
    GridTableOptionsStyleInfo

    Properties

    AllowDragColumns

    Gets or sets a value indicating whether the user can drag column headers and rearrange the order of columns.

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

    AllowDropDownCell

    Indicates whether the grid can show a drop-down list for cells in this column if column represents a foreign key field from a related table.

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

    AllowMultiColumnSort

    Gets or sets a value indicating whether the user can ctrl-click on additional column headers to sort by multiple columns.

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

    AllowSelection

    Defines selection behavior of the grid. When you set this property GridSelectionFlags.None and specify ListBoxSelectionMode then a record-based selection mechanism is used. If you set this property to a value different from GridSelectionFlags.None a 2.x version compatible selection mechanism is used.

    Declaration
    public GridSelectionFlags AllowSelection { get; set; }
    Property Value
    Type Description
    GridSelectionFlags

    A GridSelectionFlags that specifies options to be applied.

    Remarks

    Starting version 3.x the GridGroupingControl now supports multiple record selection and navigation across nested tables. In order to use the new record selection mechanism you need to set TableOptions.ListBoxSelection = SelectionMode.XYZ and make sure that TableOptions.AllowSelection = GridSelectionFlags.None. Optional settings can be specified with TableOptions.ListBoxSelectionColorOptions and TableOptions.ListBoxSelectionCurrentCellOptions.

    With the new record-based selection mode selected records can be found in Table.SelectedRecords collection.

    If you specify a different value for TableOptions.AllowSelection other than GridSelectionFlags.None the grid will operate in a backward-compatible mode and continue to use the old selection mechanism that was in place with 2.x and 1.x versions of the GridGroupingControl.

    Use TableOptions.AllowSelection only if you explicitly want the old selection behavior, e.g. if you want to be able to select individual cells or want to use Excel-like selection behavior.

    With the backward compatible selection mode selected rows and cells can be found in TableModel.Selections.Ranges collection.

    AllowSortColumns

    Gets or sets a value indicating whether the user can click on column headers to sort them.

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

    CaptionRowHeight

    Gets or sets the height in pixels of the caption rows.

    Declaration
    public int CaptionRowHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    ColumnHeaderRowHeight

    Gets or sets the height in pixels of the column header rows.

    Declaration
    public int ColumnHeaderRowHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    ColumnsMaxLengthFirstNRecords

    Gets or sets the number of rows to be evaluated for GridColumnsMaxLengthStrategy.FirstNRecords strategy.

    Declaration
    public int ColumnsMaxLengthFirstNRecords { get; set; }
    Property Value
    Type Description
    System.Int32

    ColumnsMaxLengthStrategy

    Defines strategy for resizing columns to optimal width.

    Declaration
    public GridColumnsMaxLengthStrategy ColumnsMaxLengthStrategy { get; set; }
    Property Value
    Type Description
    GridColumnsMaxLengthStrategy

    CustomProperties

    Returns 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 GridTableOptionsStyleInfoCustomPropertiesCollection CustomProperties { get; }
    Property Value
    Type Description
    GridTableOptionsStyleInfoCustomPropertiesCollection

    Default

    Returns a GridTableOptionsStyleInfo with default settings.

    Declaration
    public static GridTableOptionsStyleInfo Default { get; }
    Property Value
    Type Description
    GridTableOptionsStyleInfo

    DefaultColumnWidth

    Gets or sets the default width for columns.

    Declaration
    public int DefaultColumnWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    DrawTextWithGdiInterop

    Gets or sets a value indicating whether text should be drawn using GDI interop drawing routines.

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

    GridLineBorder

    Gets or sets the style of the line used to draw the grid lines.

    Declaration
    public GridBorder GridLineBorder { get; set; }
    Property Value
    Type Description
    GridBorder

    GridVisualStyles

    Gets or sets the VisualStyles (skins) like Office2010, Office2007, Office2003

    Declaration
    [SerializeProperty(false)]
    public GridVisualStyles GridVisualStyles { get; set; }
    Property Value
    Type Description
    GridVisualStyles
    Remarks

    Each of the components that is incorporated into the Grouping Grid is being affected with Visual Styles. Choosing one of the options will change the look and feel of the individual grid elements.

    Examples

    The VisualStyles can be set by assigning a GridVisualStyles enumeration value to the GridVisualStyles property

        this.gridGroupingControl1.TableOptions.GridVisualStyles = GridVisualStyles.Office2007Blue;
        Me.GridGroupingControl1.TableOptions.GridVisualStyles = GridVisualStyles.Office2007Blue

    GridVisualStylesDrawing

    Gets or sets the Skin values for the Grid.

    Declaration
    [SerializeProperty(false)]
    public IVisualStylesDrawing GridVisualStylesDrawing { get; set; }
    Property Value
    Type Description
    IVisualStylesDrawing

    GroupFooterSectionHeight

    Gets or sets the height in pixels of the group footers.

    Declaration
    public int GroupFooterSectionHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    GroupHeaderSectionHeight

    Gets or sets the height in pixels of the group headers.

    Declaration
    public int GroupHeaderSectionHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    GroupPreviewSectionHeight

    Gets or sets the height in pixels of the group previews.

    Declaration
    public int GroupPreviewSectionHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    HasAllowDragColumns

    Determines if AllowDragColumns has been initialized for the current object.

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

    HasAllowDropDownCell

    Determines if AllowDropDownCell has been initialized for the current object.

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

    HasAllowMultiColumnSort

    Determines if AllowMultiColumnSort has been initialized for the current object.

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

    HasAllowSelection

    Determines if AllowSelection has been initialized for the current object.

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

    HasAllowSortColumns

    Determines if AllowSortColumns has been initialized for the current object.

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

    HasCaptionRowHeight

    Determines if CaptionRowHeight has been initialized for the current object.

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

    HasColumnHeaderRowHeight

    Determines if ColumnHeaderRowHeight has been initialized for the current object.

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

    HasColumnsMaxLengthFirstNRecords

    Determines if ColumnsMaxLengthFirstNRecords has been initialized for the current object.

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

    HasColumnsMaxLengthStrategy

    Determines if ColumnsMaxLengthStrategy has been initialized for the current object.

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

    HasDefaultColumnWidth

    Determines if DefaultColumnWidth has been initialized for the current object.

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

    HasDrawTextWithGdiInterop

    Determines if DrawTextWithGdiInterop has been initialized for the current object.

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

    HasGridLineBorder

    Determines if GridLineBorder has been initialized for the current object.

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

    HasGridVisualStyles

    Determines if GridVisualStyles has been initialized for the current object.

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

    HasGridVisualStylesDrawing

    Determines if GridVisualStylesDrawing has been initialized for the current object.

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

    HasGroupFooterSectionHeight

    Determines if GroupFooterSectionHeight has been initialized for the current object.

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

    HasGroupHeaderSectionHeight

    Determines if GroupHeaderSectionHeight has been initialized for the current object.

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

    HasGroupPreviewSectionHeight

    Determines if GroupPreviewSectionHeight has been initialized for the current object.

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

    HasIndentWidth

    Determines if IndentWidth has been initialized for the current object.

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

    HasListBoxSelectionColorOptions

    Determines if GridListBoxSelectionColorOptions has been initialized for the current object.

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

    HasListBoxSelectionCurrentCellOptions

    Determines if GridListBoxSelectionCurrentCellOptions has been initialized for the current object.

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

    HasListBoxSelectionMode

    Determines if ListBoxSelectionMode has been initialized for the current object.

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

    HasListBoxSelectionOutlineBorder

    Determines if ListBoxSelectionOutlineBorder has been initialized for the current object.

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

    HasListBoxSelectionRecursive

    Determines if ListBoxSelectionRecursive has been initialized for the current object.

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

    HasMaxDropDownTableSize

    Determines if MaxDropDownTableSize has been initialized for the current object.

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

    HasMaxFilterBarChoiceListSize

    Determines if MaxFilterBarChoiceListSize has been initialized for the current object.

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

    HasRecordPreviewRowHeight

    Determines if RecordPreviewRowHeight has been initialized for the current object.

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

    HasRecordRowHeight

    Determines if RecordRowHeight has been initialized for the current object.

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

    HasRowHeaderWidth

    Determines if RowHeaderWidth has been initialized for the current object.

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

    HasSelectionBackColor

    Determines if SelectionBackColor has been initialized for the current object.

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

    HasSelectionTextColor

    Determines if SelectionTextColor has been initialized for the current object.

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

    HasShowRecordPlusMinus

    Determines if ShowRecordPlusMinus has been initialized for the current object.

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

    HasShowRecordPreviewRow

    Determines if ShowRecordPreviewRow has been initialized for the current object.

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

    HasShowRowHeader

    Determines if ShowRowHeader has been initialized for the current object.

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

    HasShowTableIndent

    Determines if ShowTableIndent has been initialized for the current object.

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

    HasShowTableIndentAsCoveredRange

    Determines if ShowTableIndentAsCoveredRange has been initialized for the current object.

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

    HasShowTableRowHeaderAsCoveredRange

    Determines if ShowTableRowHeaderAsCoveredRange has been initialized for the current object.

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

    HasShowTreeLines

    Determines if ShowTreeLines has been initialized for the current object.

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

    HasSummaryRowHeight

    Determines if SummaryRowHeight has been initialized for the current object.

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

    HasTreeLineBorder

    Determines if TreeLineBorder has been initialized for the current object.

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

    HasVerticalPixelScroll

    Determines if VerticalPixelScroll has been initialized for the current object.

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

    IndentWidth

    Gets or sets the width in pixels of the indentation of each child group.

    Declaration
    public int IndentWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    ListBoxSelectionColorOptions

    Lets you specify the appearance of selected cells

    Declaration
    public GridListBoxSelectionColorOptions ListBoxSelectionColorOptions { get; set; }
    Property Value
    Type Description
    GridListBoxSelectionColorOptions

    ListBoxSelectionCurrentCellOptions

    Lets you specify behavior and appearance of the current cell when ListBoxSelectionMode was set

    Declaration
    public GridListBoxSelectionCurrentCellOptions ListBoxSelectionCurrentCellOptions { get; set; }
    Property Value
    Type Description
    GridListBoxSelectionCurrentCellOptions

    ListBoxSelectionMode

    Enables list box-like selection behavior for the grid when the user moves the current cell. When you set AllowSelection to GridSelectionFlags.None and specify ListBoxSelectionMode then a record-based selection mechanism is used. If you set this property to a value different from GridSelectionFlags.None a 2.x version compatible selection mechanism is used.

    Declaration
    public SelectionMode ListBoxSelectionMode { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.SelectionMode

    A System.Windows.Forms.SelectionMode that defines the list box-like selection behavior of the grid.

    Remarks

    Starting version 3.x the GridGroupingControl now supports multiple record selection and navigation across nested tables. In order to use the new record selection mechanism you need to set TableOptions.ListBoxSelection = SelectionMode.XYZ and make sure that TableOptions.AllowSelection = GridSelectionFlags.None. Optional settings can be specified with TableOptions.ListBoxSelectionColorOptions and TableOptions.ListBoxSelectionCurrentCellOptions.

    With the new record-based selection mode selected records can be found in Table.SelectedRecords collection.

    If you specify a different value for TableOptions.AllowSelection other than GridSelectionFlags.None the grid will operate in a backward-compatible mode and continue to use the old selection mechanism that was in place with 2.x and 1.x versions of the GridGroupingControl.

    Use TableOptions.AllowSelection only if you explicitly want the old selection behavior, e.g. if you want to be able to select individual cells or want to use Excel-like selection behavior.

    With the backward compatible selection mode selected rows and cells can be found in TableModel.Selections.Ranges collection.

    ListBoxSelectionOutlineBorder

    Lets you specify a border that should be drawn around a block of selected records.

    Declaration
    public GridBorder ListBoxSelectionOutlineBorder { get; set; }
    Property Value
    Type Description
    GridBorder

    ListBoxSelectionRecursive

    Indicates whether child records of a record should automatically be selected when a parent record is selected (when using multiple selection listbox mode).

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

    MaxDropDownTableSize

    Gets or sets the maximum size for the drop-down table of a foreign key related table.

    Declaration
    public Size MaxDropDownTableSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    MaxFilterBarChoiceListSize

    Gets or sets the maximum size for the drop-down part of a filter bar choice list.

    Declaration
    public Size MaxFilterBarChoiceListSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    RecordPreviewRowHeight

    Gets or sets the height in pixels of the record previews.

    Declaration
    public int RecordPreviewRowHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    RecordRowHeight

    Gets or sets the height in pixels of the record rows.

    Declaration
    public int RecordRowHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    RowHeaderWidth

    Gets or sets the width in pixels of the row header cells.

    Declaration
    public int RowHeaderWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    SelectionBackColor

    The background color for selected records.

    Declaration
    public Color SelectionBackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    SelectionTextColor

    The text color for selected records.

    Declaration
    public Color SelectionTextColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    ShowRecordPlusMinus

    Gets or sets a value indicating whether a PlusMinus cell should appear next to records or not. Only applicable for nested tables.

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

    ShowRecordPreviewRow

    Gets or sets a value indicating whether a nested table has a preview row or not. Only applicable for nested tables.

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

    ShowRowHeader

    Gets or sets a value indicating whether the row header column should be visible or not.

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

    ShowTableIndent

    Gets or sets a value indicating whether children of the records in the parent table should be indented or not. Only applicable for nested tables.

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

    ShowTableIndentAsCoveredRange

    Gets or sets a value indicating whether the cells in a particular indent level are treated as a single covered cell or not. Only applicable for nested tables.

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

    ShowTableRowHeaderAsCoveredRange

    Gets or sets a value indicating whether the row header cells for a particular nested table are treated as a single covered cell or not. Only applicable for nested tables.

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

    ShowTreeLines

    Gets or sets a value indicating whether the PlusMinus cells are shown connected with lines or not.

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

    SummaryRowHeight

    Gets or sets the height in pixels of the summary rows. The value -1 is a special setting to indicate the summary row height should always be the same as the RecordRowHeight.

    Declaration
    public int SummaryRowHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    TreeLineBorder

    Gets or sets the style of the line to draw the tree lines.

    Declaration
    public GridBorder TreeLineBorder { get; set; }
    Property Value
    Type Description
    GridBorder

    VerticalPixelScroll

    Gets or sets whether this table should support pixel scrolling. Note: You also need to have YAmountCounter enabled (see Engine.CounterLogic).

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

    Methods

    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()

    OnStyleChanged(StyleInfoProperty)

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

    ResetAllowDragColumns()

    Resets AllowDragColumns.

    Declaration
    public void ResetAllowDragColumns()

    ResetAllowDropDownCell()

    Resets AllowDropDownCell.

    Declaration
    public void ResetAllowDropDownCell()

    ResetAllowMultiColumnSort()

    Resets AllowMultiColumnSort.

    Declaration
    public void ResetAllowMultiColumnSort()

    ResetAllowSelection()

    Resets AllowSelection.

    Declaration
    public void ResetAllowSelection()

    ResetAllowSortColumns()

    Resets AllowSortColumns.

    Declaration
    public void ResetAllowSortColumns()

    ResetCaptionRowHeight()

    Resets CaptionRowHeight.

    Declaration
    public void ResetCaptionRowHeight()

    ResetColumnHeaderRowHeight()

    Resets ColumnHeaderRowHeight.

    Declaration
    public void ResetColumnHeaderRowHeight()

    ResetColumnsMaxLengthFirstNRecords()

    Resets ColumnsMaxLengthFirstNRecords.

    Declaration
    public void ResetColumnsMaxLengthFirstNRecords()

    ResetColumnsMaxLengthStrategy()

    Resets ColumnsMaxLengthStrategy.

    Declaration
    public void ResetColumnsMaxLengthStrategy()

    ResetDefaultColumnWidth()

    Resets DefaultColumnWidth.

    Declaration
    public void ResetDefaultColumnWidth()

    ResetDrawTextWithGdiInterop()

    Resets DrawTextWithGdiInterop.

    Declaration
    public void ResetDrawTextWithGdiInterop()

    ResetGridLineBorder()

    Resets GridLineBorder.

    Declaration
    public void ResetGridLineBorder()

    ResetGridVisualStyles()

    Resets GridVisualStyles.

    Declaration
    public void ResetGridVisualStyles()

    ResetGridVisualStylesDrawing()

    Resets GridVisualStylesDrawing.

    Declaration
    public void ResetGridVisualStylesDrawing()

    ResetGroupFooterSectionHeight()

    Resets GroupFooterSectionHeight.

    Declaration
    public void ResetGroupFooterSectionHeight()

    ResetGroupHeaderSectionHeight()

    Resets GroupHeaderSectionHeight.

    Declaration
    public void ResetGroupHeaderSectionHeight()

    ResetGroupPreviewSectionHeight()

    Resets GroupPreviewSectionHeight.

    Declaration
    public void ResetGroupPreviewSectionHeight()

    ResetIndentWidth()

    Resets IndentWidth.

    Declaration
    public void ResetIndentWidth()

    ResetListBoxSelectionColorOptions()

    Resets GridListBoxSelectionColorOptions.

    Declaration
    public void ResetListBoxSelectionColorOptions()

    ResetListBoxSelectionCurrentCellOptions()

    Resets GridListBoxSelectionCurrentCellOptions.

    Declaration
    public void ResetListBoxSelectionCurrentCellOptions()

    ResetListBoxSelectionMode()

    Resets ListBoxSelectionMode.

    Declaration
    public void ResetListBoxSelectionMode()

    ResetListBoxSelectionOutlineBorder()

    Resets ListBoxSelectionOutlineBorder.

    Declaration
    public void ResetListBoxSelectionOutlineBorder()

    ResetListBoxSelectionRecursive()

    Resets ListBoxSelectionRecursive.

    Declaration
    public void ResetListBoxSelectionRecursive()

    ResetMaxDropDownTableSize()

    Resets MaxDropDownTableSize.

    Declaration
    public void ResetMaxDropDownTableSize()

    ResetMaxFilterBarChoiceListSize()

    Resets MaxFilterBarChoiceListSize.

    Declaration
    public void ResetMaxFilterBarChoiceListSize()

    ResetRecordPreviewRowHeight()

    Resets the RecordPreviewRowHeight.

    Declaration
    public void ResetRecordPreviewRowHeight()

    ResetRecordRowHeight()

    Resets RecordRowHeight.

    Declaration
    public void ResetRecordRowHeight()

    ResetRowHeaderWidth()

    Resets RowHeaderWidth.

    Declaration
    public void ResetRowHeaderWidth()

    ResetSelectionBackColor()

    Resets SelectionBackColor.

    Declaration
    public void ResetSelectionBackColor()

    ResetSelectionTextColor()

    Resets SelectionTextColor.

    Declaration
    public void ResetSelectionTextColor()

    ResetShowRecordPlusMinus()

    Resets ShowRecordPlusMinus.

    Declaration
    public void ResetShowRecordPlusMinus()

    ResetShowRecordPreviewRow()

    Resets ShowRecordPreviewRow.

    Declaration
    public void ResetShowRecordPreviewRow()

    ResetShowRowHeader()

    Resets the ShowRowHeader.

    Declaration
    public void ResetShowRowHeader()

    ResetShowTableIndent()

    Resets the ShowTableIndent.

    Declaration
    public void ResetShowTableIndent()

    ResetShowTableIndentAsCoveredRange()

    Resets ShowTableIndentAsCoveredRange.

    Declaration
    public void ResetShowTableIndentAsCoveredRange()

    ResetShowTableRowHeaderAsCoveredRange()

    Resets ShowTableRowHeaderAsCoveredRange.

    Declaration
    public void ResetShowTableRowHeaderAsCoveredRange()

    ResetShowTreeLines()

    Resets ShowTreeLines.

    Declaration
    public void ResetShowTreeLines()

    ResetSummaryRowHeight()

    Resets SummaryRowHeight.

    Declaration
    public void ResetSummaryRowHeight()

    ResetTreeLineBorder()

    Resets TreeLineBorder.

    Declaration
    public void ResetTreeLineBorder()

    ResetVerticalPixelScroll()

    Resets VerticalPixelScroll.

    Declaration
    public void ResetVerticalPixelScroll()

    ToString()

    Returns a string holding the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    String representation of the current object.

    Overrides
    StyleInfoBase.ToString()

    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 - 2023 Syncfusion Inc. All Rights Reserved