Class

GridViewColumn

Initializes a new instance of the GridViewColumn.

Declaration

public GridViewColumn()

Initializes a new instance of the GridViewColumn.

Declaration

public GridViewColumn(string fieldName)

Parameters

Initializes a new instance of the GridViewColumn.

Declaration

public GridViewColumn(string name, string fieldName)

Parameters

Declaration

public static RadProperty AllowGroupProperty

Field Value

Declaration

public static RadProperty AllowHideProperty

Field Value

Declaration

public static RadProperty AllowReorderProperty

Field Value

Declaration

public static RadProperty AllowResizeProperty

Field Value

Declaration

public static RadProperty AllowSortProperty

Field Value

Declaration

public static RadProperty AutoEllipsisProperty

Field Value

Declaration

public static RadProperty AutoSizeModeProperty

Field Value

Declaration

public static RadProperty DisableHTMLRenderingProperty

Field Value

Declaration

public static RadProperty EnableExpressionEditorProperty

Field Value

Declaration

public static RadProperty ExpressionProperty

Field Value

Declaration

public static RadProperty FieldNameProperty

Field Value

Declaration

public static RadProperty HeaderImageProperty

Field Value

Declaration

public static RadProperty HeaderSvgImageProperty

Field Value

Declaration

public static RadProperty HeaderTextAlignmentProperty

Field Value

Declaration

public static RadProperty HeaderTextProperty

Field Value

Declaration

public static RadProperty ImageLayoutProperty

Field Value

Declaration

public static RadProperty IsAutoGeneratedProperty

Field Value

Declaration

public static RadProperty IsCurrentProperty

Field Value

Declaration

public static RadProperty IsVisibleProperty

Field Value

Declaration

public static RadProperty MaxWidthProperty

Field Value

Declaration

public static RadProperty MinWidthProperty

Field Value

Declaration

public static RadProperty NameProperty

Field Value

Declaration

public static RadProperty PinPositionProperty

Field Value

Declaration

public static RadProperty ReadOnlyProperty

Field Value

Declaration

public static RadProperty RenderWidthProperty

Field Value

Declaration

public static RadProperty RowSpanProperty

Field Value

Declaration

public static RadProperty ShowEditorProperty

Field Value

Declaration

public static RadProperty StretchVerticallyProperty

Field Value

Declaration

public static RadProperty TagProperty

Field Value

Declaration

public static RadProperty TextAlignmentProperty

Field Value

Declaration

public static RadProperty TextImageRelationProperty

Field Value

Declaration

public static RadProperty VisibleInColumnChooserProperty

Field Value

Declaration

public static RadProperty WidthProperty

Field Value

Declaration

public static RadProperty WrapTextProperty

Field Value

Gets or sets a value indicating whether the user can group data based on the content of this column.

Declaration

[Browsable(true)]
public virtual bool AllowGroup { get; set; }

Property Value

Gets or sets value indicating whether the user can hide the column.

Declaration

[Browsable(true)]
public virtual bool AllowHide { get; set; }

Property Value

Gets or sets a value indicating whether the user can reorder this column using the mouse.

Declaration

[Browsable(true)]
public virtual bool AllowReorder { get; set; }

Property Value

Gets or sets value indicating whether the user can resize the column.

Declaration

[Browsable(true)]
public virtual bool AllowResize { get; set; }

Property Value

Gets or sets a value indicating whether the user can sort the data in the OwnerTemplate based on the contents of this column.

Declaration

[Browsable(true)]
public virtual bool AllowSort { get; set; }

Property Value

Gets or sets the auto ellipsis.

Declaration

[Browsable(true)]
public bool AutoEllipsis { get; set; }

Property Value

Gets or sets the mode by which the column automatically adjusts its width after BestFit is executed.

Declaration

[Browsable(false)]
public BestFitColumnMode AutoSizeMode { get; set; }

Property Value

Gets list of BaseFormattingObject instances that define the currently applied conditional formatting of the data in the column.

Declaration

[Browsable(true)]
public virtual ConditionalFormattingObjectCollection ConditionalFormattingObjectList { get; }

Property Value

Gets or sets the context menu assigned to the column.

Declaration

public RadDropDownMenu ContextMenu { get; set; }

Property Value

Implements IContextMenuProvider.ContextMenu

Disable or Enable HTML-like text rendering in the column.

Declaration

[Browsable(true)]
public bool DisableHTMLRendering { get; set; }

Property Value

Gets or sets the DPI scale.

Declaration

public SizeF DpiScale { get; }

Property Value

Gets or sets the value indicating if expression editor menu item will be available to the user.

Declaration

[Browsable(true)]
public bool EnableExpressionEditor { get; set; }

