Afficher en anglais

Partage via


DataGridViewColumn Classe

Définition

Représente une colonne dans un contrôle DataGridView.

C#
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.DataGridViewColumnConverter))]
public class DataGridViewColumn : System.Windows.Forms.DataGridViewBand, IDisposable, System.ComponentModel.IComponent
Héritage
Dérivé
Attributs
Implémente

Exemples

L’exemple de code suivant crée un Windows Form avec un DataGridView et un ensemble de boutons. Chaque étiquette de bouton décrit une opération liée à une DataGridViewColumn propriété, telle que l’échange de la première et de la dernière colonne (à l’aide de la DisplayIndex propriété) ou la modification du texte d’un en-tête de colonne (à l’aide de la HeaderText propriété ). Cliquer sur un bouton modifie la propriété associée du DataGridViewColumn.

C#
using System.Windows.Forms;
using System;
using System.Drawing;

public class DataGridViewColumnDemo : Form
{
    #region "set up form"
    public DataGridViewColumnDemo()
    {
        InitializeComponent();

        AddButton(Button1, "Reset",
            new EventHandler(ResetToDisorder));
        AddButton(Button2, "Change Column 3 Header",
            new EventHandler(ChangeColumn3Header));
        AddButton(Button3, "Change Meatloaf Recipe",
            new EventHandler(ChangeMeatloafRecipe));
        AddAdditionalButtons();

        InitializeDataGridView();
    }

    DataGridView dataGridView;
    Button Button1 = new Button();
    Button Button2 = new Button();
    Button Button3 = new Button();
    Button Button4 = new Button();
    Button Button5 = new Button();
    Button Button6 = new Button();
    Button Button7 = new Button();
    Button Button8 = new Button();
    Button Button9 = new Button();
    Button Button10 = new Button();
    FlowLayoutPanel FlowLayoutPanel1 = new FlowLayoutPanel();

    private void InitializeComponent()
    {
        FlowLayoutPanel1.Location = new Point(454, 0);
        FlowLayoutPanel1.AutoSize = true;
        FlowLayoutPanel1.FlowDirection = FlowDirection.TopDown;
        FlowLayoutPanel1.Name = "flowlayoutpanel";
        ClientSize = new System.Drawing.Size(614, 360);
        Controls.Add(this.FlowLayoutPanel1);
        Text = this.GetType().Name;
        AutoSize = true;
    }
    #endregion

    #region "set up DataGridView"

    private string thirdColumnHeader = "Main Ingredients";
    private string boringMeatloaf = "ground beef";
    private string boringMeatloafRanking = "*";
    private bool boringRecipe;
    private bool shortMode;

    private void InitializeDataGridView()
    {
        dataGridView = new System.Windows.Forms.DataGridView();
        Controls.Add(dataGridView);
        dataGridView.Size = new Size(300, 200);

        // Create an unbound DataGridView by declaring a
        // column count.
        dataGridView.ColumnCount = 4;
        AdjustDataGridViewSizing();

        // Set the column header style.
        DataGridViewCellStyle columnHeaderStyle =
            new DataGridViewCellStyle();
        columnHeaderStyle.BackColor = Color.Aqua;
        columnHeaderStyle.Font =
            new Font("Verdana", 10, FontStyle.Bold);
        dataGridView.ColumnHeadersDefaultCellStyle =
            columnHeaderStyle;

        // Set the column header names.
        dataGridView.Columns[0].Name = "Recipe";
        dataGridView.Columns[1].Name = "Category";
        dataGridView.Columns[2].Name = thirdColumnHeader;
        dataGridView.Columns[3].Name = "Rating";

        PostColumnCreation();

        // Populate the rows.
        string[] row1 = new string[]{"Meatloaf", 
                                        "Main Dish", boringMeatloaf, boringMeatloafRanking};
        string[] row2 = new string[]{"Key Lime Pie", 
                                        "Dessert", "lime juice, evaporated milk", "****"};
        string[] row3 = new string[]{"Orange-Salsa Pork Chops", 
                                        "Main Dish", "pork chops, salsa, orange juice", "****"};
        string[] row4 = new string[]{"Black Bean and Rice Salad", 
                                        "Salad", "black beans, brown rice", "****"};
        string[] row5 = new string[]{"Chocolate Cheesecake", 
                                        "Dessert", "cream cheese", "***"};
        string[] row6 = new string[]{"Black Bean Dip", "Appetizer",
                                        "black beans, sour cream", "***"};
        object[] rows = new object[] { row1, row2, row3, row4, row5, row6 };

        foreach (string[] rowArray in rows)
        {
            dataGridView.Rows.Add(rowArray);
        }

        shortMode = false;
        boringRecipe = true;
    }

