iText 7 7.1.9 API
iText.Kernel.XMP.Options.SerializeOptions Class Reference

Options for <see cref="iText.Kernel.XMP.XMPMetaFactory.SerializeToBuffer(iText.Kernel.XMP.XMPMeta, SerializeOptions)"/ > More...

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

Public Member Functions

  SerializeOptions ()
  Default constructor. More...
 
  SerializeOptions (int options)
  Constructor using inital options More...
 
bool  GetOmitPacketWrapper ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetOmitPacketWrapper (bool value)
 
bool  GetOmitXmpMetaElement ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetOmitXmpMetaElement (bool value)
 
bool  GetReadOnlyPacket ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetReadOnlyPacket (bool value)
 
bool  GetUseCompactFormat ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetUseCompactFormat (bool value)
 
bool  GetUseCanonicalFormat ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetUseCanonicalFormat (bool value)
 
bool  GetIncludeThumbnailPad ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetIncludeThumbnailPad (bool value)
 
bool  GetExactPacketLength ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetExactPacketLength (bool value)
 
bool  GetSort ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetSort (bool value)
 
bool  GetEncodeUTF16BE ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetEncodeUTF16BE (bool value)
 
bool  GetEncodeUTF16LE ()
 
Returns
Returns the option.

 
iText.Kernel.XMP.Options.SerializeOptions  SetEncodeUTF16LE (bool value)
 
int  GetBaseIndent ()
 
Returns
Returns the baseIndent.

 
iText.Kernel.XMP.Options.SerializeOptions  SetBaseIndent (int baseIndent)
 
String  GetIndent ()
 
Returns
Returns the indent.

 
iText.Kernel.XMP.Options.SerializeOptions  SetIndent (String indent)
 
String  GetNewline ()
 
Returns
Returns the newline.

 
iText.Kernel.XMP.Options.SerializeOptions  SetNewline (String newline)
 
int  GetPadding ()
 
Returns
Returns the padding.

 
iText.Kernel.XMP.Options.SerializeOptions  SetPadding (int padding)
 
bool  GetOmitVersionAttribute ()
 
String  GetEncoding ()
 
Returns
Returns the encoding as Java encoding String.

 
Object  Clone ()
 
Returns
Returns clone of this SerializeOptions-object with the same options 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)
 
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  OMIT_PACKET_WRAPPER = 0x0010
  Omit the XML packet wrapper. More...
 
const int  READONLY_PACKET = 0x0020
  Mark packet as read-only. More...
 
const int  USE_COMPACT_FORMAT = 0x0040
  Use a compact form of RDF. More...
 
const int  USE_CANONICAL_FORMAT = 0x0080
  Use the canonical form of RDF if set. More...
 
const int  INCLUDE_THUMBNAIL_PAD = 0x0100
  Include a padding allowance for a thumbnail image. More...
 
const int  EXACT_PACKET_LENGTH = 0x0200
  The padding parameter provides the overall packet length. More...
 
const int  OMIT_XMPMETA_ELEMENT = 0x1000
  Omit the <x:xmpmeta>-tag More...
 
const int  SORT = 0x2000
  Sort the struct properties and qualifier before serializing More...
 
const int  ENCODE_UTF8 = 0
  UTF8 encoding; this is the default More...
 
const int  ENCODE_UTF16BE = UTF16_BIT
  UTF16BE encoding More...
 
const int  ENCODE_UTF16LE = UTF16_BIT | LITTLEENDIAN_BIT
  UTF16LE encoding More...
 

Detailed Description

Options for <see cref="iText.Kernel.XMP.XMPMetaFactory.SerializeToBuffer(iText.Kernel.XMP.XMPMeta, SerializeOptions)"/ >

<since>24.01.2006</since>

Constructor & Destructor Documentation

◆ SerializeOptions() [1/2]

iText.Kernel.XMP.Options.SerializeOptions.SerializeOptions ( )
inline

Default constructor.

◆ SerializeOptions() [2/2]

iText.Kernel.XMP.Options.SerializeOptions.SerializeOptions ( int  options )
inline

Constructor using inital options

Parameters
options the inital options

Member Function Documentation

◆ GetOmitVersionAttribute()

bool iText.Kernel.XMP.Options.SerializeOptions.GetOmitVersionAttribute ( )
inline
Returns
Returns whether the Toolkit version attribute shall be omitted. Note: This options can only be set by unit tests.

