Class GridVisibleColumnDescriptor

GridVisibleColumnDescriptor references a GridColumnDescriptor or GridColumnSetDescriptor. The order of GridVisibleColumnDescriptors in the VisibleColumns collection defines the left to right order of columns shown in the grid.

Columns are managed by the GridVisibleColumnDescriptorCollection that is returned by the VisibleColumns property of a GridTableDescriptor.

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

Constructors

GridVisibleColumnDescriptor()

Initializes a new empty column.

Declaration
public GridVisibleColumnDescriptor()

GridVisibleColumnDescriptor(String)

Initializes a new column with a name.

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

Descriptor name.

Properties

Collection

The collection this descriptor belongs to.

Declaration
public GridVisibleColumnDescriptorCollection Collection { get; }
Property Value
Type Description
GridVisibleColumnDescriptorCollection

InSetName

Used internally.

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

Name

Gets or sets the mapping for this column. You should specify which GridColumnDescriptor (by it's Name property) or GridColumnSetDescriptor you want to display in the grid at this column.

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

TableDescriptor

The TableDescriptor that this descriptor belongs to.

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

Methods

Clone()

Creates a copy of this descriptor.

Declaration
public GridVisibleColumnDescriptor Clone()
Returns
Type Description
GridVisibleColumnDescriptor

A copy of this descriptor.

Dispose(Boolean)

Disposes the unmanaged resources.

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

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

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

Descriptor name.
Overrides

InitializeFrom(GridVisibleColumnDescriptor)

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 void InitializeFrom(GridVisibleColumnDescriptor other)
Parameters
Type Name Description
GridVisibleColumnDescriptor 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 PropertyChanging event.

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

A System.ComponentModel.PropertyChangedEventArgs that contains the event data.

ShouldSerialize()

Determines if this object was modified.

Declaration
public override bool ShouldSerialize()
Returns
Type Description
System.Boolean

returns the boolean value false.
Overrides

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 Description
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration
public event DescriptorPropertyChangedEventHandler PropertyChanging
Event Type
Type Description
DescriptorPropertyChangedEventHandler

Explicit Interface Implementations

IStandardValuesProvider.GetStandardValues(PropertyDescriptor)

Declaration
ICollection IStandardValuesProvider.GetStandardValues(PropertyDescriptor pd)
Parameters
Type Name Description
System.ComponentModel.PropertyDescriptor pd
Returns
Type Description
System.Collections.ICollection

ICloneable.Clone()

Creates a new object that is a copy of the current instance.

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

A new object that is a copy of this instance.

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ICloneable