C# Class iTextSharp.xmp.options.XmpOptions

The base class for a collection of 32 flag bits. Individual flags are defined as enum value bit masks. Inheriting classes add convenience accessor methods. @since 24.01.2006

Datei anzeigen Open project: nonorganic/dssnet

Public Methods

Method	Description
Clear ( ) : void	Resets the options.
ContainsAllOptions ( uint optionBits ) : bool
ContainsOneOf ( uint optionBits ) : bool
Equals ( object obj ) : bool
GetHashCode ( ) : int
IsExactly ( uint optionBits ) : bool
SetOption ( uint optionBits, bool value ) : void
ToString ( ) : string
XmpOptions ( uint options ) : System.Collections	Constructor with the options bit mask.

Protected Methods

Method	Description
AssertConsistency ( uint options ) : void	The inheriting option class can do additional checks on the options. Note: For performance reasons this method is only called when setting bitmasks directly. When get- and set-methods are used, this method must be called manually, normally only when the Options-object has been created from a client (it has to be made public therefore).
DefineOptionName ( uint option ) : string	To be implemeted by inheritants.
GetOption ( uint optionBit ) : bool
XmpOptions ( ) : System.Collections	The default constructor.

Private Methods

Method	Description
AssertOptionsValid ( uint options ) : void	Checks options before they are set. First it is checked if only defined options are used, second the additional AssertConsistency(uint)-method is called.
GetOptionName ( uint option ) : string	Looks up or asks the inherited class for the name of an option bit. Its save that there is only one valid option handed into the method.
ProcureOptionNames ( ) : IDictionary

Method Details

AssertConsistency() protected method

The inheriting option class can do additional checks on the options. Note: For performance reasons this method is only called when setting bitmasks directly. When get- and set-methods are used, this method must be called manually, normally only when the Options-object has been created from a client (it has to be made public therefore).

Thrown if the options are not consistent.

protected AssertConsistency ( uint options ) : void
options	uint	the bitmask to check.
return	void

Clear() public method

Resets the options.

public Clear ( ) : void
return	void

ContainsAllOptions() public method

public ContainsAllOptions ( uint optionBits ) : bool
optionBits	uint	an option bitmask
return	bool

ContainsOneOf() public method

public ContainsOneOf ( uint optionBits ) : bool
optionBits	uint	an option bitmask
return	bool

DefineOptionName() protected abstract method

To be implemeted by inheritants.

protected abstract DefineOptionName ( uint option ) : string
option	uint	a single, valid option bit.
return	string

Equals() public method

public Equals ( object obj ) : bool
obj	object
return	bool

GetHashCode() public method

public GetHashCode ( ) : int
return	int

GetOption() protected method

protected GetOption ( uint optionBit ) : bool
optionBit	uint	the binary bit or bits that are requested
return	bool

IsExactly() public method

public IsExactly ( uint optionBits ) : bool
optionBits	uint	an option bitmask
return	bool

SetOption() public method

public SetOption ( uint optionBits, bool value ) : void
optionBits	uint	the binary bit or bits that shall be set to the given value
value	bool	the boolean value to set
return	void

ToString() public method

public ToString ( ) : string
return	string

XmpOptions() protected method

The default constructor.

protected XmpOptions ( ) : System.Collections
return	System.Collections

XmpOptions() public method

Constructor with the options bit mask.

If the options are not correct

public XmpOptions ( uint options ) : System.Collections
options	uint	the options bit mask
return	System.Collections