◆ SetBaseIndent()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetBaseIndent ( int  baseIndent )
inline
Parameters
baseIndent The baseIndent to set.
Returns
Returns the instance to call more set-methods.

◆ SetEncodeUTF16BE()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetEncodeUTF16BE ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetEncodeUTF16LE()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetEncodeUTF16LE ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetExactPacketLength()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetExactPacketLength ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetIncludeThumbnailPad()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetIncludeThumbnailPad ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetIndent()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetIndent ( String  indent )
inline
Parameters
indent The indent to set.
Returns
Returns the instance to call more set-methods.

◆ SetNewline()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetNewline ( String  newline )
inline
Parameters
newline The newline to set.
Returns
Returns the instance to call more set-methods.

◆ SetOmitPacketWrapper()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetOmitPacketWrapper ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetOmitXmpMetaElement()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetOmitXmpMetaElement ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetPadding()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetPadding ( int  padding )
inline
Parameters
padding The padding to set.
Returns
Returns the instance to call more set-methods.

◆ SetReadOnlyPacket()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetReadOnlyPacket ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetSort()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetSort ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetUseCanonicalFormat()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetUseCanonicalFormat ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

◆ SetUseCompactFormat()

iText.Kernel.XMP.Options.SerializeOptions iText.Kernel.XMP.Options.SerializeOptions.SetUseCompactFormat ( bool  value )
inline
Parameters
value the value to set
Returns
Returns the instance to call more set-methods.

Member Data Documentation

◆ ENCODE_UTF16BE

const int iText.Kernel.XMP.Options.SerializeOptions.ENCODE_UTF16BE = UTF16_BIT
static

UTF16BE encoding

◆ ENCODE_UTF16LE

const int iText.Kernel.XMP.Options.SerializeOptions.ENCODE_UTF16LE = UTF16_BIT | LITTLEENDIAN_BIT
static

UTF16LE encoding

◆ ENCODE_UTF8

const int iText.Kernel.XMP.Options.SerializeOptions.ENCODE_UTF8 = 0
static

UTF8 encoding; this is the default

◆ EXACT_PACKET_LENGTH

const int iText.Kernel.XMP.Options.SerializeOptions.EXACT_PACKET_LENGTH = 0x0200
static

The padding parameter provides the overall packet length.

The padding parameter provides the overall packet length. The actual amount of padding is computed. An exception is thrown if the packet exceeds this length with no padding.

◆ INCLUDE_THUMBNAIL_PAD

const int iText.Kernel.XMP.Options.SerializeOptions.INCLUDE_THUMBNAIL_PAD = 0x0100
static

Include a padding allowance for a thumbnail image.

Include a padding allowance for a thumbnail image. If no xmp:Thumbnails property is present, the typical space for a JPEG thumbnail is used.

◆ OMIT_PACKET_WRAPPER

const int iText.Kernel.XMP.Options.SerializeOptions.OMIT_PACKET_WRAPPER = 0x0010
static

Omit the XML packet wrapper.

◆ OMIT_XMPMETA_ELEMENT

const int iText.Kernel.XMP.Options.SerializeOptions.OMIT_XMPMETA_ELEMENT = 0x1000
static

Omit the <x:xmpmeta>-tag

◆ READONLY_PACKET

const int iText.Kernel.XMP.Options.SerializeOptions.READONLY_PACKET = 0x0020
static

Mark packet as read-only.

Mark packet as read-only. Default is a writeable packet.

◆ SORT

const int iText.Kernel.XMP.Options.SerializeOptions.SORT = 0x2000
static

Sort the struct properties and qualifier before serializing

◆ USE_CANONICAL_FORMAT

const int iText.Kernel.XMP.Options.SerializeOptions.USE_CANONICAL_FORMAT = 0x0080
static

Use the canonical form of RDF if set.

Use the canonical form of RDF if set. By default the compact form is used

◆ USE_COMPACT_FORMAT

const int iText.Kernel.XMP.Options.SerializeOptions.USE_COMPACT_FORMAT = 0x0040
static

Use a compact form of RDF.

Use a compact form of RDF. The compact form is the default serialization format (this flag is technically ignored). To serialize to the canonical form, set the flag USE_CANONICAL_FORMAT. If both flags "compact" and "canonical" are set, canonical is used.