public class GridColumnDescriptor : DescriptorBase, ICustomTypeDescriptor, IDisposable, ICloneable, IStandardValuesProvider, IGridTableCellAppearanceSource, IGridGroupOptionsSource

Constructors

GridColumnDescriptor()

Initializes a new instance of the GridColumnDescriptor class.

Declaration

public GridColumnDescriptor()

GridColumnDescriptor(FieldDescriptor)

Initializes a new instance of the GridColumnDescriptor class with the specified instance of the information retrieved from an instance of the FieldDescriptor class.

Declaration

public GridColumnDescriptor(FieldDescriptor field)

Parameters

Type	Name	Description
FieldDescriptor	field	The field descriptor provides mapping information to a column of the underlying datasource.

GridColumnDescriptor(FieldDescriptor, String)

Initializes a new instance of the GridColumnDescriptor class with the specified instance of the information retrieved from an instance of the FieldDescriptor class with a specified name.

Declaration

public GridColumnDescriptor(FieldDescriptor field, string name)

Parameters

Type	Name	Description
FieldDescriptor	field	The field descriptor provides mapping information to a column of the underlying datasource.
System.String	name	Column name.

GridColumnDescriptor(String)

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

Declaration

public GridColumnDescriptor(string name)

Parameters

Type	Name	Description
System.String	name	Column name.

GridColumnDescriptor(String, String)

Initializes a new instance of the GridColumnDescriptor class with a specified name and mapping name.

Declaration

public GridColumnDescriptor(string name, string mappingName)

Parameters

Type	Name	Description
System.String	name	Name of the column.
System.String	mappingName	Mapping name of the column.

GridColumnDescriptor(String, String, String)

Initializes a new instance of the GridColumnDescriptor class with a specified name, mapping name and a header text.

Declaration

public GridColumnDescriptor(string name, string mappingName, string headerText)

Parameters

Type	Name	Description
System.String	name	Name of the column.
System.String	mappingName	Mapping name of the column.
System.String	headerText	Column header text, which is displayed in the column header cell of the grouping grid.

GridColumnDescriptor(String, String, String, Boolean)

Initializes a new instance of the GridColumnDescriptor class with the specified name, mapping name, header text and also determines the column to be read-only column or not.

Declaration

public GridColumnDescriptor(string name, string mappingName, string headerText, bool readOnly)

Parameters

Type	Name	Description
System.String	name	Name of the column.
System.String	mappingName	Mapping name of the column.
System.String	headerText	Column header text.
System.Boolean	readOnly	Specifies the read-only state of the column. IfTrue then the column is read-only; Otherwise False.

GridColumnDescriptor(String, String, String, Boolean, Int32)

Initializes a new instance of the GridColumnDescriptor class with the specified name, mapping name, header text, column width and also determines the column to be read-only column or not.

Declaration

public GridColumnDescriptor(string name, string mappingName, string headerText, bool readOnly, int width)

Parameters

Type	Name	Description
System.String	name	Name of the column.
System.String	mappingName	Mapping name of the column.
System.String	headerText	Column header text.
System.Boolean	readOnly	Specifies the read-only state of the column.
System.Int32	width	Column width.

Properties

AllowAppearanceDeserialization

Gets or sets a value indicating whether to enable or disable the appearance deserialization.

Declaration

public bool AllowAppearanceDeserialization { get; set; }

Property Value

Type
System.Boolean

AllowBlink

Gets or sets a value indicating whether the cell allows being highlighted when its value is changed or not. In such case the cell is being highlighted with colors specified in the BaseStyles collection and the time period specified in BlinkTime of the GridGroupingControl. Default value is false.

Declaration

public bool AllowBlink { get; set; }

Property Value

Type
System.Boolean

AllowDropDownCell

Gets or sets the value indicating whether the grid can show a drop-down list or not for cells in this column if column represents a foreign key field from a related table.

Declaration

public bool AllowDropDownCell { get; set; }

Property Value

Type
System.Boolean

AllowFilter

Gets or sets a value indicating whether a column supports FilterBar or not.

Declaration

public bool AllowFilter { get; set; }

Property Value

Type
System.Boolean

AllowGroupByColumn

Gets or sets a value indicating whether the grid can be grouped by this column when the user drags the column over the GropDropArea or not.

Declaration

public bool AllowGroupByColumn { get; set; }

Property Value

