PropertyOptions
PropertyOptions Public class
Description
The property flags are used when properties are fetched from the ...
Diagram
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph iTextSharp.xmp.options
iTextSharp.xmp.options.PropertyOptions[[PropertyOptions]]
iTextSharp.xmp.options.XmpOptions[[XmpOptions]]
class iTextSharp.xmp.options.XmpOptions abstractStyle;
end
iTextSharp.xmp.options.XmpOptions --> iTextSharp.xmp.options.PropertyOptions
Members
Properties
Public properties
| Type | Name | Methods |
|---|---|---|
bool | Array | get, set |
bool | ArrayAltText | get, set |
bool | ArrayAlternate | get, set |
bool | ArrayOrdered | get, set |
bool | CompositeProperty | get |
bool | HasLanguage | get, set |
bool | HasQualifiers | get, set |
bool | HasType | get, set |
bool | OnlyArrayOptions | get |
bool | Qualifier | get, set |
bool | SchemaNode | get, set |
bool | Simple | get |
bool | Struct | get, set |
bool | Uri | get, set |
Protected internal properties
| Type | Name | Methods |
|---|---|---|
uint | ValidOptions | get |
Methods
Public methods
| Returns | Name |
|---|---|
bool | EqualArrayTypes(PropertyOptions options)Compares two options set for array compatibility. |
void | MergeWith(PropertyOptions options)Merges the set options of a another options object with this. If the other options set is null, this objects stays the same. |
Protected internal methods
| Returns | Name |
|---|---|
void | AssertConsistency(uint options)Checks that a node not a struct and array at the same time; and URI cannot be a struct. |
string | DefineOptionName(uint option) |
Details
Summary
The property flags are used when properties are fetched from the
XMPMeta
Inheritance
Constructors
PropertyOptions [1/2]
public PropertyOptions()
Summary
Default constructor
PropertyOptions [2/2]
public PropertyOptions(uint options)
Arguments
| Type | Name | Description |
|---|---|---|
uint | options | the initialization options |
Summary
Intialization constructor
Exceptions
| Name | Description |
|---|---|
| XmpException | If the options are not valid |
Methods
EqualArrayTypes
public bool EqualArrayTypes(PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
PropertyOptions | options | other options |
Summary
Compares two options set for array compatibility.
Returns
Returns true if the array options of the sets are equal.
MergeWith
public void MergeWith(PropertyOptions options)
Arguments
| Type | Name | Description |
|---|---|---|
PropertyOptions | options | other options |
Summary
Merges the set options of a another options object with this. If the other options set is null, this objects stays the same.
Exceptions
| Name | Description |
|---|---|
| XmpException | If illegal options are provided |
DefineOptionName
protected internal override string DefineOptionName(uint option)
Arguments
| Type | Name | Description |
|---|---|---|
uint | option |
AssertConsistency
protected internal override void AssertConsistency(uint options)
Arguments
| Type | Name | Description |
|---|---|---|
uint | options | the bitmask to check. |
Summary
Checks that a node not a struct and array at the same time; and URI cannot be a struct.
Exceptions
| Name | Description |
|---|---|
| XmpException | Thrown if the options are not consistent. |
Properties
Uri
public bool Uri { get; set; }
HasQualifiers
public bool HasQualifiers { get; set; }
Qualifier
public bool Qualifier { get; set; }
HasLanguage
public bool HasLanguage { get; set; }
HasType
public bool HasType { get; set; }
Struct
public bool Struct { get; set; }
Array
public bool Array { get; set; }
ArrayOrdered
public bool ArrayOrdered { get; set; }
ArrayAlternate
public bool ArrayAlternate { get; set; }
ArrayAltText
public bool ArrayAltText { get; set; }
SchemaNode
public bool SchemaNode { get; set; }
CompositeProperty
public bool CompositeProperty { get; }
Simple
public bool Simple { get; }
OnlyArrayOptions
public bool OnlyArrayOptions { get; }
ValidOptions
protected internal override uint ValidOptions { get; }
Generated with ModularDoc