Skip to main content
Skip table of contents

XmpOptions

XmpOptions Public class

Description

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

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph iTextSharp.xmp.options
  iTextSharp.xmp.options.XmpOptions[[XmpOptions]]
  class iTextSharp.xmp.options.XmpOptions abstractStyle;
  end

Members

Properties

Public properties
TypeNameMethods
uintOptions
Is friendly to access it during the tests.
get, set
stringOptionsString
Creates a human readable string from the set options. Note: This method is quite
expensive and should only be used within tests or as
get
Protected internal properties
TypeNameMethods
uintValidOptions
To be implemeted by inheritants.
get

Methods

Public methods
ReturnsName
voidClear()
Resets the options.
boolContainsAllOptions(uint optionBits)
boolContainsOneOf(uint optionBits)
boolEquals(object obj)
intGetHashCode()
boolIsExactly(uint optionBits)
voidSetOption(uint optionBits, bool value)
stringToString()
Protected internal methods
ReturnsName
voidAssertConsistency(uint options)
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).
stringDefineOptionName(uint option)
To be implemeted by inheritants.
boolGetOption(uint optionBit)

Details

Summary

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

Constructors

XmpOptions [1/2]

Source code

protected XmpOptions()
Summary

The default constructor.

XmpOptions [2/2]

Source code

public XmpOptions(uint options)
Arguments
TypeNameDescription
uintoptionsthe options bit mask
Summary

Constructor with the options bit mask.

Exceptions
NameDescription
XmpExceptionIf the options are not correct

Methods

Clear

Source code

public virtual void Clear()
Summary

Resets the options.

IsExactly

Source code

public virtual bool IsExactly(uint optionBits)
Arguments
TypeNameDescription
uintoptionBitsan option bitmask
Returns

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

ContainsAllOptions

Source code

public virtual bool ContainsAllOptions(uint optionBits)
Arguments
TypeNameDescription
uintoptionBitsan option bitmask
Returns

Returns true, if this object contains all given options.

ContainsOneOf

Source code

public virtual bool ContainsOneOf(uint optionBits)
Arguments
TypeNameDescription
uintoptionBitsan option bitmask
Returns

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

GetOption

Source code

protected internal virtual bool GetOption(uint optionBit)
Arguments
TypeNameDescription
uintoptionBitthe binary bit or bits that are requested
Returns

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

SetOption

Source code

public virtual void SetOption(uint optionBits, bool value)
Arguments
TypeNameDescription
uintoptionBitsthe binary bit or bits that shall be set to the given value
boolvaluethe boolean value to set
Equals

Source code

public override bool Equals(object obj)
Arguments
TypeNameDescription
objectobj
GetHashCode

Source code

public override int GetHashCode()
ToString

Source code

public override string ToString()
Returns

Returns the options as hex bitmask.

DefineOptionName
protected internal abstract string DefineOptionName(uint option)
Arguments
TypeNameDescription
uintoptiona single, valid option bit.
Summary

To be implemeted by inheritants.

Returns

Returns a human readable name for an option bit.

AssertConsistency

Source code

protected internal virtual void AssertConsistency(uint options)
Arguments
TypeNameDescription
uintoptionsthe bitmask to check.
Summary

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

Exceptions
NameDescription
XmpExceptionThrown if the options are not consistent.

Properties

Options
public virtual uint Options { get; set; }
Summary

Is friendly to access it during the tests.

OptionsString
public virtual string OptionsString { get; }
Summary

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

ValidOptions
protected internal abstract uint ValidOptions { get; }
Summary

To be implemeted by inheritants.

Generated with ModularDoc

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.