Type
System.Boolean

AllowSort

Gets or sets a value indicating whether to enable or disable sort by this column.

Declaration

public bool AllowSort { get; set; }

Property Value

Type
System.Boolean

Appearance

Gets or sets the default GridTableCellAppearance with default GridTableCellStyleInfo information for all cell elements that display data of this column. 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

Collection

Gets the collection values of the current column descriptor belongs.

Declaration

public GridColumnDescriptorCollection Collection { get; }

Property Value

Type
GridColumnDescriptorCollection

EditFormColumnIndex

Gets or sets the specified column index in form edit mode.

Declaration

public int EditFormColumnIndex { get; set; }

Property Value

Type
System.Int32

Engine

Gets the GridEngine that this column descriptor belongs to.

Declaration

public GridEngine Engine { get; }

Property Value

Type
GridEngine

FieldDescriptor

Gets the field descriptor this descriptor holds. If this column descriptor is not a bound column, the method will return NULL.

Declaration

public FieldDescriptor FieldDescriptor { get; }

Property Value

Type	Description
FieldDescriptor	A field descriptor.

FilterRowOptions

An object specifying a set of options for the current column that are related to Filtering.

Declaration

public FilterRowOptions FilterRowOptions { get; set; }

Property Value

Type
FilterRowOptions

GroupByAppearance

Gets the default GridTableCellAppearance with default GridTableCellStyleInfo information for all cell elements in the table that belong to groups that were grouped by this column. This property only has an effect on the appearance of the table if this column has been added to the GroupedColumns collection of a TableDescriptor.

Declaration

public GridTableCellAppearance GroupByAppearance { get; }

Property Value

Type
GridTableCellAppearance

GroupByOptions

Gets or sets the group options for grid table. The GridGroupOptionsStyleInfo which lets you control the look and behavior of the child groups. You can control the caption text, where and if AddNewRow will be displayed, or whether captions, footers, previews and summaries are displayed.

This property only has an effect on the appearance of the table if this column has been added to the GroupedColumns collection of a TableDescriptor.

Declaration

public GridGroupOptionsStyleInfo GroupByOptions { get; set; }

Property Value

Type
GridGroupOptionsStyleInfo

HeaderImage

Gets or sets the image to draw in header cell.

Declaration

public Image HeaderImage { get; set; }

Property Value

Type
System.Drawing.Image

HeaderImageAlignment

Get or set the alignment of image at header.

Declaration

public HeaderImageAlignment HeaderImageAlignment { get; set; }

Property Value

Type
HeaderImageAlignment

HeaderText

The header text to be displayed in the column header. If no header text has been specified, the header text will be the same as the Name.

Declaration

public string HeaderText { get; set; }

Property Value

Type
System.String

Info

Gets the information of the current column. Used internally.

Declaration

public string Info { get; }

Property Value

Type
System.String

MappingName

Gets or sets the mapping name for this column. You should specify which column of a DataTable you want to display in the grid at this column.

Declaration

public string MappingName { get; set; }

Property Value

Type
System.String

MaxLength

Gets or sets the specifies the maximum length of the formatted text for this column. This value will be used for calculating the optimal width of a column. If the value is -1 the engine will determine the optimal width of a column either by looping through the first n records or using a SummaryDescriptor that keeps track of the entry with most characters (see GridTableOptionsStyleInfo.ColumnsMaxLengthStrategy and GridTableOptionsStyleInfo.ColumnsMaxLengthFirstNRecords).

Declaration

public int MaxLength { get; set; }

Property Value

Type
System.Int32

Name

Gets or sets the name of the column.

Declaration

public virtual string Name { get; set; }

Property Value

Type
System.String

Remarks

If Name is not specified, the MappingName will be assigned to Name. Name and MappingName should be same when you specify Name.

ReadOnly

Gets or sets Read-only state of the column.

Declaration

public bool ReadOnly { get; set; }

Property Value

Type
System.Boolean

SerializedImageArray

Gets or sets the string values used for serialization and deserialization of header images.

Declaration

public string SerializedImageArray { get; set; }

Property Value

Type
System.String

SortByDisplayMember

Gets or sets a value indicating whether to enable or disable sort this column by display member.

Declaration

public bool SortByDisplayMember { get; set; }

Property Value

Type
System.Boolean

TableDescriptor

Gets the value of TableDescriptor that this descriptor instance belongs to.

