A collection of IndexValues which may be supplied to State Server in
either query/filter operations or when specifying metadata values.
Inheritance Hierarchy
Soss.ClientIndexCollection
Soss.ClientFilterCollection
Namespace: Soss.Client
Assembly: soss_svcdotnet (in soss_svcdotnet.dll) Version: 6.2.0.0 (1.0.0.0)
Syntax
[SerializableAttribute] public class IndexCollection : IList, ICollection, IEnumerable, IFilter
The IndexCollection type exposes the following members.
Constructors
Name | Description | |
---|---|---|
IndexCollection |
Create a new IndexCollection instance.
|
Properties
Name | Description | |
---|---|---|
Count |
Gets the number of elements in the IndexCollection. Since the collection
is fixed-size, this property always returns MaxIndexValues.
| |
IsFixedSize |
Returns true.
| |
IsReadOnly |
Returns false.
| |
IsSynchronized |
Returns false. Callers may synchronize the list using SyncRoot.
| |
Item |
Gets or sets the element at the specified index.
| |
MaxIndexValues |
The fixed number of IndexValues an IndexCollection
may hold. This value is currently 8.
| |
SyncRoot |
Gets an object that can be used to synchronize access to the IndexCollection.
|
Methods
Name | Description | |
---|---|---|
Clear |
Sets the value of all IndexValue instances in the collection to
null.
| |
Clear(Int32) |
Sets the value of the IndexValue instance at the specified index to
a default (unused) value.
| |
Contains |
Tests to see if the collection contains value. Note that
IndexValues are compared by value, not by reference. See Equals(Object).
| |
CopyTo |
Copies the entire contents of this collection to a compatible,
one-dimensional Array, starting at the specified index in
the target array.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
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 for this IndexCollection.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetIndexCollection |
Return this IndexCollection.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IndexOf |
Searches for the specified IndexValue and returns the
zero-based index of the first occurrence within the IndexCollection.
| |
Insert |
Inserts an element into the IndexCollection at the specified index.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Remove |
Removes the first occurrence of a specific IndexValue from
the IndexCollection.
| |
RemoveAt |
Removes the element at the specified index of the IndexCollection.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
IndexCollections are fixed-length collections where the length is defined by the StateServer implementation. Not all index positions need have values. That is, an IndexCollection may be sparsely filled in.
Since IndexCollection implements IFilter, an IndexCollection instance may be used as the filter parameter for query and method invocation operations.
See Also