Xceed Logo
Shop
Xceed DataGrid for WPF v7.3 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid Namespace / DataGridItemProperty Class
Members


In This Topic
    DataGridItemProperty Class
    In This Topic
    Represents the characteristics of a property for an item in a DataGridCollectionView.
    Syntax
    'Declaration
 
<NullableContextAttribute(2)>
<NullableAttribute(0)>
<DebuggerDisplayAttribute("Name = {Name}")>
Public Class DataGridItemProperty 
   Inherits DataGridItemPropertyBase
    'Usage
 
Dim instance As DataGridItemProperty
    [NullableContext(2)]
[Nullable(0)]
[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 DataGridCollectionView, DataGridCollectionViewSource (in XAML), or DataGridDetailDescription classes.

    Inheritance Hierarchy

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

    Public Constructors
     NameDescription
    Public ConstructorDataGridItemProperty ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyCalculateDistinctValuesGets 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 PropertyConverterGets 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 PropertyConverterCultureGets or sets the culture in which to evaluate the converter (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyConverterParameterGets or sets the parameter to pass to the converter (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyDataTypeGets or sets the property's data type (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyDistinctValuesEqualityComparerGets 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 PropertyDistinctValuesFilterModeGets or sets a value that indicates how distinct values filtering is performed on the property. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyDistinctValuesQuantityGets or sets a value that indicates the expected number of distinct values returned per data item for the property. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyDistinctValuesSortComparerGets or sets the IComparer that is used to sort the item property's distinct values. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyFilterCriterionGets or sets the filter criterion that is initially applied and displayed in a FilterRow when a grid is loaded. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyForeignKeyDescriptionGets or set the DataGridForeignKeyDescription that represents a foreign key constraint or enumeration. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGroupSortStatResultComparerGets or sets the IComparer used when sorting groups by the result of a statistical function. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyGroupSortStatResultPropertyNameGets 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 PropertyIsAutoCreatedGets a value indicating whether the DataGridItemProperty was automatically created (see AutoCreateItemProperties property).  
    Public PropertyIsDisplayableGets or sets a value indicating whether the DataGridItemProperty can generate a column if need be. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyIsReadOnlyGets or sets a value indicating whether the property is readonly. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyItemPropertiesGets a collection of DataGridItemProperty objects that belong to a given DataGridItemProperty. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyMaxDistinctValuesGets 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 PropertyNameGets or sets the name of a property in a DataGridCollectionView. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyOverrideReadOnlyForInsertionGets 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 PropertyPropertyDescriptorGets or sets the PropertyDescriptor that determines the characteristics of a property for an item in a DataGridCollectionView.  
    Public PropertySortComparerGets 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 PropertySynonymGets or sets the complete path (using one or more DataGridItemPropertyBase.Name values) with which this item property must be associated and aligned when the TreeGridflowView flattens the details. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyTitleGets or sets the property's title. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public PropertyValuePathGets or sets the path to access the value of a property for an item in a DataGridCollectionView.  
    Public PropertyValueXPathGets or sets the XPath query that returns the value on the XML binding source to use  
    Top
    Public Methods
     NameDescription
    Public MethodGetValueRetrieves the current value of the property for the specified component. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public MethodSetValueSets the current value of the property for the specified component. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Top
    Protected Methods
     NameDescription
    Protected MethodGetValueCoreOverridden. Retrieves the value of the specified component.  
    Protected MethodInitialize

    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 MethodSetValueCoreOverridden. Sets the value for the specified component.  
    Top
    Public Events
     NameDescription
    Public EventPropertyChangedRaised when the value of a property changes. (Inherited from Xceed.Wpf.DataGrid.DataGridItemPropertyBase)
    Public EventQueryDistinctValueRaised 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

    Reference

    DataGridItemProperty Members
    Xceed.Wpf.DataGrid Namespace

    Send Feedback