The property flags are used when properties are fetched from the More...

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

Public Member Functions
	PropertyOptions ()
	Default constructor More...

	PropertyOptions (int options)
	Intialization constructor More...

bool	IsURI ()

iText.Kernel.XMP.Options.PropertyOptions	SetURI (bool value)

bool	GetHasQualifiers ()

iText.Kernel.XMP.Options.PropertyOptions	SetHasQualifiers (bool value)

bool	IsQualifier ()

iText.Kernel.XMP.Options.PropertyOptions	SetQualifier (bool value)

bool	GetHasLanguage ()
	Returns Return whether this property has an `xml:lang` qualifier.

iText.Kernel.XMP.Options.PropertyOptions	SetHasLanguage (bool value)

bool	GetHasType ()
	Returns Return whether this property has an `rdf:type` qualifier.

iText.Kernel.XMP.Options.PropertyOptions	SetHasType (bool value)

bool	IsStruct ()
	Returns Return whether this property contains nested fields.

iText.Kernel.XMP.Options.PropertyOptions	SetStruct (bool value)

bool	IsArray ()

iText.Kernel.XMP.Options.PropertyOptions	SetArray (bool value)

bool	IsArrayOrdered ()

iText.Kernel.XMP.Options.PropertyOptions	SetArrayOrdered (bool value)

bool	IsArrayAlternate ()

iText.Kernel.XMP.Options.PropertyOptions	SetArrayAlternate (bool value)

bool	IsArrayAltText ()

iText.Kernel.XMP.Options.PropertyOptions	SetArrayAltText (bool value)

bool	IsSchemaNode ()
	Returns Returns whether the SCHEMA_NODE option is set.

iText.Kernel.XMP.Options.PropertyOptions	SetSchemaNode (bool value)

bool	IsCompositeProperty ()
	Returns Returns whether the property is of composite type - an array or a struct.

bool	IsSimple ()
	Returns Returns whether the property is of composite type - an array or a struct.

bool	EqualArrayTypes (iText.Kernel.XMP.Options.PropertyOptions options)
	Compares two options set for array compatibility. More...

void	MergeWith (iText.Kernel.XMP.Options.PropertyOptions options)
	Merges the set options of a another options object with this. More...

bool	IsOnlyArrayOptions ()
	Returns Returns true if only array options are set.

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)

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	NO_OPTIONS = 0x00000000

const int	URI = 0x00000002

const int	HAS_QUALIFIERS = 0x00000010

const int	QUALIFIER = 0x00000020

const int	HAS_LANGUAGE = 0x00000040

const int	HAS_TYPE = 0x00000080

const int	STRUCT = 0x00000100

const int	ARRAY = 0x00000200

const int	ARRAY_ORDERED = 0x00000400

const int	ARRAY_ALTERNATE = 0x00000800

const int	ARRAY_ALT_TEXT = 0x00001000

const int	SCHEMA_NODE = unchecked((int)(0x80000000))

const int	DELETE_EXISTING = 0x20000000
	may be used in the future More...

const int	SEPARATE_NODE = 0x40000000
	Updated by iText. More...

Detailed Description

The property flags are used when properties are fetched from the

XMPMeta-object and provide more detailed information about the property.

03.07.2006

Constructor & Destructor Documentation

◆ PropertyOptions() [1/2]

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

inline

Default constructor

◆ PropertyOptions() [2/2]

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

inline

Intialization constructor

Parameters

options the initialization options

Exceptions

iText.Kernel.XMP.XMPException If the options are not valid

Member Function Documentation

◆ EqualArrayTypes()

bool iText.Kernel.XMP.Options.PropertyOptions.EqualArrayTypes ( iText.Kernel.XMP.Options.PropertyOptions options )

inline

Compares two options set for array compatibility.

Parameters

options other options

Returns: Returns true if the array options of the sets are equal.

◆ GetHasQualifiers()

bool iText.Kernel.XMP.Options.PropertyOptions.GetHasQualifiers ( )

inline

Returns: Return whether the property has qualifiers. These could be an xml:lang attribute, an rdf:type property, or a general qualifier. See the introductory discussion of qualified properties for more information.

