AgateLib.Resources.AgateResourceCollection Class Reference

Class which wraps an XML based resource file. This class provides methods for adding and extracting resources. More...

List of all members.

Public Member Functions
	AgateResourceCollection ()
	Constructs a new AgateResourceCollection object.
	AgateResourceCollection (string filename)
	AgateResourceCollection (IFileProvider fileProvider, string filename)
void	Add (AgateResource item)
	Adds a resource to this group. An exception is thrown if an item with the same name already exists in the group.
void	Clear ()
bool	Contains (string resourceName)
bool	Remove (string resourceName)
	Removes a resource.
bool	TryGetValue (string key, out AgateResource value)
	Tries to find the resource in the collection. False is returned if the resource does not exist.
IEnumerator< AgateResource >	GetEnumerator ()
bool	Contains (AgateResource item)
	Gets whether the item is part of the collection.
bool	Remove (AgateResource item)
	Removes a resource from the collection.
Properties
IFileProvider	FileProvider [get, set]
string	RootDirectory [get, set]
IEnumerable< SpriteResource >	Sprites [get]
	Enumerates through the SpriteResources contained in this group of resources.
IEnumerable< SurfaceResource >	Surfaces [get]
	Enumerates through the SurfaceResources contained in this group of resources.
IEnumerable < DisplayWindowResource >	DisplayWindows [get]
	Enumerates through the DisplayWindowResources contained in this group of resources.
IEnumerable< BitmapFontResource >	BitmapFonts [get]
	Enumerates through the BitmapFontResources contained in this group of resources.
StringTable	Strings [get]
	Gets the StringTable for this langauge.
int	Count [get]
ICollection< string >	Keys [get]
	Returns a collection of all the resource names.
ICollection< AgateResource >	Values [get]
	Gets a collection of all the AgateResource objects in the collection.
AgateResource	this [string key] [get, set]
	Gets or sets the resource with the specified key.

---

Detailed Description

Class which wraps an XML based resource file. This class provides methods for adding and extracting resources.

---

Constructor & Destructor Documentation

AgateLib.Resources.AgateResourceCollection.AgateResourceCollection

(

)

Constructs a new AgateResourceCollection object.

---

Member Function Documentation

void AgateLib.Resources.AgateResourceCollection.Add

(

AgateResource

item

)

Adds a resource to this group. An exception is thrown if an item with the same name already exists in the group.

Parameters:

item

void AgateLib.Resources.AgateResourceCollection.Clear

(

)

bool AgateLib.Resources.AgateResourceCollection.Contains

(

AgateResource

item

)

Gets whether the item is part of the collection.

Parameters:

item

Returns:

bool AgateLib.Resources.AgateResourceCollection.Contains

(

string

resourceName

)

Parameters:

resourceName

Returns:

IEnumerator<AgateResource> AgateLib.Resources.AgateResourceCollection.GetEnumerator

(

)

Returns:

bool AgateLib.Resources.AgateResourceCollection.Remove

(

AgateResource

item

)

Removes a resource from the collection.

Parameters:

item

Returns:

bool AgateLib.Resources.AgateResourceCollection.Remove

(

string

resourceName

)

Removes a resource.

Parameters:

resourceName

Returns:

bool AgateLib.Resources.AgateResourceCollection.TryGetValue	(	string	key,
		out AgateResource	value
	)

Tries to find the resource in the collection. False is returned if the resource does not exist.

Parameters:

	key
	value

Returns:

---

Property Documentation

IEnumerable<BitmapFontResource> AgateLib.Resources.AgateResourceCollection.BitmapFonts [get]

Enumerates through the BitmapFontResources contained in this group of resources.

int AgateLib.Resources.AgateResourceCollection.Count [get]

IEnumerable<DisplayWindowResource> AgateLib.Resources.AgateResourceCollection.DisplayWindows [get]

Enumerates through the DisplayWindowResources contained in this group of resources.

ICollection<string> AgateLib.Resources.AgateResourceCollection.Keys [get]

Returns a collection of all the resource names.

IEnumerable<SpriteResource> AgateLib.Resources.AgateResourceCollection.Sprites [get]

Enumerates through the SpriteResources contained in this group of resources.

StringTable AgateLib.Resources.AgateResourceCollection.Strings [get]

Gets the StringTable for this langauge.

IEnumerable<SurfaceResource> AgateLib.Resources.AgateResourceCollection.Surfaces [get]

Enumerates through the SurfaceResources contained in this group of resources.

AgateResource AgateLib.Resources.AgateResourceCollection.this[string key] [get, set]

Gets or sets the resource with the specified key.

Parameters:

key

Returns:

ICollection<AgateResource> AgateLib.Resources.AgateResourceCollection.Values [get]

Gets a collection of all the AgateResource objects in the collection.

---

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

• Resources/AgateResourceCollection.cs