Represents a list that is divided into smaller blocks which are part of the TIBCO 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.Collections.PageableList<T>
Namespace: Spotfire.Dxp.Data.Collections
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 23.18.9504.3877 (23.18.9504.3877)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(3, 0)] public sealed class PageableList<T> : IList, ICollection, IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable, IDisposable, ISerializable, IDataCacheValueType
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 PageableList< T> type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | PageableList<T>() | Obsolete.
Initializes a new instance of the PageableList< T> class that is empty.
|
![]() | PageableList<T>(IEnumerable<T>) | Obsolete.
Initializes a new instance of the PageableList< T>
class that contains elements copied from the specified collection.
|
![]() | PageableList<T>(PageableListSettings) |
Initializes a new instance of the PageableList< T> class that is empty.
|
![]() | PageableList<T>(PageableListSettings, IEnumerable<T>) |
Initializes a new instance of the PageableList< T>
class that contains elements copied from the specified collection.
|
Methods
Name | Description | |
---|---|---|
![]() | Add(Object) |
Adds an object to the end of the PageableList<T>.
|
![]() | Add(T) |
Adds an object to the end of the PageableList<T>.
|
![]() | 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 PageableList<T>.
|
![]() | Contains(Object) |
Determines whether an element is in the PageableList<T>.
|
![]() | Contains(T) |
Determines whether an element is in the PageableList<T>.
|
![]() | CopyTo(Array, Int32) |
Copies the entire PageableList< T> to a compatible one-dimensional array,
starting at the specified index of the target array.
|
![]() | CopyTo(T[], Int32) |
Copies the entire PageableList< T> to a compatible one-dimensional array,
starting at the specified index of the target array.
|
![]() | Dispose |
Releases all memory associated with the PageableList<T>.
|
![]() | Enumerate |
Returns an enumerator that iterate through the given elements.
|
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetEnumerator |
Returns an enumerator that iterates through a collection.
|
![]() | 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 PageableList<T>.
|
![]() | IndexOf(T) | Searches for the specified object and returns the
zero-based index of the first occurrence within the entire PageableList<T>.
|
![]() | Insert(Int32, Object) |
Inserts an element into the PageableList< T> at the specified index.
|
![]() | Insert(Int32, T) |
Inserts an element into the PageableList< T> at the specified index.
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Remove(Object) |
Removes the first occurrence of a specific object from the PageableList<T>.
|
![]() | Remove(T) |
Removes the first occurrence of a specific object from the PageableList<T>.
|
![]() | RemoveAt |
Removes the element at the specified index of the PageableList<T>.
|
![]() | 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 PageableList< T> using the default comparer.
|
![]() | Sort(IComparer<T>) |
Sorts the elements in the entire PageableList< T> using the specified comparer.
|
![]() | Sort<S>(PageableList<S>) |
Sorts a pair of PageableList< T> objects
(this contains the keys and valueList contains the corresponding items)
based on the keys in this. The default comparer is used when sorting.
|
![]() | Sort<S>(PageableList<S>, IComparer<T>) |
Sorts a pair of PageableList< T> objects
(this contains the keys and valueList contains the corresponding items)
based on the keys in this. The supplied comparer is used when sorting.
|
Properties
Name | Description | |
---|---|---|
![]() | Count |
Gets the number of elements actually contained in the PageableList<T>.
|
![]() | IsFixedSize |
Gets a value indicating whether the PageableList< T> has a fixed size.
|
![]() | IsReadOnly |
Gets a value indicating whether the PageableList< T> is read-only.
|
![]() | IsSynchronized |
Gets a value indicating whether access to the PageableList< T>
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 PageableList<T> |
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IEnumerable.GetEnumerator |
Returns an enumerator that iterates through a collection.
|
![]() ![]() | IList.Item |
Gets or sets the element at the specified index.
|
![]() ![]() | IList.RemoveAt |
Removes the IList item at the specified index.
|
Remarks
In read-write mode synchronization needs to be implemented by the caller.
From TIBCO Spotfire 2.2.0 the type parameter <T> may also be BinaryLargeObject, the Spotfire type used to represent a byte stream. From TIBCO Spotfire 3.1.0 the following type parameters are added: bool, long, float and TimeSpan.
Version Information
Supported in: 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also
See Also