Class PropertyOptions

Namespace

iText.Kernel.XMP.Options

Assembly

itext.kernel.dll

The property flags are used when properties are fetched from the XMPMeta-object and provide more detailed information about the property.

public sealed class PropertyOptions : Options

Inheritance

object

Options

PropertyOptions

Inherited Members

Options.Clear()

Options.IsExactly(int)

Options.ContainsAllOptions(int)

Options.ContainsOneOf(int)

Options.SetOption(int, bool)

Options.GetOptions()

Options.SetOptions(int)

Options.Equals(object)

Options.GetHashCode()

Options.GetOptionsString()

Options.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

PropertyOptions()

Default constructor

public PropertyOptions()

PropertyOptions(int)

Intialization constructor

public PropertyOptions(int options)

Parameters

options int

the initialization options

Fields

ARRAY

public const int ARRAY = 512

Field Value

int

ARRAY_ALTERNATE

public const int ARRAY_ALTERNATE = 2048

Field Value

int

ARRAY_ALT_TEXT

public const int ARRAY_ALT_TEXT = 4096

Field Value

int

ARRAY_ORDERED

public const int ARRAY_ORDERED = 1024

Field Value

int

DELETE_EXISTING

may be used in the future

public const int DELETE_EXISTING = 536870912

Field Value

int

HAS_LANGUAGE

public const int HAS_LANGUAGE = 64

Field Value

int

HAS_QUALIFIERS

public const int HAS_QUALIFIERS = 16

Field Value

int

HAS_TYPE

public const int HAS_TYPE = 128

Field Value

int

NO_OPTIONS

public const int NO_OPTIONS = 0

Field Value

int

QUALIFIER

public const int QUALIFIER = 32

Field Value

int

SCHEMA_NODE

public const int SCHEMA_NODE = -2147483648

Field Value

int

SEPARATE_NODE

Updated by iText.

public const int SEPARATE_NODE = 1073741824

Field Value

int

Remarks

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

STRUCT

public const int STRUCT = 256

Field Value

int

URI

public const int URI = 2

Field Value

int

Methods

AssertConsistency(int)

Checks that a node not a struct and array at the same time; and URI cannot be a struct.

protected override void AssertConsistency(int options)

Parameters

options int

the bitmask to check.

DefineOptionName(int)

protected override string DefineOptionName(int option)

Parameters

option int

Returns

string

See Also

DefineOptionName(int)

EqualArrayTypes(PropertyOptions)

Compares two options set for array compatibility.

public bool EqualArrayTypes(PropertyOptions options)

Parameters

options PropertyOptions

other options

Returns

bool

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

GetHasLanguage()

public bool GetHasLanguage()

Returns

bool

Return whether this property has an xml:lang qualifier.

GetHasQualifiers()

public bool GetHasQualifiers()

Returns

bool

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.

GetHasType()

public bool GetHasType()

Returns

bool

Return whether this property has an rdf:type qualifier.

GetValidOptions()

protected override int GetValidOptions()

Returns

int

See Also

GetValidOptions()

IsArray()

public bool IsArray()

Returns

bool

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

IsArrayAltText()

public bool IsArrayAltText()

Returns

bool

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.

IsArrayAlternate()

public bool IsArrayAlternate()

Returns

bool

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

IsArrayOrdered()

public bool IsArrayOrdered()

Returns

bool

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

IsCompositeProperty()

public bool IsCompositeProperty()

Returns

bool

Returns whether the property is of composite type - an array or a struct.

IsOnlyArrayOptions()

public bool IsOnlyArrayOptions()

Returns

bool

Returns true if only array options are set.

IsQualifier()

public bool IsQualifier()

Returns

bool

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.

IsSchemaNode()

public bool IsSchemaNode()

Returns

bool

Returns whether the SCHEMA_NODE option is set.

IsSimple()

public bool IsSimple()

Returns

bool

Returns whether the property is of composite type - an array or a struct.

IsStruct()

public bool IsStruct()

Returns

bool

Return whether this property contains nested fields.

IsURI()

public bool IsURI()

Returns

bool

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(PropertyOptions)

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

public void MergeWith(PropertyOptions options)

Parameters

options PropertyOptions

other options

Remarks

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

SetArray(bool)

public PropertyOptions SetArray(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetArrayAltText(bool)

public PropertyOptions SetArrayAltText(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetArrayAlternate(bool)

public PropertyOptions SetArrayAlternate(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetArrayOrdered(bool)

public PropertyOptions SetArrayOrdered(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetHasLanguage(bool)

public PropertyOptions SetHasLanguage(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetHasQualifiers(bool)

public PropertyOptions SetHasQualifiers(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetHasType(bool)

public PropertyOptions SetHasType(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetQualifier(bool)

public PropertyOptions SetQualifier(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetSchemaNode(bool)

public PropertyOptions SetSchemaNode(bool value)

Parameters

value bool

the option DELETE_EXISTING to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetStruct(bool)

public PropertyOptions SetStruct(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.

SetURI(bool)

public PropertyOptions SetURI(bool value)

Parameters

value bool

the value to set

Returns

PropertyOptions

Returns this to enable cascaded options.