iText.Kernel.XMP.Options.IteratorOptions Class Reference

Options for XMPIterator construction. More...

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

Public Member Functions
IteratorOptions	SetJustChildren (bool value)
	Omit all qualifiers. More...
IteratorOptions	SetJustLeafname (bool value)
	Sets the option and returns the instance. More...
IteratorOptions	SetJustLeafnodes (bool value)
	Sets the option and returns the instance. More...
IteratorOptions	SetOmitQualifiers (bool value)
	Sets the option and returns the instance. More...
Public Member Functions inherited from iText.Kernel.XMP.Options.Options
	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.

Static Public Attributes
const int	JUST_CHILDREN = 0x0100
	Just do the immediate children of the root, default is subtree. More...
const int	JUST_LEAFNODES = 0x0200
	Just do the leaf nodes, default is all nodes in the subtree. More...
const int	JUST_LEAFNAME = 0x0400
	Return just the leaf part of the path, default is the full path. More...

Package Functions
override String	DefineOptionName (int option)
	See also Options.DefineOptionName(int)
override int	GetValidOptions ()
	See also Options.GetValidOptions()
Package Functions inherited from iText.Kernel.XMP.Options.Options
virtual bool	GetOption (int optionBit)
virtual void	AssertConsistency (int options)
	The inheriting option class can do additional checks on the options. More...

Detailed Description

Options for XMPIterator construction.

24.01.2006

Member Function Documentation

SetJustChildren()

IteratorOptions iText.Kernel.XMP.Options.IteratorOptions.SetJustChildren ( bool  value )

inline

Omit all qualifiers.

Include aliases, default is just actual properties. Note: Not supported.

public const int OMIT_QUALIFIERS = 0x1000;

/

Returns

Returns whether the option is set.

public bool IsJustChildren() { return GetOption(JUST_CHILDREN); }

/

Returns

Returns whether the option is set.

public bool IsJustLeafname() { return GetOption(JUST_LEAFNAME); }

/

Returns

Returns whether the option is set.

public bool IsJustLeafnodes() { return GetOption(JUST_LEAFNODES); }

/

Returns

Returns whether the option is set.

public bool IsOmitQualifiers() { return GetOption(OMIT_QUALIFIERS); }

/**

Sets the option and returns the instance.

Parameters

value

the value to set

Returns

Returns the instance to call more set-methods.

SetJustLeafname()

IteratorOptions iText.Kernel.XMP.Options.IteratorOptions.SetJustLeafname ( bool  value )

inline

Sets the option and returns the instance.

Parameters

value

the value to set

Returns

Returns the instance to call more set-methods.

SetJustLeafnodes()

IteratorOptions iText.Kernel.XMP.Options.IteratorOptions.SetJustLeafnodes ( bool  value )

inline

Sets the option and returns the instance.

Parameters

value

the value to set

Returns

Returns the instance to call more set-methods.

SetOmitQualifiers()

IteratorOptions iText.Kernel.XMP.Options.IteratorOptions.SetOmitQualifiers ( bool  value )

inline

Sets the option and returns the instance.

Parameters

value

the value to set

Returns

Returns the instance to call more set-methods.

Member Data Documentation

JUST_CHILDREN

const int iText.Kernel.XMP.Options.IteratorOptions.JUST_CHILDREN = 0x0100

static

Just do the immediate children of the root, default is subtree.

JUST_LEAFNAME

const int iText.Kernel.XMP.Options.IteratorOptions.JUST_LEAFNAME = 0x0400

static

Return just the leaf part of the path, default is the full path.

JUST_LEAFNODES

const int iText.Kernel.XMP.Options.IteratorOptions.JUST_LEAFNODES = 0x0200

static

Just do the leaf nodes, default is all nodes in the subtree.

Just do the leaf nodes, default is all nodes in the subtree. Bugfix #2658965: If this option is set the Iterator returns the namespace of the leaf instead of the namespace of the base property.