WinForms

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

    Show / Hide Table of Contents

    Class GridGroupOptionsStyleInfo

    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 are displayed.

    Inheritance
    System.Object
    ShouldSerializeBasedPersisterType
    StyleInfoBase
    GridGroupOptionsStyleInfo
    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 GridGroupOptionsStyleInfo : 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

    GridGroupOptionsStyleInfo()

    Initializes a new style object.

    Declaration
    public GridGroupOptionsStyleInfo()

    GridGroupOptionsStyleInfo(StyleInfoIdentityBase)

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

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

    A GridGroupOptionsStyleInfoIdentity that holds the identity for this GridGroupOptionsStyleInfo.

    GridGroupOptionsStyleInfo(StyleInfoIdentityBase, GridGroupOptionsStyleInfoStore)

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

    Declaration
    public GridGroupOptionsStyleInfo(StyleInfoIdentityBase identity, GridGroupOptionsStyleInfoStore store)
    Parameters
    Type Name Description
    StyleInfoIdentityBase identity

    A GridGroupOptionsStyleInfoIdentity that holds the identity for this GridGroupOptionsStyleInfo.

    GridGroupOptionsStyleInfoStore store

    A GridGroupOptionsStyleInfoStore that holds data for this GridGroupOptionsStyleInfo. All changes in this style object will saved in the GridGroupOptionsStyleInfoStore object.

    GridGroupOptionsStyleInfo(GridGroupOptionsStyleInfo)

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

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

    The style object that contains the original data.

    GridGroupOptionsStyleInfo(GridGroupOptionsStyleInfoStore)

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

    Declaration
    public GridGroupOptionsStyleInfo(GridGroupOptionsStyleInfoStore store)
    Parameters
    Type Name Description
    GridGroupOptionsStyleInfoStore store

    A GridGroupOptionsStyleInfoStore that holds data for this GridGroupOptionsStyleInfo. All changes in this style object will saved in the GridGroupOptionsStyleInfoStore object.

    Fields

    Empty

    An empty style object.

    Declaration
    public static readonly GridGroupOptionsStyleInfo Empty
    Field Value
    Type Description
    GridGroupOptionsStyleInfo

    Properties

    CaptionSummaryRow

    Gets or sets the summary row that should be displayed inside CaptionSummaryCells when ShowCaptionSummaryCells has been set to true.

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

    CaptionText

    Gets or sets the caption text displayed. See the remarks for allowed tokens.

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

    Caption Format Tokens are:

    TokenDescription
    {TableName}Displays the CaptionSection.ParentTableDescriptor.Name
    {CategoryName}Displays the CaptionSection.ParentGroup.Name.
    {CategoryCaption}Displays the HeaderText of the column that this group belongs to.
    {Category}Displays the CaptionSection.ParentGroup.Category.
    {RecordCount}Displays the CaptionSection.ParentGroup.GetFilteredRecordCount().
    summary tokensAllows you to display any item you enter as a Summary Column. See discussion below:

    Custom Summary Tokens:

    Any summary item you add can be included in the CaptionText. You have the option of hiding summaries, so it is possible to add summaries only for the purpose of displaying values in the CaptionText. If you have added a summary row named Row1, and a Summary columns named Column1, then you can also use the value of this summary item in the caption with the token {Row1.Column1}.

    When used in ASP.Net you can also use the {PageCount} and {CurrentPage} tokens.

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

    Default

    Returns a GridGroupOptionsStyleInfo with default settings.

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

    DefaultForeignKeyTableGroupOptions

    Returns a GridGroupOptionsStyleInfo with default settings for look and behavior of the top level group.

    Declaration
    public static GridGroupOptionsStyleInfo DefaultForeignKeyTableGroupOptions { get; }
    Property Value
    Type Description
    GridGroupOptionsStyleInfo

    DefaultNestedTableGroupOptions

    Returns a GridGroupOptionsStyleInfo with default settings for the look and behavior of the nested child relations

    Declaration
    public static GridGroupOptionsStyleInfo DefaultNestedTableGroupOptions { get; }
    Property Value
    Type Description
    GridGroupOptionsStyleInfo

    DefaultTopLevelGroupOptions

    Returns a GridGroupOptionsStyleInfo with default settings for look and behavior of the top level group.

    Declaration
    public static GridGroupOptionsStyleInfo DefaultTopLevelGroupOptions { get; }
    Property Value
    Type Description
    GridGroupOptionsStyleInfo

    HasAllowScrollCaptionBar

    Gets a value that determines if Syncfusion.Windows.Forms.Grid.Grouping.GridGroupOptionsStyleInfo.AllowScrollCaptionBar has been initialized for the current object.

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

    HasCaptionSummaryRow

    Gets the value that determines if CaptionSummaryRow has been initialized for the current object.

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

    HasCaptionText

    Gets a value that determines if CaptionText has been initialized for the current object.

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

    HasIsExpandedInitialValue

    Gets a value that determines if IsExpandedInitialValue has been initialized for the current object.

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

    HasRepaintCaptionWhenItemsChanged

    Gets a value that determines if RepaintCaptionWhenItemsChanged has been initialized for the current object.

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

    HasShowAddNewRecordAfterDetails

    Gets the value that determines if ShowAddNewRecordAfterDetails has been initialized for the current object.

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

    HasShowAddNewRecordBeforeDetails

    Gets the value that determines if ShowAddNewRecordBeforeDetails has been initialized for the current object.

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

    HasShowCaption

    Gets a value that determines if ShowCaption has been initialized for the current object.

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

    HasShowCaptionPlusMinus

    Gets the value that determines if ShowCaptionPlusMinus has been initialized for the current object.

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

    HasShowCaptionSummaryCells

    Gets a value that determines if ShowCaptionSummaryCells has been initialized for the current object.

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

    HasShowColumnHeaders

    Gets a value that determines if ShowColumnHeaders has been initialized for the current object.

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

    HasShowEmptyGroups

    Gets a value that determines if ShowEmptyGroups has been initialized for the current object.

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

    HasShowFilterBar

    Gets a value that determines if ShowFilterBar has been initialized for the current object.

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

    HasShowGroupFooter

    Gets the value that determines if ShowGroupFooter has been initialized for the current object.

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

    HasShowGroupHeader

    Gets a value that determines if ShowGroupHeader has been initialized for the current object.

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

    HasShowGroupIndentAsCoveredRange

    Gets a value that determines if ShowGroupIndentAsCoveredRange has been initialized for the current object.

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

    HasShowGroupPreview

    Gets a value that determines if ShowGroupPreview has been initialized for the current object.

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

    HasShowGroupSummaryWhenCollapsed

    Gets a value determines if ShowGroupSummaryWhenCollapsed has been initialized for the current object.

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

    HasShowStackedHeaders

    Gets a value that determines if ShowStackedHeaders has been initialized for the current object.

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

    HasShowSummaries

    Gets a value that determines if ShowSummaries has been initialized for the current object.

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

    HasSummaryRowPlacement

    Gets a value that determines if SummaryRowPlacement has been initialized for the current object.

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

    IsExpandedInitialValue

    Gets or sets whether groups should be shown expanded initially. IsExpandedInitialValue will be assigned to groups when the table is categorized, e.g. when GroupedColumns were changed. This value must be set before the GroupedColumns are changed.

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

    RepaintCaptionWhenItemsChanged

    Gets or sets a value indicates whether the caption row should be repainted when a record that belongs to the group was changed. The setting only has an effect when InvalidateAllWhenListChanged = false.

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

    ShowAddNewRecordAfterDetails

    Gets or sets the value indicates whether AddNewRecord can be shown at bottom of group or not.

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

    ShowAddNewRecordBeforeDetails

    Gets or sets the value indicates whether AddNewRecord can be shown at top of group or not.

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

    ShowCaption

    Gets or sets a value indicates whether the Caption row is visible.

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

    ShowCaptionPlusMinus

    Gets or sets a value indicates whether there is a PlusMinus cell next to the Caption.

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

    ShowCaptionSummaryCells

    Gets or sets a value indicates whether the group caption should display summaries in columns instead of only one large caption bar. The CaptionSummaryRow then lets you specify a SummaryRow with Summary column information.

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

    ShowColumnHeaders

    Gets or sets a value indicates whether the column headers are visible.

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

    ShowEmptyGroups

    Gets or sets a value that indicates whether a preview is visible when group is collapsed.

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

    ShowFilterBar

    Gets or sets a value indicates whether the FilterBar are visible.

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

    ShowGroupFooter

    Gets or sets a value indicates whether a footer is visible.

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

    ShowGroupHeader

    Indicates whether a header is visible.

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

    ShowGroupIndentAsCoveredRange

    Gets or sets a value indicates whether to treat all indent cells for the group as a single covered cell.

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

    ShowGroupPreview

    Gets or sets a value indicates whether a preview is visible when the group is collapsed.

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

    ShowGroupSummaryWhenCollapsed

    Gets or sets a value indicates whether summary items are visible when the group is collapsed.

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

    ShowStackedHeaders

    Gets or sets a value indicates whether the stacked headers are visible.

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

    ShowSummaries

    Gets or sets a value indicates whether summaries are visible.

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

    SummaryRowPlacement

    Summaries location.

    Declaration
    public GridSummaryRowPlacement SummaryRowPlacement { get; set; }
    Property Value
    Type Description
    GridSummaryRowPlacement

    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)

    Raises when style info has changed.

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

    ResetAllowScrollCaptionBar()

    Resets Syncfusion.Windows.Forms.Grid.Grouping.GridGroupOptionsStyleInfo.AllowScrollCaptionBar.

    Declaration
    public void ResetAllowScrollCaptionBar()

    ResetCaptionSummaryRow()

    Resets CaptionSummaryRow.

    Declaration
    public void ResetCaptionSummaryRow()

    ResetCaptionText()

    Resets CaptionText.

    Declaration
    public void ResetCaptionText()

    ResetIsExpandedInitialValue()

    Resets IsExpandedInitialValue.

    Declaration
    public void ResetIsExpandedInitialValue()

    ResetRepaintCaptionWhenItemsChanged()

    Resets RepaintCaptionWhenItemsChanged.

    Declaration
    public void ResetRepaintCaptionWhenItemsChanged()

    ResetShowAddNewRecordAfterDetails()

    Resets ShowAddNewRecordAfterDetails.

    Declaration
    public void ResetShowAddNewRecordAfterDetails()

    ResetShowAddNewRecordBeforeDetails()

    Resets ShowAddNewRecordBeforeDetails.

    Declaration
    public void ResetShowAddNewRecordBeforeDetails()

    ResetShowCaption()

    Resets ShowCaption.

    Declaration
    public void ResetShowCaption()

    ResetShowCaptionPlusMinus()

    Resets ShowCaptionPlusMinus.

    Declaration
    public void ResetShowCaptionPlusMinus()

    ResetShowCaptionSummaryCells()

    Resets ShowCaptionSummaryCells.

    Declaration
    public void ResetShowCaptionSummaryCells()

    ResetShowColumnHeaders()

    Resets ShowColumnHeaders.

    Declaration
    public void ResetShowColumnHeaders()

    ResetShowEmptyGroups()

    Resets ShowEmptyGroups.

    Declaration
    public void ResetShowEmptyGroups()

    ResetShowFilterBar()

    Resets ShowFilterBar.

    Declaration
    public void ResetShowFilterBar()

    ResetShowGroupFooter()

    Resets ShowGroupFooter.

    Declaration
    public void ResetShowGroupFooter()

    ResetShowGroupHeader()

    Resets ShowGroupHeader.

    Declaration
    public void ResetShowGroupHeader()

    ResetShowGroupIndentAsCoveredRange()

    Resets ShowGroupIndentAsCoveredRange.

    Declaration
    public void ResetShowGroupIndentAsCoveredRange()

    ResetShowGroupPreview()

    Resets ShowGroupPreview.

    Declaration
    public void ResetShowGroupPreview()

    ResetShowGroupSummaryWhenCollapsed()

    Resets ShowGroupSummaryWhenCollapsed.

    Declaration
    public void ResetShowGroupSummaryWhenCollapsed()

    ResetShowStackedHeaders()

    Resets ShowStackedHeaders.

    Declaration
    public void ResetShowStackedHeaders()

    ResetShowSummaries()

    Resets ShowSummaries.

    Declaration
    public void ResetShowSummaries()

    ResetSummaryRowPlacement()

    Resets SummaryRowPlacement.

    Declaration
    public void ResetSummaryRowPlacement()

    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