C# / .Net API Library Reference  4.3.2-74-ge1d4cca
Public Functions | Properties
EncoderFormatParameterMap Class Reference

The EncoderFormatParameterMap class allows you to create your own custom encoder format object from the ground up by creating an array of the parameters that you care about.

Public Functions

void Add (string key, string value)
 
void Add (KeyValuePair< string, string > item)
 
void Clear ()
 
bool Contains (KeyValuePair< string, string > item)
 
bool ContainsKey (string key)
 
void CopyTo (KeyValuePair< string, string >[] array, int arrayIndex)
 
IEnumerator< KeyValuePair< string, string > > GetEnumerator ()
 
void OnChanged (EventArgs e)
 
bool Remove (string key)
 
bool Remove (KeyValuePair< string, string > item)
 
bool TryGetValue (string key, out string value)
 

Properties

int Count [get]
 
bool IsReadOnly [get]
 
ICollection< string > Keys [get]
 
string this[string key] [get, set]
 
ICollection< string > Values [get]
 

Usage Description

void Add ( string  key,
string  value 
)
inline

Adds the specified parameter to the parameter map.

void Add ( KeyValuePair< string, string >  item)
inline

Adds the specified parameter to the parameter map.

void Clear ( )
inline

Clears the parameter map by removing any previously set parameter.

bool Contains ( KeyValuePair< string, string >  item)
inline

Checks whether the parameter map contains the specified parameter. Returns true if it does, and false otherwise.

bool ContainsKey ( string  key)
inline

Checks whether the parameter map contains the specified key. Returns true if it does, and false otherwise.

void CopyTo ( KeyValuePair< string, string >[]  array,
int  arrayIndex 
)
inline

Copies content to the specified position in the parameter map.

IEnumerator<KeyValuePair<string, string> > GetEnumerator ( )
inline

Returns the array enumerator for the parameter map.

void OnChanged ( EventArgs  e)
inline

Handles encoder configuration changed events.

bool Remove ( string  key)
inline

Removes the specified key from the parameter map.

bool Remove ( KeyValuePair< string, string >  item)
inline

Removes the specified parameters from the parameter map.

bool TryGetValue ( string  key,
out string  value 
)
inline

Checks whether the parameter map contains the specified key-value pair. If it does, returns true and assigns the value to the parameter. Otherwise, returns false.

Property Documentation

int Count
get

Returns the number of parameters currently set in the parameter map.

bool IsReadOnly
get

Checks whether the parameter map is read-only. Returns true if it is, and false otherwise.

ICollection<string> Keys
get

Returns the list of all the keys currently set in the parameter map.

string this[string key]
getset

Returns a reference to the element associated with the given key in the array container.

ICollection<string> Values
get

Returns the list of all the values currently set in the parameter map.