CleanContent::OptionSet Class Reference

A type-safe collection of option/value pairs. This class acts as the basis for setting, getting, saving and loading parameters to all Clean Content APIs. More specifically is acts as a base class for the SecureRequest class. More...

Inheritance diagram for CleanContent::OptionSet:
CleanContent::ConcreteOptionSet CleanContent::SecureRequest

List of all members.

Public Member Functions

ScrubOption.Action GetOption (ScrubOption op)
 Get a scrub target option.
AnalyzeOption.Action GetOption (AnalyzeOption op)
 Get an analyze target option.
DirectoryInfo GetOption (DirectoryOption op)
 Get a directory option.
FileInfo GetOption (FileOption op)
 Get a file option using a FileInfo object.
String[] GetOption (StringListOption op)
 Get a string list option.
String GetOption (StringOption op)
 Get a string option.
FileFormat[] GetOption (FileFormatListOption op)
 Get a file format list option.
FileFormat GetOption (FileFormatOption op)
 Get a file format option.
int GetOption (EnumOption op)
 Get an enumeration option.
long GetOption (IntegerOption op)
 Get an integer option.
bool GetOption (BooleanOption op)
 Get a boolean option.
void ReadXML (FileInfo file)
 Read the current option set from an XML file created using WriteXML.
void SetOption (HandlerOption op, ElementHandler handler)
 Set an element handler option.
void SetOption (ScrubOption op, ScrubOption.Action value)
 Set a scrub target option.
void SetOption (AnalyzeOption op, AnalyzeOption.Action value)
 Set an analyze target option.
void SetOption (DirectoryOption op, DirectoryInfo value)
 Set a directory option.
void SetOption (FileOption op, Stream value)
 Set a file option using a Stream object.
void SetOption (FileOption op, FileInfo value)
 Set a file option using a FileInfo object.
void SetOption (DurationOption op, TimeSpan value)
 Set a duration option using a TimeSpan object.
void SetOption (DateOption op, DateTime value)
 Set a date option using a DateTime object.
void SetOption (StringListOption op, String[] values)
 Set a string list option.
void SetOption (StringOption op, String value)
 Set a string option.
void SetOption (FileFormatListOption op, FileFormat[] values)
 Set a file format list option.
void SetOption (FileFormatOption op, FileFormat value)
 Set a file format option.
void SetOption (EnumListOption op, int[] values)
 Set an enumeration list option.
void SetOption (EnumOption op, int value)
 Set an enumeration option.
void SetOption (IntegerOption op, long value)
 Set an integer option.
void SetOption (BooleanOption op, bool value)
 Set a boolean option.
void WriteXML (FileInfo file)
 Write the current option set to an XML file.

Detailed Description

A type-safe collection of option/value pairs. This class acts as the basis for setting, getting, saving and loading parameters to all Clean Content APIs. More specifically is acts as a base class for the SecureRequest class.

Member Function Documentation

ScrubOption.Action CleanContent::OptionSet::GetOption ( ScrubOption  op  ) 

Get a scrub target option.

Parameters:
op The option to set
Returns:
The value of the option
AnalyzeOption.Action CleanContent::OptionSet::GetOption ( AnalyzeOption  op  ) 

Get an analyze target option.

Parameters:
op The option to get
Returns:
The value of the option
DirectoryInfo CleanContent::OptionSet::GetOption ( DirectoryOption  op  ) 

Get a directory option.

Parameters:
op The option to get
Returns:
The value of the option
FileInfo CleanContent::OptionSet::GetOption ( FileOption  op  ) 

Get a file option using a FileInfo object.

Parameters:
op The option to get
Returns:
The value of the option
String [] CleanContent::OptionSet::GetOption ( StringListOption  op  ) 

Get a string list option.

Parameters:
op The option to get
Returns:
The value of the option
String CleanContent::OptionSet::GetOption ( StringOption  op  ) 

Get a string option.

Parameters:
op The option to get
Returns:
The value of the option
FileFormat [] CleanContent::OptionSet::GetOption ( FileFormatListOption  op  ) 

Get a file format list option.

Parameters:
op The option to get
Returns:
The value of the option
FileFormat CleanContent::OptionSet::GetOption ( FileFormatOption  op  ) 

Get a file format option.

Parameters:
op The option to get
Returns:
The value of the option
int CleanContent::OptionSet::GetOption ( EnumOption  op  ) 

Get an enumeration option.

Parameters:
op The option to get
Returns:
The value of the option
long CleanContent::OptionSet::GetOption ( IntegerOption  op  ) 

Get an integer option.

Parameters:
op The option to set
Returns:
The value of the option
bool CleanContent::OptionSet::GetOption ( BooleanOption  op  ) 

Get a boolean option.

Parameters:
op The option to get
Returns:
The value of the option
void CleanContent::OptionSet::ReadXML ( FileInfo  file  ) 

Read the current option set from an XML file created using WriteXML.

Parameters:
file File to read
void CleanContent::OptionSet::SetOption ( HandlerOption  op,
ElementHandler  handler 
)

Set an element handler option.

Parameters:
op The option to set
handler The value the option should take
void CleanContent::OptionSet::SetOption ( ScrubOption  op,
ScrubOption.Action  value 
)

Set a scrub target option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( AnalyzeOption  op,
AnalyzeOption.Action  value 
)

Set an analyze target option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( DirectoryOption  op,
DirectoryInfo  value 
)

Set a directory option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( FileOption  op,
Stream  value 
)

Set a file option using a Stream object.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( FileOption  op,
FileInfo  value 
)

Set a file option using a FileInfo object.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( DurationOption  op,
TimeSpan  value 
)

Set a duration option using a TimeSpan object.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( DateOption  op,
DateTime  value 
)

Set a date option using a DateTime object.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( StringListOption  op,
String[]  values 
)

Set a string list option.

Parameters:
op The option to set
values The value the option should take
void CleanContent::OptionSet::SetOption ( StringOption  op,
String  value 
)

Set a string option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( FileFormatListOption  op,
FileFormat[]  values 
)

Set a file format list option.

Parameters:
op The option to set
values The value the option should take
void CleanContent::OptionSet::SetOption ( FileFormatOption  op,
FileFormat  value 
)

Set a file format option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( EnumListOption  op,
int[]  values 
)

Set an enumeration list option.

Parameters:
op The option to set
values The values the option should take
void CleanContent::OptionSet::SetOption ( EnumOption  op,
int  value 
)

Set an enumeration option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( IntegerOption  op,
long  value 
)

Set an integer option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::SetOption ( BooleanOption  op,
bool  value 
)

Set a boolean option.

Parameters:
op The option to set
value The value the option should take
void CleanContent::OptionSet::WriteXML ( FileInfo  file  ) 

Write the current option set to an XML file.

Parameters:
file File to write
The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Properties
Clean Content .NET API 8.5.6.01.211123 documentation generated on Tue Nov 23 02:28:42 2021 by Doxygen 1.6.3