DotNetBrowser  1.14
Public Member Functions | Properties | List of all members
DotNetBrowser.MultipartFormData Class Reference

Represents POST data parameters if the Content-Type is multipart/form-data. More...

Inherits DotNetBrowser.FormData.

Public Member Functions

 MultipartFormData ()
 Constructs a new MultipartFormData instance. More...
 
 MultipartFormData (IDictionary< string, IList< string >> keyValuePairs, IDictionary< string, IList< string >> fileList)
 Constructs a new MultipartFormData instance with specified parameters. More...
 
ICollection< string > GetFileKeys ()
 Returns all file keys from the file list of the POST request. More...
 
IList< string > GetFiles (string key)
 Returns a list of file paths from the file list associated with specified key. More...
 
IList< string > SetFilePair (string key, params string[] files)
 Sets key-value pair to the file list of the POST request. If such a key already exist, it will be replaced. More...
 
IList< string > RemoveFilePair (string key)
 Removes the file with associated key from the file list of the POST request. More...
 
void RemoveAllFilePairs ()
 Removes all files from the file list of the POST request. More...
 
override int GetHashCode ()
 Serves as a hash function for a particular type. More...
 
override bool Equals (object obj)
 Determines whether the specified MultipartFormData is equal to the current MultipartFormData. More...
 
- Public Member Functions inherited from DotNetBrowser.FormData
 FormData ()
 Constructs a new FormData instance. More...
 
 FormData (IDictionary< string, IList< string >> keyValuePairs)
 Constructs a new FormData instance with specified parameters. More...
 
ICollection< string > GetPairKeys ()
 Returns all keys from the key-value pair collection of the POST request. More...
 
IList< string > GetPairValues (string key)
 Returns a list of values from the key-value pair collection associated with specified key. More...
 
IList< string > SetPair (string key, params string[] values)
 Sets key-value pair to the key-value pair collection of the POST request. If such a key already exist, it will be replaced. More...
 
IList< string > RemovePair (string key)
 Removes key-value pair with associated key from the key-value pair collection of the POST request. More...
 
void RemoveAllPairs ()
 Removes all pairs from the key-value pair collection of the POST request. More...
 
override int GetHashCode ()
 Serves as a hash function for a particular type. More...
 
override bool Equals (object obj)
 Determines whether the specified FormData is equal to the current FormData. More...
 

Properties

override PostDataContentType ContentType [get]
 Gets content type of POST data. More...
 
- Properties inherited from DotNetBrowser.FormData
virtual PostDataContentType ContentType [get]
 Gets content type of POST data. More...
 
- Properties inherited from DotNetBrowser.PostData
PostDataContentType ContentType [get]
 Gets content type of POST data. More...
 

Detailed Description

Represents POST data parameters if the Content-Type is multipart/form-data.

Constructor & Destructor Documentation

DotNetBrowser.MultipartFormData.MultipartFormData ( )

Constructs a new MultipartFormData instance.

DotNetBrowser.MultipartFormData.MultipartFormData ( IDictionary< string, IList< string >>  keyValuePairs,
IDictionary< string, IList< string >>  fileList 
)

Constructs a new MultipartFormData instance with specified parameters.

Parameters
keyValuePairsAll keys from the key-value pair collection of the POST request.
fileListThe file list of the POST request.

Member Function Documentation

override bool DotNetBrowser.MultipartFormData.Equals ( object  obj)

Determines whether the specified MultipartFormData is equal to the current MultipartFormData.

Parameters
objThe object to compare with the current MultipartFormData object.
Returns
true if the specified object is equal to the current MultipartFormData object; otherwise, false.
ICollection<string> DotNetBrowser.MultipartFormData.GetFileKeys ( )

Returns all file keys from the file list of the POST request.

Returns
all file keys from the file list of the POST request.
IList<string> DotNetBrowser.MultipartFormData.GetFiles ( string  key)

Returns a list of file paths from the file list associated with specified key.

Parameters
keythe key.
Returns
a list of file paths from the file list associated with specified key.
override int DotNetBrowser.MultipartFormData.GetHashCode ( )

Serves as a hash function for a particular type.

Returns
A hash code for the current MultipartFormData.
void DotNetBrowser.MultipartFormData.RemoveAllFilePairs ( )

Removes all files from the file list of the POST request.

IList<string> DotNetBrowser.MultipartFormData.RemoveFilePair ( string  key)

Removes the file with associated key from the file list of the POST request.

Parameters
keythe key.
Returns
the previous file list associated with the key, or null if there was no mapping for key.
IList<string> DotNetBrowser.MultipartFormData.SetFilePair ( string  key,
params string[]  files 
)

Sets key-value pair to the file list of the POST request. If such a key already exist, it will be replaced.

Parameters
keythe key.
filesthe file.
Returns
the previous file list associated with key, or null if there was no mapping for key.

Property Documentation

override PostDataContentType DotNetBrowser.MultipartFormData.ContentType
get

Gets content type of POST data.