Property Value

Gets the event dispatcher.

Declaration

protected EventDispatcher EventDispatcher { get; }

Property Value

Gets or sets the expression used to calculate the values of this column.

Declaration

[Browsable(true)]
public string Expression { get; set; }

Property Value

Gets or sets the name data source property or database column to which the GridViewDataColumn is bound.

Declaration

[Browsable(true)]
public string FieldName { get; set; }

Property Value

Gets or set the ColumnInfo Header image.

Declaration

[Browsable(true)]
[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image HeaderImage { get; set; }

Property Value

Gets or set the ColumnInfo Header vector image.

Declaration

[Browsable(true)]
[TypeConverter(typeof(SvgImageTypeConverter))]
public virtual RadSvgImage HeaderSvgImage { get; set; }

Property Value

Gets or sets the caption text on the column's header cell.

Declaration

[Browsable(true)]
public virtual string HeaderText { get; set; }

Property Value

Gets or sets a value indicating the position of the HeaderText within the header cell.

Declaration

[Browsable(true)]
public ContentAlignment HeaderTextAlignment { get; set; }

Property Value

Gets or sets the image layout of the image inside the cells.

Declaration

[Browsable(true)]
public virtual ImageLayout ImageLayout { get; set; }

Property Value

Gets a value indicating the position of the column in the Columns collection of the OwnerTemplate.

Declaration

[Browsable(false)]
public int Index { get; }

Property Value

Gets value indicating whether the column contains the currently selected cell in the OwnerTemplate.

Declaration

[Browsable(false)]
public bool IsCurrent { get; set; }

Property Value

Gets a value indicating whether the column is bound to the data field referred by FieldName.

Declaration

[Browsable(false)]
public virtual bool IsDataBound { get; }

Property Value

Gets whether is field name path.

Declaration

[Browsable(false)]
public bool IsFieldNamePath { get; }

Property Value

Gets a value indicating whether the data in the OwnerTemplate is grouped based on the content of this column.

Declaration

[Browsable(false)]
public virtual bool IsGrouped { get; }

Property Value

Gets or sets value indicating whether the current column is pinned and cannot be moved from its location when a user scrolls horizontally.

Declaration

[Browsable(true)]
public bool IsPinned { get; set; }

Property Value

Gets a boolean value indicating whether a sort order of data in the column is currently applied.

Declaration

[Browsable(false)]
public virtual bool IsSorted { get; }

Property Value

Remarks

Gets or sets a value indicating whether the column is visible.

Declaration

[Browsable(true)]
public virtual bool IsVisible { get; set; }

Property Value

Gets or sets the maximal width, in pixels, of the column.

Declaration

[Browsable(true)]
public int MaxWidth { get; set; }

Property Value

Gets or sets the minimum width, in pixels, of the column.

Declaration

[Browsable(true)]
public int MinWidth { get; set; }

Property Value

Gets or sets a string value representing the column's unique name in the Columns collection of the OwnerTemplate.

Declaration

[Browsable(true)]
public virtual string Name { get; set; }

Property Value

Gets the instance of GridViewTemplate which the column belongs to.

Declaration

[Browsable(false)]
public GridViewTemplate OwnerTemplate { get; }

Property Value

Gets or sets the pin position for the row. When the column is pinned, it cannot be moved from its location when a user scrolls horizontally.

Declaration

public PinnedColumnPosition PinPosition { get; set; }

Property Value

Gets or sets a value indicating whether the user can edit the data in the column's cells.

Declaration

[Browsable(true)]
public virtual bool ReadOnly { get; set; }

Property Value

Gets or sets the vertical span of the cells in that column (the height) in pixels. Relevant only in ColumnGroupsViewDefinition.

Declaration

[Browsable(true)]
public int RowSpan { get; set; }

Property Value

Gets or sets a value indicating the sort order of data in the column.

Declaration

[Browsable(true)]
public RadSortOrder SortOrder { get; set; }

Property Value

Gets or sets a value indicating whether to stretch the column height vertically. Used with ColumnGroupsViewDefinition.

Declaration

[Browsable(true)]
public bool StretchVertically { get; set; }

Property Value

Gets or sets the object that contains data about the column.

Declaration

[Browsable(false)]
public object Tag { get; set; }

Property Value

Gets or sets a value indicating the position of the cell content within a column's cells.

Declaration

[Browsable(true)]
public virtual ContentAlignment TextAlignment { get; set; }

Property Value

Gets or sets a value indicating the TextImageRelation: ImageAboveText, ImageBeforeText, Overlay, TextAboveImage, and TextBeforeImage.

Declaration

[Browsable(true)]
public TextImageRelation TextImageRelation { get; set; }

Property Value

Gets or sets a value indicating whether the column will be visible in ColumnChooserElement.

Declaration

[Browsable(true)]
public virtual bool VisibleInColumnChooser { get; set; }

Property Value

Remarks

Gets or sets the width of the column.

Declaration

[Browsable(true)]
public virtual int Width { get; set; }

Property Value

Gets or sets value indicating whether the text in each cell in the column should be wrapped.

Declaration

[Browsable(true)]
public bool WrapText { get; set; }

Property Value

Adjusts the column width to fit the contents of all cells in the column, including the header cell.

Declaration

public void BestFit()

Determines whether this column may be dragged onto the GroupBy panel.

Declaration

public bool CanDragToGroup()

Returns

Determines whether this column may be dragged onto the GroupBy panel.

Declaration

public bool CanDragToGroup(GridViewTemplate template)

Parameters

Returns

Creates the conditional formatting form.

Declaration

protected virtual ConditionalFormattingForm CreateConditionalFormattingForm()

Returns

Declaration

protected virtual void CreateContextMenuItems(RadDropDownMenu menu)

Parameters

Dispatches the event.

Declaration

protected virtual void DispatchEvent(KnownEvents id, GridEventType type, GridEventDispatchMode dispatchMode, object originator, object[] arguments)

Parameters

Returns the type of cell element to be created for the specified row.

Declaration

public virtual Type GetCellType(GridViewRowInfo row)

Parameters

Returns

Returns an editor instance of the default type for the editor provider.

Declaration

public virtual IInputEditor GetDefaultEditor()

Returns

Implements IEditorProvider.GetDefaultEditor()

Gets the default editor type for the editor provider.

Declaration

public virtual Type GetDefaultEditorType()

Returns

Implements IEditorProvider.GetDefaultEditorType()

Retrieves the default group-by expression string for the column.

Declaration

public virtual string GetDefaultGroupByExpression()

Returns

Gets a value indicating default minimum width for the inherited column type. If not overridden in inheritor class it defaults to 5.

Declaration

protected virtual int GetDefaultMinWidth()

Returns

Gets the event info.

Declaration

protected virtual GridEventType GetEventInfo(RadProperty property, out GridEventDispatchMode dispatchMode)

Parameters

Returns

Initializes the column.

Declaration

protected virtual void Initialize()

Remarks

Initializes a specified editor.

Declaration

public virtual void InitializeEditor(IInputEditor editor)

Parameters

Implements IEditorProvider.InitializeEditor(IInputEditor)

Determines whether the specified property may be canceled.

Declaration

protected override bool IsPropertyCancelable(RadPropertyMetadata metadata)

Parameters

Returns

Overrides RadObject.IsPropertyCancelable(RadPropertyMetadata)

Merges the context menu.

Declaration

public RadDropDownMenu MergeMenus(IContextMenuManager contextMenuManager, params object[] parameters)

Parameters

Returns

Implements IContextMenuProvider.MergeMenus(IContextMenuManager, params object[])

Merges the context menu.

Declaration

public RadDropDownMenu MergeMenus(IContextMenuProvider contextMenuProvider, params object[] parameters)

Parameters

Returns

Implements IContextMenuProvider.MergeMenus(IContextMenuProvider, params object[])

Merges the context menu.

Declaration

public RadDropDownMenu MergeMenus(RadDropDownMenu contextMenu, params object[] parameters)

Parameters

Returns

Implements IContextMenuProvider.MergeMenus(RadDropDownMenu, params object[])

Declaration

protected virtual void OnNotifyPropertyChanging(PropertyChangingEventArgsEx e)

Parameters

Declaration

protected void OnNotifyPropertyChanging(string propertyName)

Parameters

Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the RadPropertyChanging event, allowing subscribers to be notified before a property value changes and potentially cancel the change.

Declaration

protected override void OnPropertyChanging(RadPropertyChangingEventArgs e)

Parameters

Overrides RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)

Shows the context menu.

Declaration

public virtual void ShowContextMenu()

Sorts with the specified sort order.

Declaration

public virtual void Sort(RadSortOrder sortOrder)

Parameters

Sorts the specified sort order.

Declaration

public bool Sort(RadSortOrder sortOrder, bool multiSortMode)

Parameters

Returns

Returns a string representation of the column.

Declaration

public override string ToString()

Returns

Overrides object.ToString()

Toggles the column sort order.

Declaration

protected void ToggleSortOrder()

Occurs when a property value is changing.

Declaration

public event PropertyChangingEventHandlerEx PropertyChanging

Event Value

Implements INotifyPropertyChangingEx.PropertyChanging