FoodCandy!

RssFeedCollection Class Reference

A strongly typed collection of RssFeed objects. More...

List of all members.


Public Member Functions

int Add (RssFeed feed)
 Adds a specified feed to this collection.
bool Contains (RssFeed rssFeed)
 Determines whether the RssFeedCollection contains a specific element.
void CopyTo (RssFeed[] array, int index)
 Copies the entire RssFeedCollection to a compatible one-dimensional Array, starting at the specified index of the target array.
int IndexOf (RssFeed rssFeed)
 Searches for the specified RssFeed and returns the zero-based index of the first occurrence within the entire RssFeedCollection.
void Insert (int index, RssFeed feed)
 Inserts a feed into this collection at a specified index.
void Remove (RssFeed feed)
 Removes a specified category from this collection.

Properties

RssFeed this [int index]
 Gets or sets the feed with the given name.

In C#, this property is the indexer for the class.

.


Detailed Description

A strongly typed collection of RssFeed objects.


Member Function Documentation

int Add RssFeed  feed  ) 
 

Adds a specified feed to this collection.

Parameters:
feed The feed to add.
Returns:
The zero-based index of the added feed.

bool Contains RssFeed  rssFeed  ) 
 

Determines whether the RssFeedCollection contains a specific element.

Parameters:
rssFeed The RssFeed to locate in the RssFeedCollection.
Returns:
true if the RssFeedCollection contains the specified value; otherwise, false.

void CopyTo RssFeed[]  array,
int  index
 

Copies the entire RssFeedCollection to a compatible one-dimensional Array, starting at the specified index of the target array.

Parameters:
array The one-dimensional RssFeed Array that is the destination of the elements copied from RssFeedCollection. The Array must have zero-based indexing.
index The zero-based index in array at which copying begins.
Exceptions:
ArgumentNullException array is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeException index is less than zero.
ArgumentException array is multidimensional. -or- index is equal to or greater than the length of array.-or-The number of elements in the source RssFeedCollection is greater than the available space from index to the end of the destination array.

int IndexOf RssFeed  rssFeed  ) 
 

Searches for the specified RssFeed and returns the zero-based index of the first occurrence within the entire RssFeedCollection.

Parameters:
rssFeed The RssFeed to locate in the RssFeedCollection.
Returns:
The zero-based index of the first occurrence of RssFeed within the entire RssFeedCollection, if found; otherwise, -1.

void Insert int  index,
RssFeed  feed
 

Inserts a feed into this collection at a specified index.

Parameters:
index The zero-based index of the collection at which to insert the feed.
feed The feed to insert into this collection.

void Remove RssFeed  feed  ) 
 

Removes a specified category from this collection.

Parameters:
feed The category to remove.

Property Documentation

RssFeed this [get, set]
 

Gets or sets the feed with the given name.

In C#, this property is the indexer for the class.

.

Parameters:
index The index of the collection to access.

A feed at each valid index.

This method is an indexer that can be used to access the collection.

Exceptions:
ArgumentOutOfRangeException index is not a valid index.

The documentation for this class was generated from the following file:
  • RssFeedCollection.cs
© FoodCandy, 2006-2007, All Rights Reserved | FoodCandy | Sun Oct 7 10:48:51 2007 | Doxygen 1.4.6-NO