◆ IsArray()

bool iText.Kernel.XMP.Options.PropertyOptions.IsArray ( )

inline

Returns: Return whether this property is an array. By itself this indicates a general unordered array. It is serialized using an rdf:Bag container.

◆ IsArrayAlternate()

bool iText.Kernel.XMP.Options.PropertyOptions.IsArrayAlternate ( )

inline

Returns: Return whether this property is an alternative array. Appears in conjunction with getPropValueIsArray(). It is serialized using an rdf:Alt container.

◆ IsArrayAltText()

bool iText.Kernel.XMP.Options.PropertyOptions.IsArrayAltText ( )

inline

Returns: Return whether this property is an alt-text array. Appears in conjunction with getPropArrayIsAlternate(). It is serialized using an rdf:Alt container. Each array element is a simple property with an xml:lang attribute.

◆ IsArrayOrdered()

bool iText.Kernel.XMP.Options.PropertyOptions.IsArrayOrdered ( )

inline

Returns: Return whether this property is an ordered array. Appears in conjunction with getPropValueIsArray(). It is serialized using an rdf:Seq container.

◆ IsQualifier()

bool iText.Kernel.XMP.Options.PropertyOptions.IsQualifier ( )

inline

Returns: Return whether this property is a qualifier for some other property. Note that if the qualifier itself has a structured value, this flag is only set for the top node of the qualifier's subtree. Qualifiers may have arbitrary structure, and may even have qualifiers.

◆ IsURI()

bool iText.Kernel.XMP.Options.PropertyOptions.IsURI ( )

inline

Returns: Return whether the property value is a URI. It is serialized to RDF using the rdf:resource attribute. Not mandatory for URIs, but considered RDF-savvy.

◆ MergeWith()

void iText.Kernel.XMP.Options.PropertyOptions.MergeWith ( iText.Kernel.XMP.Options.PropertyOptions options )

inline

Merges the set options of a another options object with this.

Merges the set options of a another options object with this. If the other options set is null, this objects stays the same.

Parameters

options other options

Exceptions

iText.Kernel.XMP.XMPException If illegal options are provided

◆ SetArray()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetArray ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetArrayAlternate()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetArrayAlternate ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetArrayAltText()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetArrayAltText ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetArrayOrdered()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetArrayOrdered ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetHasLanguage()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetHasLanguage ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetHasQualifiers()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetHasQualifiers ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetHasType()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetHasType ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetQualifier()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetQualifier ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetSchemaNode()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetSchemaNode ( bool value )

inline

Parameters

value the option DELETE_EXISTING to set

Returns: Returns this to enable cascaded options.

◆ SetStruct()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetStruct ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

◆ SetURI()

iText.Kernel.XMP.Options.PropertyOptions iText.Kernel.XMP.Options.PropertyOptions.SetURI ( bool value )

inline

Parameters

value the value to set

Returns: Returns this to enable cascaded options.

Member Data Documentation

◆ DELETE_EXISTING

const int iText.Kernel.XMP.Options.PropertyOptions.DELETE_EXISTING = 0x20000000

static

may be used in the future

◆ SEPARATE_NODE

const int iText.Kernel.XMP.Options.PropertyOptions.SEPARATE_NODE = 0x40000000

static

Updated by iText.

Updated by iText. Indicates if the property should be writted as a separate node

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PropertyOptions() [1/2]

◆ PropertyOptions() [2/2]

Member Function Documentation

◆ EqualArrayTypes()

◆ GetHasQualifiers()

◆ IsArray()

◆ IsArrayAlternate()

◆ IsArrayAltText()

◆ IsArrayOrdered()

◆ IsQualifier()

◆ IsURI()

◆ MergeWith()

◆ SetArray()

◆ SetArrayAlternate()

◆ SetArrayAltText()

◆ SetArrayOrdered()

◆ SetHasLanguage()

◆ SetHasQualifiers()

◆ SetHasType()

◆ SetQualifier()

◆ SetSchemaNode()

◆ SetStruct()

◆ SetURI()

Member Data Documentation

◆ DELETE_EXISTING

◆ SEPARATE_NODE