The base class for a collection of 32 flag bits. More...

Inheritance diagram for iText.Kernel.XMP.Options.Options:

Public Member Functions

Options ()

The default constructor. More...

Options (int options)

Constructor with the options bit mask. More...

virtual void Clear ()

Resets the options. More...

virtual bool IsExactly (int optionBits)

virtual bool ContainsAllOptions (int optionBits)

virtual bool ContainsOneOf (int optionBits)

virtual void SetOption (int optionBits, bool value)

virtual int GetOptions ()

Is friendly to access it during the tests. More...

virtual void SetOptions (int options)

Parameters

options The options to set.

override bool Equals (Object obj)

See also: System.Object.Equals(System.Object)

override int GetHashCode ()

See also: System.Object.GetHashCode()

virtual String GetOptionsString ()

Creates a human readable string from the set options. More...

override String ToString ()

Returns: Returns the options as hex bitmask.

Detailed Description

The base class for a collection of 32 flag bits.

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.

24.01.2006

Constructor & Destructor Documentation

◆ Options() [1/2]

iText.Kernel.XMP.Options.Options.Options ( )

inline

The default constructor.

◆ Options() [2/2]

iText.Kernel.XMP.Options.Options.Options ( int options )

inline

Constructor with the options bit mask.

Parameters

options the options bit mask

Member Function Documentation

◆ Clear()

virtual void iText.Kernel.XMP.Options.Options.Clear ( )

inlinevirtual

Resets the options.

◆ ContainsAllOptions()

virtual bool iText.Kernel.XMP.Options.Options.ContainsAllOptions ( int optionBits )

inlinevirtual

Parameters

optionBits an option bitmask

Returns: Returns true, if this object contains all given options.

◆ ContainsOneOf()

virtual bool iText.Kernel.XMP.Options.Options.ContainsOneOf ( int optionBits )

inlinevirtual

Parameters

optionBits an option bitmask

Returns: Returns true, if this object contain at least one of the given options.

◆ GetOptions()

virtual int iText.Kernel.XMP.Options.Options.GetOptions ( )

inlinevirtual

Is friendly to access it during the tests.

Returns: Returns the options.

◆ GetOptionsString()

virtual String iText.Kernel.XMP.Options.Options.GetOptionsString ( )

inlinevirtual

Creates a human readable string from the set options.

Creates a human readable string from the set options. Note: This method is quite expensive and should only be used within tests or as

Returns: Returns a String listing all options that are set to true by their name, like "option1 | option4".

◆ IsExactly()

virtual bool iText.Kernel.XMP.Options.Options.IsExactly ( int optionBits )

inlinevirtual

Parameters

optionBits an option bitmask

Returns: Returns true, if this object is equal to the given options.

◆ SetOption()

virtual void iText.Kernel.XMP.Options.Options.SetOption	(	int	optionBits,
		bool	value
	)

inlinevirtual

Parameters

optionBits	the binary bit or bits that shall be set to the given value
value	the boolean value to set