Declaration

public GridTableDescriptor TableDescriptor { get; }

Property Value

Type
GridTableDescriptor

TrackWidthOfParentColumn

Gets or sets the value of a column's width in a parent record that the column in the child record should track. Use this if you have frozen columns and want to make sure that columns in nested records are properly aligned.

Declaration

public string TrackWidthOfParentColumn { get; set; }

Property Value

Type
System.String

Width

Gets or sets the width of the column.

Declaration

public int Width { get; set; }

Property Value

Type
System.Int32

Methods

Clone()

Creates a copy of this descriptor.

Declaration

public virtual GridColumnDescriptor Clone()

Returns

Type	Description
GridColumnDescriptor	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

DescriptorBase.Dispose(Boolean)

Equals(Object)

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

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

Overrides and gets the name of the descriptor for the current object.

Declaration

public override string GetName()

Returns

Type	Description
System.String	Descriptor name.

Overrides

DescriptorBase.GetName()

GetRelativeColumnIndex()

Gets the relative column index.

Declaration

public int GetRelativeColumnIndex()

Returns

Type	Description
System.Int32	Relative column index.

Remarks

Helper method returns relative column index for column taking layout of column sets into consideration. To get the real column index you need to add TableDescriptor.GetColumnIndentCount().

InitializeFrom(GridColumnDescriptor)

Initializes the current 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(GridColumnDescriptor other)

Parameters

Type	Name	Description
GridColumnDescriptor	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 DescriptorPropertyChangedEventArgs contains the event data.

Reset()

Overrides and resets the descriptor settings.

Declaration

public override void Reset()

Overrides

DescriptorBase.Reset()

ResetAllowBlink()

Resets columns AllowBlink setting.

Declaration

public void ResetAllowBlink()

ResetAllowDropDownCell()

Resets the columns AllowDropDownCell setting.

Declaration

public void ResetAllowDropDownCell()

ResetAllowFilter()

Resets the columns AllowFilter setting.

Declaration

public void ResetAllowFilter()

ResetAllowGroupByColumn()

Resets columns AllowGroupByColumn setting.

Declaration

public void ResetAllowGroupByColumn()

ResetAllowSort()

Resets columns AllowFilter setting.

Declaration

public void ResetAllowSort()

ResetAppearance()

Discards any changes for the Appearance object.

Declaration

public void ResetAppearance()

ResetEditFormColumnIndex()

Resets EditFormColumnIndex.

Declaration

public void ResetEditFormColumnIndex()

ResetFilterRowOptions()

Resets columns FilterRowOptions setting.

Declaration

public void ResetFilterRowOptions()

ResetGroupByAppearance()

Discards any changes for the GroupByAppearance object.

Declaration

public void ResetGroupByAppearance()

ResetGroupByOptions()

Discards any changes for the GroupByOptions object.

Declaration

public void ResetGroupByOptions()

ResetHeaderImage()

Resets the header image.

Declaration

public void ResetHeaderImage()

ResetHeaderImageAlignment()

Gets or sets the header text to be displayed in the column header. If no header text has been specified, the header text will be the same as the Name. Resets the header image alignment.

Declaration

public void ResetHeaderImageAlignment()

ResetHeaderText()

Resets the header text.

Declaration

public void ResetHeaderText()

ResetMaxLength()

Discards any changes for MaxLength.

Declaration

public void ResetMaxLength()

ResetName()

Resets the column's name.

Declaration

public void ResetName()

ResetReadOnly()

Resets column's Read-only setting.

Declaration

public void ResetReadOnly()

ResetSerializedImageArray()

Resets the image serialization text.

Declaration

public void ResetSerializedImageArray()

ResetSortByDisplayMember()

Discards any changes for the SortByDisplayMember property.

Declaration

public void ResetSortByDisplayMember()

ResetTrackWidthOfParentColumn()

Resets the TrackWidthOfParentColumn property.

Declaration

public void ResetTrackWidthOfParentColumn()

ResetWidth()

Resets the column width and allows the grid to auto-size the column based on its contents.

Declaration

public void ResetWidth()

SetWidthInt(Int32)

Sets the width of the column. It will not raises PropertyChanged events. The grid uses this method internally when column widths are automatically resized based on their contents.

Declaration

public void SetWidthInt(int value)

Parameters

