RSS document class More...

Inheritance diagram for Utilities.IO.FileFormats.RSS.Document:

Public Member Functions
	Document ()
	Constructor More...

	Document (string Location)
	Constructor More...

	Document (IXPathNavigable Document)
	Constructor More...

void	Add (Channel item)
	Adds a channel to the document More...

void	Clear ()
	Clears the document More...

bool	Contains (Channel item)
	Does this contain the channel specified More...

virtual void	Copy (Document CopyFrom)
	Copies one document's channels to another More...

void	CopyTo (Channel[] array, int arrayIndex)
	Copies the channels to an array More...

IEnumerator< Channel >	GetEnumerator ()
	Gets the enumerator More...

int	IndexOf (Channel item)
	Index of the item specified More...

void	Insert (int index, Channel item)
	Inserts a channel More...

bool	Remove (Channel item)
	Removes an item from the document More...

void	RemoveAt (int index)
	Remove channel at a specific index More...

override string	ToString ()
	string representation of the RSS feed. More...

Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.StringFormatBase< Document >
override object	Clone ()
	Clones the object More...

override int	CompareTo (FormatType other)
	Compares the object to another object More...

override bool	Equals (FormatType other)
	Determines if the objects are equal More...

override FormatType	Save (string Location)
	Saves the object More...

Protected Member Functions
override void	LoadFromData (string Data)
	Loads the object from the data specified More...

Protected Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.StringFormatBase< Document >
	StringFormatBase ()
	Constructor More...

override FormatType	InternalLoad (string Location)
	Loads the object from the location specified More...

Properties
int	Count `[get]`
	Channel count More...

bool	IsReadOnly `[get]`
	Determines if it is read only More...

IList< Channel >	Channels `[get]`
	Channels for the RSS feed More...

Channel	this[int index] `[get, set]`
	Gets/sets a channel More...

Additional Inherited Members
Static Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.StringFormatBase< Document >
static implicit	operator string (StringFormatBase< FormatType > Value)
	Converts the format to a string More...

static implicit	operator StringFormatBase< FormatType > (string Value)
	Converts the string to the format specified More...

Detailed Description

RSS document class

Definition at line 37 of file Document.cs.

Constructor & Destructor Documentation

Utilities.IO.FileFormats.RSS.Document.Document ( )

Constructor

Definition at line 42 of file Document.cs.

Utilities.IO.FileFormats.RSS.Document.Document ( string Location )

Constructor

Parameters

Location Location of the RSS feed to load

Definition at line 51 of file Document.cs.

Utilities.IO.FileFormats.RSS.Document.Document ( IXPathNavigable Document )

Constructor

Parameters

Document XML document containing an RSS feed

Definition at line 62 of file Document.cs.

Member Function Documentation

void Utilities.IO.FileFormats.RSS.Document.Add ( Channel item )

Adds a channel to the document

Parameters

item	Item to add

Definition at line 111 of file Document.cs.

void Utilities.IO.FileFormats.RSS.Document.Clear ( )

Clears the document

Definition at line 119 of file Document.cs.

bool Utilities.IO.FileFormats.RSS.Document.Contains ( Channel item )

Does this contain the channel specified

Parameters

item	Channel to check

Returns: True if it does, false otherwise

Definition at line 129 of file Document.cs.

virtual void Utilities.IO.FileFormats.RSS.Document.Copy ( Document CopyFrom )

virtual

Copies one document's channels to another

Parameters

CopyFrom RSS document to copy from

Definition at line 138 of file Document.cs.

void Utilities.IO.FileFormats.RSS.Document.CopyTo	(	Channel[]	array,
		int	arrayIndex
	)

Copies the channels to an array

Parameters

array	Array to copy to
arrayIndex	Array starting index

Definition at line 152 of file Document.cs.

IEnumerator<Channel> Utilities.IO.FileFormats.RSS.Document.GetEnumerator ( )

Gets the enumerator

Returns: Enumerator of the document

Definition at line 161 of file Document.cs.

int Utilities.IO.FileFormats.RSS.Document.IndexOf ( Channel item )

Index of the item specified

Parameters

item Channel

Returns: Index of the channel

Definition at line 171 of file Document.cs.

void Utilities.IO.FileFormats.RSS.Document.Insert	(	int	index,
		Channel	item
	)

Inserts a channel

Parameters

index	index
item	Channel item

Definition at line 181 of file Document.cs.

override void Utilities.IO.FileFormats.RSS.Document.LoadFromData ( string Data )

protectedvirtual

Loads the object from the data specified

Parameters

Data	Data to load into the object

Implements Utilities.IO.FileFormats.BaseClasses.StringFormatBase< Document >.

Definition at line 230 of file Document.cs.

bool Utilities.IO.FileFormats.RSS.Document.Remove ( Channel item )

Removes an item from the document

Parameters

item	Channel to remove

Returns: True if it is removed, false otherwise

Definition at line 191 of file Document.cs.

void Utilities.IO.FileFormats.RSS.Document.RemoveAt ( int index )

Remove channel at a specific index

Parameters

index Index to remove

Definition at line 200 of file Document.cs.

override string Utilities.IO.FileFormats.RSS.Document.ToString ( )

string representation of the RSS feed.

Returns: An rss formatted string

Definition at line 218 of file Document.cs.

Property Documentation

IList<Channel> Utilities.IO.FileFormats.RSS.Document.Channels

getprotected

Channels for the RSS feed

Definition at line 88 of file Document.cs.

int Utilities.IO.FileFormats.RSS.Document.Count

get

Channel count

Definition at line 73 of file Document.cs.

bool Utilities.IO.FileFormats.RSS.Document.IsReadOnly

get

Determines if it is read only

Definition at line 81 of file Document.cs.

Channel Utilities.IO.FileFormats.RSS.Document.this[int index]

getset

Gets/sets a channel

Parameters

index index

Returns: The channel specified

Definition at line 96 of file Document.cs.

The documentation for this class was generated from the following file:

Utilities/IO/FileFormats/RSS/Document.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation