@@ -8,12 +8,8 @@ namespace X.PagedList;
8
8
/// Represents a subset of a collection of objects that can be individually accessed by index and containing
9
9
/// metadata about the superset collection of objects this subset was created from.
10
10
/// </summary>
11
- /// <remarks>
12
- /// Represents a subset of a collection of objects that can be individually accessed by index and containing
13
- /// metadata about the superset collection of objects this subset was created from.
14
- /// </remarks>
15
11
/// <typeparam name="T">The type of object the collection should contain.</typeparam>
16
- /// <seealso cref="IEnumerable {T}"/>
12
+ /// <seealso cref="IReadOnlyList {T}"/>
17
13
[ PublicAPI ]
18
14
public interface IPagedList < out T > : IPagedList , IReadOnlyList < T >
19
15
{
@@ -29,101 +25,61 @@ public interface IPagedList<out T> : IPagedList, IReadOnlyList<T>
29
25
/// Represents a subset of a collection of objects that can be individually accessed by index and containing
30
26
/// metadata about the superset collection of objects this subset was created from.
31
27
/// </summary>
32
- /// <remarks>
33
- /// Represents a subset of a collection of objects that can be individually accessed by index and containing
34
- /// metadata about the superset collection of objects this subset was created from.
35
- /// </remarks>
36
28
public interface IPagedList
37
29
{
38
30
/// <summary>
39
31
/// Total number of subsets within the superset.
40
32
/// </summary>
41
- /// <value>
42
- /// Total number of subsets within the superset.
43
- /// </value>
44
33
int PageCount { get ; }
45
34
46
35
/// <summary>
47
36
/// Total number of objects contained within the superset.
48
37
/// </summary>
49
- /// <value>
50
- /// Total number of objects contained within the superset.
51
- /// </value>
52
38
int TotalItemCount { get ; }
53
39
54
40
/// <summary>
55
41
/// One-based index of this subset within the superset, zero if the superset is empty.
56
42
/// </summary>
57
- /// <value>
58
- /// One-based index of this subset within the superset, zero if the superset is empty.
59
- /// </value>
60
43
int PageNumber { get ; }
61
44
62
45
/// <summary>
63
46
/// Maximum size any individual subset.
64
47
/// </summary>
65
- /// <value>
66
- /// Maximum size any individual subset.
67
- /// </value>
68
48
int PageSize { get ; }
69
49
70
50
/// <summary>
71
51
/// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
72
52
/// is NOT the first subset within the superset.
73
53
/// </summary>
74
- /// <value>
75
- /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
76
- /// is NOT the first subset within the superset.
77
- /// </value>
78
54
bool HasPreviousPage { get ; }
79
55
80
56
/// <summary>
81
57
/// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
82
58
/// is NOT the last subset within the superset.
83
59
/// </summary>
84
- /// <value>
85
- /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
86
- /// is NOT the last subset within the superset.
87
- /// </value>
88
60
bool HasNextPage { get ; }
89
61
90
62
/// <summary>
91
63
/// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
92
64
/// is the first subset within the superset.
93
65
/// </summary>
94
- /// <value>
95
- /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
96
- /// is the first subset within the superset.
97
- /// </value>
98
66
bool IsFirstPage { get ; }
99
67
100
68
/// <summary>
101
69
/// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
102
70
/// is the last subset within the superset.
103
71
/// </summary>
104
- /// <value>
105
- /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
106
- /// is the last subset within the superset.
107
- /// </value>
108
72
bool IsLastPage { get ; }
109
73
110
74
/// <summary>
111
75
/// One-based index of the first item in the paged subset, zero if the superset is empty or PageNumber
112
76
/// is greater than PageCount.
113
77
/// </summary>
114
- /// <value>
115
- /// One-based index of the first item in the paged subset, zero if the superset is empty or PageNumber
116
- /// is greater than PageCount.
117
- /// </value>
118
78
int FirstItemOnPage { get ; }
119
79
120
80
/// <summary>
121
81
/// One-based index of the last item in the paged subset, zero if the superset is empty or PageNumber
122
82
/// is greater than PageCount.
123
83
/// </summary>
124
- /// <value>
125
- /// One-based index of the last item in the paged subset, zero if the superset is empty or PageNumber
126
- /// is greater than PageCount.
127
- /// </value>
128
84
int LastItemOnPage { get ; }
129
85
}
0 commit comments