Class GridTableBaseStyle

A GridTableBaseStyle declares BaseStyles for the whole engine. GridTableBaseStyles are managed by the GridTableBaseStyleCollection which is returned by the BaseStyles property of a GridEngine.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
DescriptorBase
GridTableBaseStyle
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ICloneable
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 GridTableBaseStyle : DescriptorBase, ICustomTypeDescriptor, IDisposable, ICloneable

Constructors

GridTableBaseStyle()

Initializes a new empty object.

Declaration
public GridTableBaseStyle()

GridTableBaseStyle(String)

Initializes a new object with a name.

Declaration
public GridTableBaseStyle(string name)
Parameters
Type Name Description
System.String name

The name of the GridTableBaseStyle.

Properties

Collection

Gets the collection this descriptor belongs to.

Declaration
public GridTableBaseStyleCollection Collection { get; }
Property Value
Type
GridTableBaseStyleCollection

Name

Gets or sets the name of this descriptor. This name is used to look up the summary in the GridTableBaseStyleCollection.

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

StyleInfo

Gets or sets the style information for this base style.

Declaration
public GridTableCellStyleInfo StyleInfo { get; set; }
Property Value
Type
GridTableCellStyleInfo

Methods

Clone()

Creates a copy of this descriptor.

Declaration
public GridTableBaseStyle Clone()
Returns
Type Description
GridTableBaseStyle

A copy of this descriptor.

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The System.Object to compare with the current System.Object.
Returns
Type Description
System.Boolean

true if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

A hash code for the current object.
Overrides
System.Object.GetHashCode()

GetName()

Gets the name of the descriptor.

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

The name of this descriptor. This name is used to look up the summary in the GridTableBaseStyleCollection.
Overrides

InitializeFrom(GridTableBaseStyle)

Initializes this object and copies properties from another object. PropertyChanging and PropertyChanged events are raised for every property that is modified. If both objects are equal, no events are raised.

Declaration
public virtual void InitializeFrom(GridTableBaseStyle other)
Parameters
Type Name Description
GridTableBaseStyle other

The source object.

OnPropertyChanged(DescriptorPropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration
protected virtual void OnPropertyChanged(DescriptorPropertyChangedEventArgs e)
Parameters
Type Name Description
DescriptorPropertyChangedEventArgs e

A DescriptorPropertyChangedEventArgs that contains the event data.

OnPropertyChanging(DescriptorPropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration
protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)
Parameters
Type Name Description
DescriptorPropertyChangedEventArgs e

A DescriptorPropertyChangedEventArgs that contains the event data.

Reset()

Resets the style.

Declaration
public override void Reset()
Overrides

ResetName()

Resets the name to empty string.

Declaration
public void ResetName()

ResetStyle()

Resets style information.

Declaration
public void ResetStyle()

ShouldSerializeName()

Checks if name is not empty.

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

True if not empty; False if empty.

ShouldSerializeStyle()

Determines if style information has been set and should be serialized into code at design-time.

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

True if style information has been set; False otherwise.

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

Events

PropertyChanged

Occurs when a property is changed.

Declaration
public event DescriptorPropertyChangedEventHandler PropertyChanged
Event Type
Type
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration
public event DescriptorPropertyChangedEventHandler PropertyChanging
Event Type
Type
DescriptorPropertyChangedEventHandler

Explicit Interface Implementations

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type
System.Object

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ICloneable