Represents a list that is divided into smaller blocks which are part of the Spotfire paging mechanism.
It is primarily intended to be used for storing a large number of values.
Best performance is achieved by only adding values to the end of the list. Inserting and removing elements is permitted but expensive from a performance perspective.
It is primarily intended to be used for storing a large number of values.
Best performance is achieved by only adding values to the end of the list. Inserting and removing elements is permitted but expensive from a performance perspective.
Inheritance Hierarchy
Spotfire.Dxp.Data.CollectionsPageableListT
Namespace: Spotfire.Dxp.Data.Collections
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(3, 0)] public sealed class PageableList<T> : IList, ICollection, IEnumerable, IList<T>, ICollection<T>, IEnumerable<T>, IDisposable, ISerializable
Type Parameters
- T
- The type for the values in the list.
The following types are currently supported:
bool
int
long
decimal
float
double
string
DateTime
TimeSpan
BinaryLargeObject
The PageableListT type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | PageableListT | Obsolete.
Initializes a new instance of the PageableListT class that is empty.
|
| PageableListT(IEnumerableT) | Obsolete.
Initializes a new instance of the PageableListT
class that contains elements copied from the specified collection.
|
| PageableListT(PageableListSettings) |
Initializes a new instance of the PageableListT class that is empty.
|
| PageableListT(PageableListSettings, IEnumerableT) |
Initializes a new instance of the PageableListT
class that contains elements copied from the specified collection.
|
Properties
| Name | Description | |
|---|---|---|
 | Count |
Gets the number of elements actually contained in the PageableListT.
|
| IsFixedSize |
Gets a value indicating whether the PageableListT has a fixed size.
|
| IsReadOnly |
Gets a value indicating whether the PageableListT is read-only.
|
| IsSynchronized |
Gets a value indicating whether access to the PageableListT
is synchronized (thread safe).
|
| Item |
Gets or sets the element at the specified index.
|
| SyncRoot |
Gets an object that can be used to synchronize access to the PageableListT |
Methods
| Name | Description | |
|---|---|---|
| Add(Object) |
Adds an object to the end of the PageableListT.
|
| Add(T) |
Adds an object to the end of the PageableListT.
|
| AsReadOnly | Returns this if read-only, otherwise a read-only clone. |
| AsWritable | Returns a writable clone if this is read-only, otherwise this. |
| Clear |
Removes all elements from the PageableListT.
|
| Contains(Object) |
Determines whether an element is in the PageableListT.
|
| Contains(T) |
Determines whether an element is in the PageableListT.
|
| CopyTo(Array, Int32) |
Copies the entire PageableListT to a compatible one-dimensional array,
starting at the specified index of the target array.
|
| CopyTo(T, Int32) |
Copies the entire PageableListT to a compatible one-dimensional array,
starting at the specified index of the target array.
|
| Dispose |
Releases all memory associated with the PageableListT.
|
| Enumerate |
Returns an enumerator that iterate through the given elements.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through a collection.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf(Object) | Searches for the specified object and returns the
zero-based index of the first occurrence within the entire PageableListT.
|
| IndexOf(T) | Searches for the specified object and returns the
zero-based index of the first occurrence within the entire PageableListT.
|
| Insert(Int32, Object) |
Inserts an element into the PageableListT at the specified index.
|
| Insert(Int32, T) |
Inserts an element into the PageableListT at the specified index.
|
| Remove(Object) |
Removes the first occurrence of a specific object from the PageableListT.
|
| Remove(T) |
Removes the first occurrence of a specific object from the PageableListT.
|
| RemoveAt |
Removes the element at the specified index of the PageableListT.
|
| SetReadOnly |
Calling this method will turn the list into a read-only collection.
Any attempt to change the content after this call will throw an exception.
|
| Sort |
Sorts the elements in the entire PageableListT using the default comparer.
|
| Sort(IComparerT) |
Sorts the elements in the entire PageableListT using the specified comparer.
|
| SortS(PageableListS) |
Sorts a pair of PageableListT objects
(this contains the keys and valueList contains the corresponding items)
based on the keys in this. The default comparer is used when sorting.
|
| SortS(PageableListS, IComparerT) |
Sorts a pair of PageableListT objects
(this contains the keys and valueList contains the corresponding items)
based on the keys in this. The supplied comparer is used when sorting.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IEnumerableGetEnumerator |
Returns an enumerator that iterates through a collection.
|
| ISerializableGetObjectData | Populates a SerializationInfo with the data needed to serialize the target object. |
 | IListItem |
Gets or sets the element at the specified index.
|
| IListRemoveAt |
Removes the IList item at the specified index.
|
Remarks
In read-write mode synchronization needs to be implemented by the caller.
From Spotfire 2.2.0 the type parameter <T> may also be BinaryLargeObject, the Spotfire type used to represent a byte stream. From Spotfire 3.1.0 the following type parameters are added: bool, long, float and TimeSpan.
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also