    private void AddButton(Button button, string buttonLabel,
        EventHandler handler)
    {
        FlowLayoutPanel1.Controls.Add(button);
        button.TabIndex = FlowLayoutPanel1.Controls.Count;
        button.Text = buttonLabel;
        button.AutoSize = true;
        button.Click += handler;
    }

    private void ResetToDisorder(object sender, System.EventArgs e)
    {
        Controls.Remove(dataGridView);
        dataGridView.Dispose();
        InitializeDataGridView();
    }

    private void ChangeColumn3Header(object sender,
        System.EventArgs e)
    {
        Toggle(ref shortMode);
        if (shortMode)
        { dataGridView.Columns[2].HeaderText = "S"; }
        else
        { dataGridView.Columns[2].HeaderText = thirdColumnHeader; }
    }

    private static void Toggle(ref bool toggleThis)
    {
        toggleThis = !toggleThis;
    }

    private void ChangeMeatloafRecipe(object sender,
        System.EventArgs e)
    {
        Toggle(ref boringRecipe);
        if (boringRecipe)
        {
            SetMeatloaf(boringMeatloaf, boringMeatloafRanking);
        }
        else
        {
            string greatMeatloafRecipe =
                "1 lb. lean ground beef, " +
                "1/2 cup bread crumbs, 1/4 cup ketchup," +
                "1/3 tsp onion powder, " +
                "1 clove of garlic, 1/2 pack onion soup mix " +
                " dash of your favorite BBQ Sauce";
            SetMeatloaf(greatMeatloafRecipe, "***");
        }
    }

    private void SetMeatloaf(string recipe, string rating)
    {
        dataGridView.Rows[0].Cells[2].Value = recipe;
        dataGridView.Rows[0].Cells[3].Value = rating;
    }
    #endregion

    #region "demonstration code"
    private void PostColumnCreation()
    {
        AddContextLabel();
        AddCriteriaLabel();
        CustomizeCellsInThirdColumn();
        AddContextMenu();
        SetDefaultCellInFirstColumn();
        ToolTips();

        dataGridView.CellMouseEnter +=
            dataGridView_CellMouseEnter;
        dataGridView.AutoSizeColumnModeChanged +=
            dataGridView_AutoSizeColumnModeChanged;
    }

    private string criteriaLabel = "Column 3 sizing criteria: ";
    private void AddCriteriaLabel()
    {
        AddLabelToPanelIfNotAlreadyThere(criteriaLabel,
            criteriaLabel +
            dataGridView.Columns[2].AutoSizeMode.ToString() +
            ".");
    }

    private void AddContextLabel()
    {
        string labelName = "label";
        AddLabelToPanelIfNotAlreadyThere(labelName,
            "Use shortcut menu to change cell color.");
    }

    private void AddLabelToPanelIfNotAlreadyThere(
        string labelName, string labelText)
    {
        Label label;
        if (FlowLayoutPanel1.Controls[labelName] == null)
        {
            label = new Label();
            label.AutoSize = true;
            label.Name = labelName;
            label.BackColor = Color.Bisque;
            FlowLayoutPanel1.Controls.Add(label);
        }
        else
        {
            label = (Label)FlowLayoutPanel1.Controls[labelName];
        }
        label.Text = labelText;
    }

    private void CustomizeCellsInThirdColumn()
    {
        int thirdColumn = 2;
        DataGridViewColumn column =
            dataGridView.Columns[thirdColumn];
        DataGridViewCell cell = new DataGridViewTextBoxCell();

        cell.Style.BackColor = Color.Wheat;
        column.CellTemplate = cell;
    }

    ToolStripMenuItem toolStripItem1 = new ToolStripMenuItem();

    private void AddContextMenu()
    {
        toolStripItem1.Text = "Redden";
        toolStripItem1.Click += new EventHandler(toolStripItem1_Click);
        ContextMenuStrip strip = new ContextMenuStrip();
        foreach (DataGridViewColumn column in dataGridView.Columns)
        {

            column.ContextMenuStrip = strip;
            column.ContextMenuStrip.Items.Add(toolStripItem1);
        }
    }

