documentation

Author: DerekGooding

SimpleDataGrid/Controls/PageDataGrid.cs

@@ -1,16 +1,25 @@
-
 using SimpleDataGrid.Pagination;
 using System.Windows;
 using System.Windows.Controls;
 
 namespace SimpleDataGrid.Controls;
 
+/// <summary>
+/// A DataGrid that supports pagination through a <see cref="PagedCollection{T}"/>.
+/// </summary>
+/// <typeparam name="T">The type of items in the collection.</typeparam>
 public class PagedDataGrid<T> : DataGrid
 {
+    /// <summary>
+    /// Identifies the <see cref="PagedSource"/> dependency property.
+    /// </summary>
     public static readonly DependencyProperty PagedSourceProperty =
         DependencyProperty.Register(nameof(PagedSource), typeof(PagedCollection<T>), typeof(PagedDataGrid<T>),
             new PropertyMetadata(null, OnPagedSourceChanged));
 
+    /// <summary>
+    /// Gets or sets the paged collection that this grid displays.
+    /// </summary>
     public PagedCollection<T>? PagedSource
     {
         get => (PagedCollection<T>)GetValue(PagedSourceProperty);
@@ -31,4 +40,4 @@ private static void OnPagedSourceChanged(DependencyObject d, DependencyPropertyC
             };
         }
     }
-}
+}

SimpleDataGrid/Pagination/PagedCollection.cs

@@ -1,7 +1,12 @@
+
 using System.ComponentModel;
 
 namespace SimpleDataGrid.Pagination;
 
+/// <summary>
+/// Represents a collection of items that can be paged, filtered, and searched.
+/// </summary>
+/// <typeparam name="T">The type of items in the collection.</typeparam>
 public class PagedCollection<T> : INotifyPropertyChanged
 {
     private readonly int _pageSize;
@@ -13,30 +18,50 @@ public class PagedCollection<T> : INotifyPropertyChanged
     private Func<T, string>? _searchSelector;
     private string? _searchTerm;
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PagedCollection{T}"/> class.
+    /// </summary>
+    /// <param name="pageSize">The number of items to display per page.</param>
     public PagedCollection(int pageSize = 50)
     {
         ArgumentOutOfRangeException.ThrowIfNegativeOrZero(pageSize);
         this._pageSize = pageSize;
     }
 
+    /// <summary>
+    /// Sets the source collection.
+    /// </summary>
+    /// <param name="items">The source collection.</param>
     public void SetSource(IReadOnlyList<T> items)
     {
         _source = items ?? throw new ArgumentNullException(nameof(items));
         ApplyFiltering();
     }
 
+    /// <summary>
+    /// Adds a filter to the collection.
+    /// </summary>
+    /// <param name="filter">The filter to add.</param>
     public void AddFilter(Func<T, bool> filter)
     {
         _filters.Add(filter);
         ApplyFiltering();
     }
 
+    /// <summary>
+    /// Clears all filters from the collection.
+    /// </summary>
     public void ClearFilters()
     {
         _filters.Clear();
         ApplyFiltering();
     }
 
+    /// <summary>
+    /// Sets the search criteria for the collection.
+    /// </summary>
+    /// <param name="selector">A function that returns the string representation of the object to search.</param>
+    /// <param name="term">The search term.</param>
     public void SetSearch(Func<T, string> selector, string? term)
     {
         _searchSelector = selector;
@@ -65,16 +90,35 @@ private void ApplyFiltering()
         RaiseAllChanged();
     }
 
+    /// <summary>
+    /// Gets the items on the current page.
+    /// </summary>
     public IReadOnlyList<T> CurrentPageItems =>
         [.. _filtered.Skip(_currentPage * _pageSize).Take(_pageSize)];
 
+    /// <summary>
+    /// Gets the current page number.
+    /// </summary>
     public int CurrentPage => _currentPage + 1;
 
+    /// <summary>
+    /// Gets the total number of pages.
+    /// </summary>
     public int TotalPages => (int)Math.Ceiling((double)_filtered.Count / _pageSize);
 
+    /// <summary>
+    /// Gets a value indicating whether there is a next page.
+    /// </summary>
     public bool HasNext => _currentPage < TotalPages - 1;
+
+    /// <summary>
+    /// Gets a value indicating whether there is a previous page.
+    /// </summary>
     public bool HasPrevious => _currentPage > 0;
 
+    /// <summary>
+    /// Moves to the next page.
+    /// </summary>
     public void NextPage()
     {
         if (HasNext)
@@ -87,6 +131,9 @@ public void NextPage()
         }
     }
 
+    /// <summary>
+    /// Moves to the previous page.
+    /// </summary>
     public void PreviousPage()
     {
         if (HasPrevious)
@@ -108,7 +155,10 @@ private void RaiseAllChanged()
         OnPropertyChanged(nameof(HasPrevious));
     }
 
+    /// <summary>
+    /// Occurs when a property value changes.
+    /// </summary>
     public event PropertyChangedEventHandler? PropertyChanged;
     private void OnPropertyChanged(string name) =>
         PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(name));
-}
+}

SimpleDataGrid/SimpleDataGrid.csproj

@@ -1,10 +1,19 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net9.0-windows</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
 	<UseWPF>true</UseWPF>
+
+	<PackageId>SimpleDataGrid</PackageId>
+	<Version>1.0.0</Version>
+	<Authors>Your Name</Authors>
+	<Company>Your Company</Company>
+	<PackageDescription>A simple DataGrid that supports pagination, filtering, and searching.</PackageDescription>
+	<RepositoryUrl>https://github.com/your-username/SimpleDataGrid</RepositoryUrl>
+	<PackageTags>wpf datagrid pagination filtering searching</PackageTags>
+	<GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
-</Project>
+</Project>