Class GridColumnSetDescriptor

The GridColumnSetDescriptor class provides information about columns that can spread multiple grid rows or columns.

ColumnSets are managed by the GridColumnSetDescriptorCollection that is returned by the ColumnSets property of a GridTableDescriptor.

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

Constructors

GridColumnSetDescriptor()

Initializes a new instances of the GridColumnSetDescriptor class.

Declaration
public GridColumnSetDescriptor()

GridColumnSetDescriptor(String)

Initializes a new instances of the GridColumnSetDescriptor class with a specified name.

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

Descriptor name.

Properties

Collection

Gets the collection this descriptor belongs to.

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

ColumnSpans

Gets the collection of columns spans that one or multiple column descriptors with a range of cells covered by cells of a column.

Declaration
public GridColumnSpanDescriptorCollection ColumnSpans { get; }
Property Value
Type
GridColumnSpanDescriptorCollection

Name

Gets or sets the name of the column set.

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

TableDescriptor

Gets the TableDescriptor that this descriptor belongs to.

Declaration
public GridTableDescriptor TableDescriptor { get; }
Property Value
Type
GridTableDescriptor

Methods

Clone()

Creates a copy of this descriptor.

Declaration
public GridColumnSetDescriptor Clone()
Returns
Type Description
GridColumnSetDescriptor

A copy of this descriptor.

Dispose(Boolean)

Overrides and manages the unwanted resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

Equals(Object)

Determines a value whether the specified System.Object is equal to the current System.Object or not.

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)

GetColCount()

Gets number of columns.

Declaration
public int GetColCount()
Returns
Type Description
System.Int32

Column count.

GetHashCode()

Gets 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 descriptor name.

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

Descriptor name.
Overrides

GetWidthColumns(out Int32[])

Gets an array of columns that affect the width of this column set.

Declaration
public GridColumnDescriptor[] GetWidthColumns(out int[] factor)
Parameters
Type Name Description
System.Int32[] factor

An array in the same order as the returned array with width factors indicating the number of grid columns spanned by a column descriptor.
Returns
Type Description
GridColumnDescriptor[]

An array of columns that affect the width of this column set. Each column will also have a width factor returned through the factor array.

InitializeFrom(GridColumnSetDescriptor)

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

Declaration
public void InitializeFrom(GridColumnSetDescriptor other)
Parameters
Type Name Description
GridColumnSetDescriptor other

The source object.

OnPropertyChanged(DescriptorPropertyChangedEventArgs)

Triggered when the PropertyChanged event is done.

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

A DescriptorPropertyChangedEventArgs contains the event data.

OnPropertyChanging(DescriptorPropertyChangedEventArgs)

Triggered when the PropertyChanging event is done.

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

A System.ComponentModel.PropertyChangedEventArgs contains the event data.

ResetName()

Resets the column set's name to an empty string.

Declaration
public void ResetName()

ShouldSerializeName()

Determines a value indicating whether the column sets name was modified (not empty) or not.

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

True if name is modified; Otherwise False.

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

Clones the current collection.

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

The cloned values.

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ICloneable