2008-03-05 09:52:00 -05:00
|
|
|
// ==++==
|
|
|
|
//
|
|
|
|
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
|
|
//
|
|
|
|
// ==--==
|
2008-11-17 18:29:00 -05:00
|
|
|
//============================================================
|
|
|
|
//
|
|
|
|
// Interface: IList
|
|
|
|
//
|
|
|
|
// Purpose: Base interface for all Lists.
|
|
|
|
//
|
|
|
|
//===========================================================
|
|
|
|
namespace System.Collections
|
|
|
|
{
|
2008-03-05 09:52:00 -05:00
|
|
|
|
|
|
|
using System;
|
|
|
|
// An IList is an ordered collection of objects. The exact ordering
|
|
|
|
// is up to the implementation of the list, ranging from a sorted
|
|
|
|
// order to insertion order.
|
|
|
|
//| <include path='docs/doc[@for="IList"]/*' />
|
|
|
|
public interface IList : ICollection
|
|
|
|
{
|
|
|
|
// The Item property provides methods to read and edit entries in the List.
|
|
|
|
//| <include path='docs/doc[@for="IList.this"]/*' />
|
|
|
|
Object this[int index] {
|
|
|
|
get;
|
|
|
|
set;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Adds an item to the list. The exact position in the list is
|
|
|
|
// implementation-dependent, so while ArrayList may always insert
|
|
|
|
// in the last available location, a SortedList most likely would not.
|
|
|
|
// The return value is the position the new element was inserted in.
|
|
|
|
//| <include path='docs/doc[@for="IList.Add"]/*' />
|
|
|
|
int Add(Object value);
|
|
|
|
|
|
|
|
// Returns whether the list contains a particular item.
|
|
|
|
//| <include path='docs/doc[@for="IList.Contains"]/*' />
|
|
|
|
bool Contains(Object value);
|
|
|
|
|
|
|
|
// Removes all items from the list.
|
|
|
|
//| <include path='docs/doc[@for="IList.Clear"]/*' />
|
|
|
|
void Clear();
|
|
|
|
//| <include path='docs/doc[@for="IList.IsReadOnly"]/*' />
|
|
|
|
|
|
|
|
bool IsReadOnly
|
|
|
|
{ get; }
|
|
|
|
//| <include path='docs/doc[@for="IList.IsFixedSize"]/*' />
|
|
|
|
|
|
|
|
|
|
|
|
bool IsFixedSize
|
|
|
|
{
|
|
|
|
get;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// Returns the index of a particular item, if it is in the list.
|
|
|
|
// Returns -1 if the item isn't in the list.
|
|
|
|
//| <include path='docs/doc[@for="IList.IndexOf"]/*' />
|
|
|
|
int IndexOf(Object value);
|
|
|
|
|
|
|
|
// Inserts value into the list at position index.
|
|
|
|
// index must be non-negative and less than or equal to the
|
|
|
|
// number of elements in the list. If index equals the number
|
|
|
|
// of items in the list, then value is appended to the end.
|
|
|
|
//| <include path='docs/doc[@for="IList.Insert"]/*' />
|
|
|
|
void Insert(int index, Object value);
|
|
|
|
|
|
|
|
// Removes an item from the list.
|
|
|
|
//| <include path='docs/doc[@for="IList.Remove"]/*' />
|
|
|
|
void Remove(Object value);
|
|
|
|
|
|
|
|
// Removes the item at position index.
|
|
|
|
//| <include path='docs/doc[@for="IList.RemoveAt"]/*' />
|
|
|
|
void RemoveAt(int index);
|
|
|
|
}
|
|
|
|
}
|