Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.DataGrid.Toolkit Assembly / Xceed.Wpf.DataGrid Namespace / DataGridItemProperty Class
Members Example


In This Topic
    DataGridItemProperty Class
    In This Topic
    Represents the characteristics of a property for an item in a DataGridCollectionView.
    Syntax
    'Declaration
     
    <DebuggerDisplayAttribute("Name = {Name}")>
    Public Class DataGridItemProperty 
       Inherits DataGridItemPropertyBase
    'Usage
     
    Dim instance As DataGridItemProperty
    [DebuggerDisplay("Name = {Name}")]
    public class DataGridItemProperty : DataGridItemPropertyBase 
    Remarks

    A DataGridItemProperty will be created for each property in the underlying data source and can be retrieved through the ItemProperties property of the DataGridCollectionViewDataGridCollectionViewSource (in XAML), or DataGridDetailDescription classes.

    Example
    The following example demonstrates how to provide, through a style, a new ControlTemplate for DataRow objects. A new ControlTemplate has also been provided for the grid in order to change its ScrollViewer to a WrapPanel. The columns that are contained in the grid will be limited to those specified in the ItemProperties of the DataGridCollectionViewSource. This example assumes that the grid is bound to the Employees table of the Northwind database.
    Inheritance Hierarchy

    System.Object
       Xceed.Wpf.DataGrid.DataGridItemPropertyBase
          Xceed.Wpf.DataGrid.DataGridItemProperty

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets a value indicating whether distinct values are to be calculated for the property. This feature is available only in the Professional Edition (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the converter to convert values to and from the corresponding field in the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the culture in which to evaluate the converter (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the parameter to pass to the converter (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the property's data type (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the IEqualityComparer that is used to compare the equality of the item property's distinct values. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the IComparer that is used to sort the item property's distinct values. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or set the DataGridForeignKeyDescription that represents a foreign key constraint or enumeration. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the IComparer used when sorting groups by the result of a statistical function. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the result property name of the statistical function by whose values the groups will be sorted. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets a value indicating whether the DataGridItemProperty was automatically created (see AutoCreateItemProperties property).  
    Public Property (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets a value indicating whether the property is readonly. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public Property (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets a value indicating the maximum number of distinct values to calculate. This feature is available only in the Professional Edition (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the name of a property in a DataGridCollectionView. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets a value indicating whether the value of the IsReadOnly property is ignored when new data items are inserted. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the PropertyDescriptor that determines the characteristics of a property for an item in a DataGridCollectionView.  
    Public PropertyGets or sets the custom data comparer that will be used to sort the values of the data-grid item property's associated column. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public Property (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the property's title. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGets or sets the path to access the value of a property for an item in a DataGridCollectionView.  
    Public PropertyGets or sets the XPath query that returns the value on the XML binding source to use  
    Top
    Public Methods
     NameDescription
    Public MethodRetrieves the current value of the property for the specified component. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public MethodSets the current value of the property for the specified component. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Top
    Protected Methods
     NameDescription
    Protected MethodOverridden. Retrieves the value of the specified component.  
    Protected Method

    Initializes a new instance of the DataGridItemProperty class specifying the name and title of the property, its value path, indicating whether it is read only, if the corresponding cell can be edited when a new item is being inserted, and if it represents a sub relationship.

    (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Protected MethodOverridden. Sets the value for the specified component.  
    Top
    Public Events
     NameDescription
    Public EventRaised when the value of a property changes. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public EventRaised to allow custom distinct values to be provided. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Top
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also