    private DataGridViewCellEventArgs mouseLocation;

    // Change the cell's color.
    private void toolStripItem1_Click(object sender, EventArgs args)
    {
        dataGridView.Rows[mouseLocation.RowIndex]
            .Cells[mouseLocation.ColumnIndex].Style.BackColor
            = Color.Red;
    }

    // Deal with hovering over a cell.
    private void dataGridView_CellMouseEnter(object sender,
        DataGridViewCellEventArgs location)
    {
        mouseLocation = location;
    }

    private void SetDefaultCellInFirstColumn()
    {
        DataGridViewColumn firstColumn = dataGridView.Columns[0];
        DataGridViewCellStyle cellStyle =
            new DataGridViewCellStyle();
        cellStyle.BackColor = Color.Thistle;

        firstColumn.DefaultCellStyle = cellStyle;
    }

    private void ToolTips()
    {
        DataGridViewColumn firstColumn = dataGridView.Columns[0];
        DataGridViewColumn thirdColumn = dataGridView.Columns[2];
        firstColumn.ToolTipText =
            "This column uses a default cell.";
        thirdColumn.ToolTipText =
            "This column uses a template cell." +
            " Style changes to one cell apply to all cells.";
    }

    private void AddAdditionalButtons()
    {
        AddButton(Button4, "Set Minimum Width of Column Two",
            new EventHandler(Button4_Click));
        AddButton(Button5, "Set Width of Column One",
            new EventHandler(Button5_Click));
        AddButton(Button6, "Autosize Third Column",
            new EventHandler(Button6_Click));
        AddButton(Button7, "Add Thick Vertical Edge",
            new EventHandler(Button7_Click));
        AddButton(Button8, "Style and Number Columns",
            new EventHandler(Button8_Click));
        AddButton(Button9, "Change Column Header Text",
            new EventHandler(Button9_Click));
        AddButton(Button10, "Swap First and Last Columns",
            new EventHandler(Button10_Click));
    }

    private void AdjustDataGridViewSizing()
    {
        dataGridView.ColumnHeadersHeightSizeMode = 
            DataGridViewColumnHeadersHeightSizeMode.AutoSize;
    }

    //Set the minimum width.
    private void Button4_Click(object sender,
        System.EventArgs e)
    {
        DataGridViewColumn column = dataGridView.Columns[1];
        column.MinimumWidth = 40;
    }

    // Set the width.
    private void Button5_Click(object sender, System.EventArgs e)
    {
        DataGridViewColumn column = dataGridView.Columns[0];
        column.Width = 60;
    }

    // AutoSize the third column.
    private void Button6_Click(object sender,
        System.EventArgs e)
    {
        DataGridViewColumn column = dataGridView.Columns[2];
        column.AutoSizeMode = DataGridViewAutoSizeColumnMode.DisplayedCells;
    }

    // Set the vertical edge.
    private void Button7_Click(object sender,
        System.EventArgs e)
    {
        int thirdColumn = 2;
        DataGridViewColumn column =
            dataGridView.Columns[thirdColumn];
        column.DividerWidth = 10;
    }

    // Style and number columns.
    private void Button8_Click(object sender,
        EventArgs args)
    {
        DataGridViewCellStyle style = new DataGridViewCellStyle();
        style.Alignment =
            DataGridViewContentAlignment.MiddleCenter;
        style.ForeColor = Color.IndianRed;
        style.BackColor = Color.Ivory;

        foreach (DataGridViewColumn column in dataGridView.Columns)
        {
            column.HeaderCell.Value = column.Index.ToString();
            column.HeaderCell.Style = style;
        }
    }

    // Change the text in the column header.
    private void Button9_Click(object sender,
        EventArgs args)
    {
        foreach (DataGridViewColumn column in dataGridView.Columns)
        {

            column.HeaderText = String.Concat("Column ",
                column.Index.ToString());
        }
    }

    // Swap the last column with the first.
    private void Button10_Click(object sender, EventArgs args)
    {
        DataGridViewColumnCollection columnCollection = dataGridView.Columns;

        DataGridViewColumn firstVisibleColumn =
            columnCollection.GetFirstColumn(DataGridViewElementStates.Visible);
        DataGridViewColumn lastVisibleColumn =
            columnCollection.GetLastColumn(
                DataGridViewElementStates.Visible, DataGridViewElementStates.None);

        int firstColumn_sIndex = firstVisibleColumn.DisplayIndex;
        firstVisibleColumn.DisplayIndex = lastVisibleColumn.DisplayIndex;
        lastVisibleColumn.DisplayIndex = firstColumn_sIndex;
    }

    // Updated the criteria label.
    private void dataGridView_AutoSizeColumnModeChanged(object sender,
        DataGridViewAutoSizeColumnModeEventArgs args)
    {
        args.Column.DataGridView.Parent.
            Controls["flowlayoutpanel"].Controls[criteriaLabel].
            Text = criteriaLabel
            + args.Column.AutoSizeMode.ToString();
    }
    #endregion

    [STAThreadAttribute()]
    public static void Main()
    {
        Application.Run(new DataGridViewColumnDemo());
    }
}

Remarques

La DataGridViewColumn classe représente une colonne logique dans un DataGridView contrôle. Vous pouvez récupérer des colonnes via la Columns collection du contrôle .

Contrairement à un DataGridViewRow, qui contient la collection réelle de cellules d’un DataGridView, DataGridViewColumn est principalement utilisé pour ajuster l’apparence et le comportement de l’interface utilisateur de colonne, comme la largeur de colonne et le style de cellule. Pour plus d’informations sur les styles de cellule, consultez Styles de cellule dans le contrôle DataGridView Windows Forms.

Les types qui dérivent généralement d’initialiser DataGridViewColumn la CellTemplate propriété vers une nouvelle instance d’un type associé dérivé de la DataGridViewCell classe . Toutes les propriétés de colonne qui se rapportent à l’apparence ou au comportement de cellules individuelles sont des wrappers pour les propriétés correspondantes de la cellule de modèle. La modification de l’une de ces propriétés sur la colonne modifie automatiquement la valeur sur le modèle de cellule et sur toutes les cellules de la colonne. Pour remplacer la valeur spécifiée pour les cellules individuelles, définissez les valeurs de cellule après avoir défini la valeur de colonne.

Notes pour les héritiers

Lorsque vous dérivez de DataGridViewColumn et ajoutez de nouvelles propriétés à la classe dérivée, veillez à remplacer la Clone() méthode pour copier les nouvelles propriétés pendant les opérations de clonage. Vous devez également appeler la méthode de la classe de Clone() base afin que les propriétés de la classe de base soient copiées dans la nouvelle cellule.

Constructeurs

DataGridViewColumn()

Initialise une nouvelle instance de la classe DataGridViewColumn à son état par défaut.

DataGridViewColumn(DataGridViewCell)

Initialise une nouvelle instance de la classe DataGridViewColumn en utilisant un DataGridViewCell existant comme modèle.

Propriétés

AutoSizeMode

Obtient ou définit le mode qui permet à la colonne de modifier automatiquement sa largeur.

CellTemplate

Obtient ou définit le modèle utilisé pour créer des cellules.

CellType

Obtient le type d'exécution du modèle de cellule.

ContextMenuStrip

Obtient ou définit le menu contextuel pour la colonne.

DataGridView

Obtient le contrôle DataGridView associé à cet élément.

(Hérité de DataGridViewElement)
DataPropertyName

Obtient ou définit le nom de la propriété de source de données ou de la colonne de base de données à laquelle DataGridViewColumn est lié.

DefaultCellStyle

Obtient ou définit le style de cellule par défaut de la colonne.

DefaultHeaderCellType

Obtient ou définit le type à l'exécution de la cellule d'en-tête par défaut.

(Hérité de DataGridViewBand)
Displayed

Obtient une valeur indiquant si la bande est actuellement affichée à l'écran.

(Hérité de DataGridViewBand)
DisplayIndex

Obtient ou définit l'ordre d'affichage de la colonne par rapport aux colonnes actuellement affichées.

DividerWidth

Obtient ou définit la largeur, en pixels, du séparateur de colonne.

FillWeight

Obtient ou définit une valeur qui représente la largeur de la colonne en mode de remplissage par rapport aux largeurs des autres colonnes en mode de remplissage contenues dans le contrôle.

Frozen

Obtient ou définit une valeur indiquant si une colonne se déplace lorsqu'un utilisateur fait défiler horizontalement le contrôle DataGridView.

HasDefaultCellStyle

Obtient une valeur indiquant si la propriété DefaultCellStyle a été définie.

(Hérité de DataGridViewBand)
HeaderCell

Obtient ou définit DataGridViewColumnHeaderCell qui représente l'en-tête de colonne.

HeaderCellCore

Obtient ou définit la cellule d'en-tête du DataGridViewBand.

(Hérité de DataGridViewBand)
HeaderText

Obtient ou définit le texte de légende pour la cellule d'en-tête de la colonne.

Index

Obtient la position relative de la bande dans le contrôle DataGridView.

(Hérité de DataGridViewBand)
InheritedAutoSizeMode

Obtient le mode de dimensionnement défini pour la colonne.

InheritedStyle

Obtient le style de cellule actuellement appliqué à la colonne.

IsDataBound

Obtient une valeur indiquant si la colonne est liée à une source de données.

IsRow

Obtient une valeur indiquant si la bande représente une ligne.

(Hérité de DataGridViewBand)
MinimumWidth

Obtient ou définit la largeur minimale, en pixels, de la colonne.

Name

Obtient ou définit le nom de la colonne.

ReadOnly

Obtient ou définit une valeur indiquant si l'utilisateur peut modifier les cellules de la colonne.

Resizable

Obtient ou définit une valeur indiquant si la colonne peut être redimensionnée.

Selected

Obtient ou définit une valeur indiquant si la bande se trouve dans un état sélectionné d'interface utilisateur.

(Hérité de DataGridViewBand)
Site

Obtient ou définit le site de la colonne.

SortMode

Obtient ou définit le mode de tri de la colonne.

State

Obtient l'état d'interface utilisateur de l'élément.

(Hérité de DataGridViewElement)
Tag

Obtient ou définit l'objet qui contient les données à associer à la bande.

(Hérité de DataGridViewBand)
ToolTipText

Obtient ou définit le texte utilisé pour les info-bulles.

ValueType

Obtient ou définit le type de données des valeurs stockées dans les cellules de la colonne.

Visible

Obtient ou définit une valeur qui indique si la colonne est visible.

Width

Obtient ou définit la largeur actuelle de la colonne.

Méthodes

Clone()

Crée une copie exacte de cette bande.

Dispose()

Libère toutes les ressources utilisées par DataGridViewBand.

(Hérité de DataGridViewBand)
Dispose(Boolean)

Libère les ressources non managées utilisées par DataGridViewBand et libère éventuellement les ressources managées.

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.

(Hérité de Object)
GetHashCode()

Fait office de fonction de hachage par défaut.

(Hérité de Object)
GetPreferredWidth(DataGridViewAutoSizeColumnMode, Boolean)

Calcule la largeur idéale de la colonne en fonction des critères spécifiés.

GetType()

Obtient le Type de l'instance actuelle.

(Hérité de Object)
MemberwiseClone()

Crée une copie superficielle du Object actuel.

(Hérité de Object)
OnDataGridViewChanged()

Appelé lorsque la bande est associée à un DataGridView différent.

(Hérité de DataGridViewBand)
RaiseCellClick(DataGridViewCellEventArgs)

Déclenche l’événement CellClick.

(Hérité de DataGridViewElement)
RaiseCellContentClick(DataGridViewCellEventArgs)

Déclenche l’événement CellContentClick.

(Hérité de DataGridViewElement)
RaiseCellContentDoubleClick(DataGridViewCellEventArgs)

Déclenche l’événement CellContentDoubleClick.

(Hérité de DataGridViewElement)
RaiseCellValueChanged(DataGridViewCellEventArgs)

Déclenche l’événement CellValueChanged.

(Hérité de DataGridViewElement)
RaiseDataError(DataGridViewDataErrorEventArgs)

Déclenche l’événement DataError.

(Hérité de DataGridViewElement)
RaiseMouseWheel(MouseEventArgs)

Déclenche l’événement MouseWheel.

(Hérité de DataGridViewElement)
ToString()

Obtient une chaîne qui décrit la colonne.

Événements

Disposed

Se produit lorsque DataGridViewColumn est supprimé.

S’applique à

Produit Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10

Voir aussi