Type	Name	Description
System.Int32	value	The new value.

ShouldSerialize()

Determines a value indicating whether the current object and its children should be serialized or not.

Declaration

public override bool ShouldSerialize()

Returns

Type	Description
System.Boolean	True if it should be serialized; Otherwise False.

Overrides

DescriptorBase.ShouldSerialize()

ShouldSerializeAllowBlink()

Determines a value indicating whether the column's AllowBlink property was modified or not.

Declaration

public bool ShouldSerializeAllowBlink()

Returns

Type	Description
System.Boolean	Trueif AllowBlink property was modified; Otherwise False.

ShouldSerializeAllowDropDownCell()

Determines a value indicating whether the column's AllowDropDownCell property was modified or not.

Declaration

public bool ShouldSerializeAllowDropDownCell()

Returns

Type	Description
System.Boolean	True if AllowDropDownCell property was modified; Otherwise False.

ShouldSerializeAllowFilter()

Determines a value indicating whether the column's AllowFilter property was modified or not.

Declaration

public bool ShouldSerializeAllowFilter()

Returns

Type	Description
System.Boolean	True if AllowFilter setting is modified; Otherwise False.

ShouldSerializeAllowGroupByColumn()

Determines if the column's AllowGroupByColumn property was modified.

Declaration

public bool ShouldSerializeAllowGroupByColumn()

Returns

Type	Description
System.Boolean	True if AllowGroupByColumn property was modified.

ShouldSerializeAllowSort()

Determines if the column's AllowSort property was modified.

Declaration

public bool ShouldSerializeAllowSort()

Returns

Type	Description
System.Boolean	True if AllowSort setting is modified.

ShouldSerializeAppearance()

Determines a value indicating whether a value Appearance has been modified and its contents should be serialized or not at design-time.

Declaration

public bool ShouldSerializeAppearance()

Returns

Type	Description
System.Boolean	True if contents were changed; Otherwise False.

ShouldSerializeEditFormColumnIndex()

Determines a value indicating whether the default value was modified or not.

Declaration

public bool ShouldSerializeEditFormColumnIndex()

Returns

Type	Description
System.Boolean	True if it was modified; Otherwise False.

ShouldSerializeFilterRowOptions()

Determines a value indicating whether the column's AllowSort property was modified or not.

Declaration

public bool ShouldSerializeFilterRowOptions()

Returns

Type	Description
System.Boolean	True if AllowSort setting is modified; Otherwise False.

ShouldSerializeGroupByAppearance()

Determines whether GroupByAppearance has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeGroupByAppearance()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeGroupByOptions()

Determines whether GroupByOptions has been modified and its contents should be serialized at design-time.

Declaration

public bool ShouldSerializeGroupByOptions()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeHeaderImage()

Determines if the column's header image was modified.

Declaration

public bool ShouldSerializeHeaderImage()

Returns

Type	Description
System.Boolean	True if header text is modified.

ShouldSerializeHeaderImageAlignment()

Determines if the column's header image alignment was modified.

Declaration

public bool ShouldSerializeHeaderImageAlignment()

Returns

Type	Description
System.Boolean	True if header text is modified.

ShouldSerializeHeaderText()

Determines a value indicating whether the column's header text was modified or not.

Declaration

public bool ShouldSerializeHeaderText()

Returns

Type	Description
System.Boolean	True if header text is modified; Otherwise False.

ShouldSerializeMaxLength()

Determines a value indicating whether the MaxLength has been modified or not. and should be serialized at design-time.

Declaration

public bool ShouldSerializeMaxLength()

Returns

Type	Description
System.Boolean	true if contents were changed; false otherwise.

ShouldSerializeName()

Determines a value indicating whether the column's name was modified or not.

Declaration

public bool ShouldSerializeName()

Returns

Type	Description
System.Boolean	True if name is modified.

ShouldSerializeReadOnly()

Determines a value indicating whether the columns Read-only setting was modified or not.

Declaration

public bool ShouldSerializeReadOnly()

Returns

Type	Description
System.Boolean	True if Read-only setting is modified.

ShouldSerializeSerializedImageArray()

Determines a value indicating whether the header images text was modified or not.

Declaration

public bool ShouldSerializeSerializedImageArray()

Returns

Type	Description
System.Boolean	True.

ShouldSerializeSortByDisplayMember()

