Class GridGroupingLookAndFeel
Implements the class that provides support for serializing and restoring the look and feel of a GridGroupingControl. The GridGroupingLookAndFeel maintains a copy for properties of the GridGroupingControl and offers methods to read and write these settings. After creating a GridGroupingLookAndFeel object from an XML file, you can apply its settings to a GridGroupingControl.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridGroupingLookAndFeel
Constructors
GridGroupingLookAndFeel()
Initializes a new instance of the GridGroupingLookAndFeel class.
Declaration
public GridGroupingLookAndFeel()
Properties
Appearance
Gets or sets the default GridTableCellAppearance with default GridTableCellStyleInfo information for all cell elements in the control. This property lets you control almost any aspect of the appearance of the grouping grid like cell back color, font, or the cell type.
Declaration
public GridTableCellAppearance Appearance { get; set; }
Property Value
Type |
---|
GridTableCellAppearance |
BaseStyles
Gets or sets the collection of BaseStyles. Users can add BaseStyles to the engine (also in design time) and then inherit style settings through the GridStyleInfo.BaseStyle property in GridTableCellStyleInfo property of GridTableCellAppearance.
Declaration
public GridTableBaseStyleCollection BaseStyles { get; set; }
Property Value
Type |
---|
GridTableBaseStyleCollection |
ChildGroupOptions
Gets or sets the look of inner groups such as whether the Caption Row is visible or what CaptionText is.
Declaration
public GridGroupOptionsStyleInfo ChildGroupOptions { get; set; }
Property Value
Type |
---|
GridGroupOptionsStyleInfo |
GridOfficeScrollBars
Gets or sets the grid office scrollbars.
Declaration
public OfficeScrollBars GridOfficeScrollBars { get; set; }
Property Value
Type |
---|
OfficeScrollBars |
GridVisualStyles
Gets or sets the VisualStyles (skins) like Office2007, Office2003.
Declaration
public GridVisualStyles GridVisualStyles { get; set; }
Property Value
Type |
---|
GridVisualStyles |
NestedTableGroupOptions
Gets or sets the look of the topmost group of nested tables such as whether the Caption Row is visible or what CaptionText is.
Declaration
public GridGroupOptionsStyleInfo NestedTableGroupOptions { get; set; }
Property Value
Type |
---|
GridGroupOptionsStyleInfo |
Office2007ScrollBars
Gets or sets the value indicating whether Office2007 scrollbars should be shown or not.
Declaration
public bool Office2007ScrollBars { get; set; }
Property Value
Type |
---|
System.Boolean |
Office2007ScrollBarsColorScheme
Gets or sets the style of Office2007 scroll bars.
Declaration
public Office2007ColorScheme Office2007ScrollBarsColorScheme { get; set; }
Property Value
Type |
---|
Office2007ColorScheme |
Office2010ScrollBarsColorScheme
Gets or sets the style of Office2010 scroll bars.
Declaration
public Office2010ColorScheme Office2010ScrollBarsColorScheme { get; set; }
Property Value
Type |
---|
Office2010ColorScheme |
TableOptions
Gets or sets the table-wide properties such as the width of the indent column or whether header rows should be visible.
Declaration
public GridTableOptionsStyleInfo TableOptions { get; set; }
Property Value
Type |
---|
GridTableOptionsStyleInfo |
TopLevelGroupOptions
Gets or sets the look of the topmost group such as whether the Caption Row is visible or what CaptionText is.
Declaration
public GridGroupOptionsStyleInfo TopLevelGroupOptions { get; set; }
Property Value
Type |
---|
GridGroupOptionsStyleInfo |
Methods
ApplyTo(GridGroupingControl)
Applies settings to a GridGroupingControl.
Declaration
public void ApplyTo(GridGroupingControl groupingControl)
Parameters
Type | Name | Description |
---|---|---|
GridGroupingControl | groupingControl | The target control. |
CreateFromXml(TextReader)
Creates an instance of the GridGroupingLookAndFeel class from a valid XML stream.
Declaration
public static GridGroupingLookAndFeel CreateFromXml(TextReader r)
Parameters
Type | Name | Description |
---|---|---|
System.IO.TextReader | r | The TextReader with XML stream. |
Returns
Type | Description |
---|---|
GridGroupingLookAndFeel | An instance of the GridGroupingLookAndFeel class. |
CreateFromXml(XmlReader)
Creates an instance of the GridGroupingLookAndFeel class from a valid XML stream.
Declaration
public static GridGroupingLookAndFeel CreateFromXml(XmlReader xr)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlReader | xr | The XML stream. |
Returns
Type | Description |
---|---|
GridGroupingLookAndFeel | An instance of the GridGroupingLookAndFeel class. |
GetXmlSerializer()
Gets the System.Xml.Serialization.XmlSerializer that can be used to serialize and deserialize this object to XML.
Declaration
public static XmlSerializer GetXmlSerializer()
Returns
Type | Description |
---|---|
System.Xml.Serialization.XmlSerializer | The XML serializer. |
InitializeFrom(GridGroupingControl)
Extracts settings from a GridGroupingControl.
Declaration
public void InitializeFrom(GridGroupingControl groupingControl)
Parameters
Type | Name | Description |
---|---|---|
GridGroupingControl | groupingControl | The source control. |
ResetAppearance()
Discards any changes for the Appearance object.
Declaration
public void ResetAppearance()
ResetBaseStyles()
Resets the BaseStyles property.
Declaration
public void ResetBaseStyles()
ResetChildGroupOptions()
Discards any changes for the ChildGroupOptions property.
Declaration
public void ResetChildGroupOptions()
ResetGridOfficeScrollBars()
Discards any changes for the GridOfficeScrollBars property.
Declaration
public void ResetGridOfficeScrollBars()
ResetGridVisualStyles()
Discards any changes for the GridVisualStyles property.
Declaration
public void ResetGridVisualStyles()
ResetNestedTableGroupOptions()
Discards any changes for the NestedTableGroupOptions property.
Declaration
public void ResetNestedTableGroupOptions()
ResetOffice2007ScrollBars()
Discards any changes for the Office2007ScrollBars property.
Declaration
public void ResetOffice2007ScrollBars()
ResetOffice2007ScrollBarsColorScheme()
Discards any changes for the Office2007ScrollBarsColorScheme property.
Declaration
public void ResetOffice2007ScrollBarsColorScheme()
ResetOffice2010ScrollBarsColorScheme()
Discards any changes for the Office2010ScrollBarsColorScheme property.
Declaration
public void ResetOffice2010ScrollBarsColorScheme()
ResetTableOptions()
Discards any changes for the TableOptions property.
Declaration
public void ResetTableOptions()
ResetTopLevelGroupOptions()
Discards any changes for the TopLevelGroupOptions property.
Declaration
public void ResetTopLevelGroupOptions()
ShouldSerializeAppearance()
Determines a value indicating whether Appearance has been modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeAppearance()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeBaseStyles()
Determines whether BaseStyles has been modified and contents should be serialized at design-time.
Declaration
public bool ShouldSerializeBaseStyles()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeChildGroupOptions()
Determines a value indicating whether ChildGroupOptions were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeChildGroupOptions()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeGridOfficeScrollBars()
Determines whether GridOfficeScrollBars were modified and contents should be serialized at design-time.
Declaration
public bool ShouldSerializeGridOfficeScrollBars()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeGridVisualStyles()
Determines a value indicating whether GridVisualStyles were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeGridVisualStyles()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeNestedTableGroupOptions()
Determines a value indicating whether NestedTableGroupOptions were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeNestedTableGroupOptions()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeOffice2007ScrollBars()
Determines a value indicating whether Office2007ScrollBars were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeOffice2007ScrollBars()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeOffice2007ScrollBarsColorScheme()
Determines a value indicating whether Office2007ScrollBarsColorScheme were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeOffice2007ScrollBarsColorScheme()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeOffice2010ScrollBarsColorScheme()
Determines a value indicating whether the Office2010ScrollBarsColorScheme were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeOffice2010ScrollBarsColorScheme()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeTableOptions()
Determines a value indicating whether the TableOptions were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeTableOptions()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
ShouldSerializeTopLevelGroupOptions()
Determines a value whether TopLevelGroupOptions were modified and contents should be serialized or not at design-time.
Declaration
public bool ShouldSerializeTopLevelGroupOptions()
Returns
Type | Description |
---|---|
System.Boolean | True if contents were changed; False otherwise. |
WriteXml(TextWriter)
Saves the settings to an XML stream.
Declaration
public void WriteXml(TextWriter w)
Parameters
Type | Name | Description |
---|---|---|
System.IO.TextWriter | w | An instance of the System.IO.TextWriter class. |
WriteXml(XmlWriter)
Saves the settings to an XML stream.
Declaration
public void WriteXml(XmlWriter xw)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlWriter | xw | An instance of the System.Xml.XmlWriter class. |