PageableList< T> Class TIBCO Spotfire 7.5 API Reference
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.
Inheritance Hierarchy

System. Object
  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

  NameDescription
Public methodPageableList<T>() Obsolete.
Initializes a new instance of the PageableList< T> class that is empty.
Public methodPageableList<T>(IEnumerable<T>) Obsolete.
Initializes a new instance of the PageableList< T> class that contains elements copied from the specified collection.
Public methodPageableList<T>(PageableListSettings)
Initializes a new instance of the PageableList< T> class that is empty.
Public methodPageableList<T>(PageableListSettings, IEnumerable<T>)
Initializes a new instance of the PageableList< T> class that contains elements copied from the specified collection.
Top
Methods

  NameDescription
Public methodAdd(Object)
Adds an object to the end of the PageableList<T>.
Public methodAdd(T)
Adds an object to the end of the PageableList<T>.
Public methodAsReadOnly
Returns this if read-only, otherwise a read-only clone.
Public methodAsWritable
Returns a writable clone if this is read-only, otherwise this.
Public methodClear
Removes all elements from the PageableList<T>.
Public methodContains(Object)
Determines whether an element is in the PageableList<T>.
Public methodContains(T)
Determines whether an element is in the PageableList<T>.
Public methodCopyTo(Array, Int32)
Copies the entire PageableList< T> to a compatible one-dimensional array, starting at the specified index of the target array.
Public methodCopyTo(T[], Int32)
Copies the entire PageableList< T> to a compatible one-dimensional array, starting at the specified index of the target array.
Public methodDispose
Releases all memory associated with the PageableList<T>.
Public methodEnumerate
Returns an enumerator that iterate through the given elements.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through a collection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf(Object)
Searches for the specified object and returns the zero-based index of the first occurrence within the entire PageableList<T>.
Public methodIndexOf(T)
Searches for the specified object and returns the zero-based index of the first occurrence within the entire PageableList<T>.
Public methodInsert(Int32, Object)
Inserts an element into the PageableList< T> at the specified index.
Public methodInsert(Int32, T)
Inserts an element into the PageableList< T> at the specified index.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemove(Object)
Removes the first occurrence of a specific object from the PageableList<T>.
Public methodRemove(T)
Removes the first occurrence of a specific object from the PageableList<T>.
Public methodRemoveAt
Removes the element at the specified index of the PageableList<T>.
Public methodSetReadOnly
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.
Public methodSort()
Sorts the elements in the entire PageableList< T> using the default comparer.
Public methodSort(IComparer<T>)
Sorts the elements in the entire PageableList< T> using the specified comparer.
Public methodSort<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.
Public methodSort<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.
Top
Properties

  NameDescription
Public propertyCount
Gets the number of elements actually contained in the PageableList<T>.
Public propertyIsFixedSize
Gets a value indicating whether the PageableList< T> has a fixed size.
Public propertyIsReadOnly
Gets a value indicating whether the PageableList< T> is read-only.
Public propertyIsSynchronized
Gets a value indicating whether access to the PageableList< T> is synchronized (thread safe).
Public propertyItem
Gets or sets the element at the specified index.
Public propertySyncRoot
Gets an object that can be used to synchronize access to the PageableList<T>
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIEnumerable.GetEnumerator
Returns an enumerator that iterates through a collection.
Explicit interface implementationPrivate propertyIList.Item
Gets or sets the element at the specified index.
Explicit interface implementationPrivate methodIList.RemoveAt
Removes the IList item at the specified index.
Top
Remarks

A PageableList< T> is not thread safe for concurrent reading and writing, but if it is made read-only through a call to SetReadOnly() multiple readers are handled in a thread safe manner.
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

Reference