Determines a value indicating whether SortByDisplayMember has been modified and its contents should be serialized or not at design-time.

Declaration

public bool ShouldSerializeSortByDisplayMember()

Returns

Type	Description
System.Boolean	True if contents were changed; False otherwise.

ShouldSerializeTrackWidthOfParentColumn()

Determines a value indicating whether the TrackWidthOfParentColumn property was modified or not.

Declaration

public bool ShouldSerializeTrackWidthOfParentColumn()

Returns

Type	Description
System.Boolean	Trueif it was modified; Otherwise False.

ShouldSerializeWidth()

Determines a value indicating whether the column's width was modified or not.

Declaration

public bool ShouldSerializeWidth()

Returns

Type	Description
System.Boolean	True if width is modified; OtherwiseFalse.

ToString()

Overrides and gets the string representation of the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String representation of the current object.

Overrides

DescriptorBase.ToString()

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 current column.

Declaration

ICollection IStandardValuesProvider.GetStandardValues(PropertyDescriptor pd)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor	pd	An instance of the System.ComponentModel.PropertyDescriptor class.

Returns

Type	Description
System.Collections.ICollection	The property values of the current object.

IGridGroupOptionsSource.GetParentGroupOptionsSource()

Declaration

IGridGroupOptionsSource IGridGroupOptionsSource.GetParentGroupOptionsSource()

Returns

Type
IGridGroupOptionsSource

IGridGroupOptionsSource.GroupOptions

Declaration

GridGroupOptionsStyleInfo IGridGroupOptionsSource.GroupOptions { get; }

Returns

Type
GridGroupOptionsStyleInfo

IGridGroupOptionsSource.HasGroupOptions

Gets a value indicating whether GridGroupOptionSource has GroupOptions or not.

Declaration

bool IGridGroupOptionsSource.HasGroupOptions { get; }

Returns

Type
System.Boolean

IGridGroupOptionsSource.RaiseGroupOptionsChanged(GridGroupOptionsChangedEventArgs)

Declaration

void IGridGroupOptionsSource.RaiseGroupOptionsChanged(GridGroupOptionsChangedEventArgs e)

Parameters

Type	Name	Description
GridGroupOptionsChangedEventArgs	e

IGridGroupOptionsSource.RaiseGroupOptionsChanging(GridGroupOptionsChangedEventArgs)

Declaration

void IGridGroupOptionsSource.RaiseGroupOptionsChanging(GridGroupOptionsChangedEventArgs e)

Parameters

Type	Name	Description
GridGroupOptionsChangedEventArgs	e

IGridTableCellAppearanceSource.GetAppearance()

Gets the Table Appearance of the current object.

Declaration

GridTableCellAppearance IGridTableCellAppearanceSource.GetAppearance()

Returns

Type	Description
GridTableCellAppearance	Appearance of Table.

IGridTableCellAppearanceSource.GetBaseAppearance()

Gets the base style of the current object.

Declaration

GridTableCellAppearance IGridTableCellAppearanceSource.GetBaseAppearance()

Returns

Type	Description
GridTableCellAppearance	If the object had a base style it is returned, Otherwise Null.

IGridTableCellAppearanceSource.RaiseAppearanceChanged(GridTableCellStyleInfoChangedEventArgs)

Triggered when the PropertyChanging event is done.

Declaration

void IGridTableCellAppearanceSource.RaiseAppearanceChanged(GridTableCellStyleInfoChangedEventArgs e)

Parameters

Type	Name	Description
GridTableCellStyleInfoChangedEventArgs	e	The GridTableCellStyleInfoChangedEventArgs contains the event data.

IGridTableCellAppearanceSource.RaiseAppearanceChanging(GridTableCellStyleInfoChangedEventArgs)

Triggered when the PropertyChanged event is done.

Declaration

void IGridTableCellAppearanceSource.RaiseAppearanceChanging(GridTableCellStyleInfoChangedEventArgs e)

Parameters

Type	Name	Description
GridTableCellStyleInfoChangedEventArgs	e	The GridTableCellStyleInfoChangedEventArgs contains the event data.

ICloneable.Clone()

Declaration

object ICloneable.Clone()

Returns

Type
System.Object

Implements

System.ComponentModel.ICustomTypeDescriptor

System.IDisposable

System.ICloneable

IStandardValuesProvider

IGridTableCellAppearanceSource

IGridGroupOptionsSource