menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridColumnSpanDescriptor - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridColumnSpanDescriptor

    Represent a class that provides information about a column that can span multiple grid rows or columns.

    The GridColumnSpanDescriptor are managed by the GridColumnSpanDescriptorCollection that is returned by the ColumnSpans property of a GridColumnSetDescriptor.

    Inheritance
    System.Object
    ShouldSerializeBasedPersisterType
    DescriptorBase
    GridColumnSpanDescriptor
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStandardValuesProvider
    System.ICloneable
    Inherited Members
    DescriptorBase.CanResetValue()
    DescriptorBase.Dispose()
    DescriptorBase.Disposed
    DescriptorBase.Disposing
    DescriptorBase.InDisposed
    DescriptorBase.IsDisposed
    DescriptorBase.OnDisposed(EventArgs)
    DescriptorBase.Reset()
    DescriptorBase.ShouldSerialize()
    DescriptorBase.ToString()
    ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)
    ShouldSerializeBasedPersisterType.CheckAllProperties
    ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)
    ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)
    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 GridColumnSpanDescriptor : DescriptorBase, ICustomTypeDescriptor, IDisposable, IStandardValuesProvider, ICloneable

    Constructors

    GridColumnSpanDescriptor()

    Initializes a new empty column span.

    Declaration
    public GridColumnSpanDescriptor()

    GridColumnSpanDescriptor(String)

    Initializes a new instance of the GridColumnSpanDescriptor class with a specified name.

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

    GridColumnSpanDescriptor(String, String)

    Initializes a new instance of the GridColumnSpanDescriptor class with a column span, column name and range that specifies the cells the column covers.

    Declaration
    public GridColumnSpanDescriptor(string name, string range)
    Parameters
    Type Name Description
    System.String name
    System.String range

    Properties

    Collection

    Gets the collection this descriptor belongs to.

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

    ColumnSet

    Gets the GridColumnSet that this descriptor belongs to.

    Declaration
    public GridColumnSetDescriptor ColumnSet { get; }
    Property Value
    Type
    GridColumnSetDescriptor

    Name

    Gets or sets the name of a GridColumnDescriptor.

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

    Range

    Gets or sets the range of the columns that spans. Row and columns are zero based, e.g. R0C0:R0C1 indicates the column spans two columns at the top.

    Declaration
    public GridRangeInfo Range { get; set; }
    Property Value
    Type
    GridRangeInfo

    RangeInfo

    Gets or sets the value of Range. Used internally.

    Declaration
    public string RangeInfo { 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 GridColumnSpanDescriptor Clone()
    Returns
    Type Description
    GridColumnSpanDescriptor

    A copy of this descriptor.

    Dispose(Boolean)

    Overrides and manages the unmanaged resources.

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

    Equals(Object)

    Determines a value indicating 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)

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

    Overrides and gets the name of the descriptor.

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

    Descriptor name.

    Overrides
    DescriptorBase.GetName()

    InitializeFrom(GridColumnSpanDescriptor)

    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(GridColumnSpanDescriptor other)
    Parameters
    Type Name Description
    GridColumnSpanDescriptor 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.

    ResetRange()

    Resets the range to an empty range.

    Declaration
    public void ResetRange()

    ShouldSerializeRange()

    Determines a value indicating whether the range was modified (not empty) or not.

    Declaration
    public bool ShouldSerializeRange()
    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

    IStandardValuesProvider.GetStandardValues(PropertyDescriptor)

    Gets the standard values of the specified property descriptor.

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

    An instance of the System.ComponentModel.PropertyDescriptor class.

    Returns
    Type
    System.Collections.ICollection

    ICloneable.Clone()

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

    Implements

    System.ComponentModel.ICustomTypeDescriptor
    System.IDisposable
    IStandardValuesProvider
    System.ICloneable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved