GridColumnStylesCollection.Contains Method (PropertyDescriptor)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value indicating whether the GridColumnStylesCollection contains a DataGridColumnStyle associated with the specified PropertyDescriptor.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public bool Contains(
	PropertyDescriptor propertyDescriptor
)

Parameters

propertyDescriptor
Type: System.ComponentModel.PropertyDescriptor

The PropertyDescriptor associated with the desired DataGridColumnStyle.

Return Value

Type: System.Boolean

true if the collection contains the DataGridColumnStyle; otherwise, false.

To get a PropertyDescriptorCollection, use the GetItemProperties method of the BindingManagerBase class. Pass the MappingName of the DataGridColumnStyle to the Item property of the PropertyDescriptorCollection to return the PropertyDescriptor for a specific column.

Use the Contains method to determine if a particular DataGridColumnStyle exists before invoking the Remove method to remove the item. If you need to know the index of a particular DataGridColumnStyle, use the IndexOf method.

The following code example uses the Contains method to determine if a GridColumnStylesCollection contains a DataGridColumnStyle associated with a specified PropertyDescriptor.

Private Sub ContainsThisDataCol()
   Dim myPropertyDescriptor As PropertyDescriptor
   Dim myPropertyDescriptorCollection As PropertyDescriptorCOllection
   myPropertyDescriptorCollection = _
   me.BindingContext(DataSet1, "Customers").GetItemProperties()
   myPropertyDescriptor = myPropertyDescriptorCollection("FirstName")

   Dim trueOrFalse As Boolean
   ' Set the variable to a known column in the grid's DataTable.
   trueOrFalse = DataGrid1.TableStyles(0).GridColumnStyles. _
   Contains(myPropertyDescriptor)
   Console.WriteLine(trueOrFalse)
End Sub 

.NET Framework
Available since 1.1
Return to top
Show: