Edit

Share via

DataGridColumnStyle.ReadOnly Property

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Gets or sets a value indicating whether the data in the column can be edited.

public:
 virtual property bool ReadOnly { bool get(); void set(bool value); };
public virtual bool ReadOnly { get; set; }
member this.ReadOnly : bool with get, set
Public Overridable Property ReadOnly As Boolean

Property Value

Boolean

true, if the data cannot be edited; otherwise, false.

Examples

The following code example sets the DataGridColumnStyle object's ReadOnly property to the same value as the DataColumn object's ReadOnly property.

void SetReadOnly()
{
   DataColumnCollection^ myDataColumns;
   
   // Get the columns for a table bound to a DataGrid.
   myDataColumns = dataSet1->Tables[ "Suppliers" ]->Columns;
   System::Collections::IEnumerator^ myEnum = myDataColumns->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      DataColumn^ dataColumn = safe_cast<DataColumn^>(myEnum->Current);
      dataGrid1->TableStyles[ 0 ]->GridColumnStyles[ dataColumn->ColumnName ]->ReadOnly = dataColumn->ReadOnly;
   }
}

private void SetReadOnly()
{
    DataColumnCollection myDataColumns;
    // Get the columns for a table bound to a DataGrid.
    myDataColumns = dataSet1.Tables["Suppliers"].Columns;
    foreach(DataColumn dataColumn in myDataColumns)
    {
        dataGrid1.TableStyles[0].GridColumnStyles[dataColumn.ColumnName].ReadOnly = dataColumn.ReadOnly;
    }
}

Private Sub SetReadOnly()
    Dim myColumn As DataGridColumnStyle
    Dim myDataColumns As DataColumnCollection
    ' Get the columns for a table bound to a DataGrid.
    myDataColumns = dataSet1.Tables("Suppliers").Columns
    Dim dataColumn As DataColumn
    For Each dataColumn In myDataColumns
        dataGrid1.TableStyles(0).GridColumnStyles(dataColumn.ColumnName).ReadOnly = dataColumn.ReadOnly
    Next dataColumn
End Sub

Remarks

Make a column read-only if it contains a primary key or if its value is generated automatically (as when the DataColumn object's AutoIncrement property is set to true).

Similar read-only properties exist on other classes, each allowing more control over the access to data. For example, the System.Windows.Forms.DataGrid control can be set to read-only mode by using its ReadOnly property; the DataGridTableStyle also has a ReadOnly property, and the DataColumn class has a ReadOnly property for restricting data updates.

Applies to

See also