Class Options

Namespace

iText.Kernel.XMP.Options

Assembly

itext.kernel.dll

The base class for a collection of 32 flag bits.

public abstract class Options

Inheritance

object

Options

Derived

AliasOptions

IteratorOptions

ParseOptions

PropertyOptions

SerializeOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

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.

Constructors

Options()

The default constructor.

public Options()

Options(int)

Constructor with the options bit mask.

public Options(int options)

Parameters

options int

the options bit mask

Methods

AssertConsistency(int)

The inheriting option class can do additional checks on the options.

protected virtual void AssertConsistency(int options)

Parameters

options int

the bitmask to check.

Remarks

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).

Clear()

Resets the options.

public virtual void Clear()

ContainsAllOptions(int)

public virtual bool ContainsAllOptions(int optionBits)

Parameters

optionBits int

an option bitmask

Returns

bool

Returns true, if this object contains all given options.

ContainsOneOf(int)

public virtual bool ContainsOneOf(int optionBits)

Parameters

optionBits int

an option bitmask

Returns

bool

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

DefineOptionName(int)

To be implemeted by inheritants.

protected abstract string DefineOptionName(int option)

Parameters

option int

a single, valid option bit.

Returns

string

Returns a human readable name for an option bit.

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

See Also

Equals(object)

GetHashCode()

public override int GetHashCode()

Returns

int

See Also

GetHashCode()

GetOption(int)

protected virtual bool GetOption(int optionBit)

Parameters

optionBit int

the binary bit or bits that are requested

Returns

bool

Returns if all of the requested bits are set or not.

GetOptions()

Is friendly to access it during the tests.

public virtual int GetOptions()

Returns

int

Returns the options.

GetOptionsString()

Creates a human readable string from the set options.

public virtual string GetOptionsString()

Returns

string

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

Remarks

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

GetValidOptions()

To be implemeted by inheritants.

protected abstract int GetValidOptions()

Returns

int

Returns a bit mask where all valid option bits are set.

IsExactly(int)

public virtual bool IsExactly(int optionBits)

Parameters

optionBits int

an option bitmask

Returns

bool

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

SetOption(int, bool)

public virtual void SetOption(int optionBits, bool value)

Parameters

optionBits int

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

value bool

the boolean value to set

SetOptions(int)

public virtual void SetOptions(int options)

Parameters

options int

The options to set.

ToString()

public override string ToString()

Returns

string

Returns the options as hex bitmask.