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
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable
Inherited Members
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.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
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
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
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
GridGroupOptionsStyleInfoCustomPropertiesCollection

Default

Returns a GridGroupOptionsStyleInfo with default settings.

Declaration
public static GridGroupOptionsStyleInfo Default { get; }
Property Value
Type
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
System.Boolean

HasShowGroupSummaryWhenCollapsed

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

Declaration
public bool HasShowGroupSummaryWhenCollapsed { get; }
Property Value
Type
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
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
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
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
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
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
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
System.Boolean

ShowCaption

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

Declaration
public bool ShowCaption { get; set; }
Property Value
Type
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
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
System.Boolean

ShowColumnHeaders

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

Declaration
public bool ShowColumnHeaders { get; set; }
Property Value
Type
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
System.Boolean

ShowFilterBar

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

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

ShowGroupFooter

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

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

ShowGroupHeader

Indicates whether a header is visible.

Declaration
public bool ShowGroupHeader { get; set; }
Property Value
Type
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
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
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
System.Boolean

ShowStackedHeaders

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

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

ShowSummaries

Gets or sets a value indicates whether summaries are visible.

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

SummaryRowPlacement

Summaries location.

Declaration
public GridSummaryRowPlacement SummaryRowPlacement { get; set; }
Property Value
Type
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

OnStyleChanged(StyleInfoProperty)

Raises when style info has changed.

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

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

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable