iText 8.0.5 API
iText.Kernel.Pdf.Tagging.PdfUserProperty Class Reference
Inheritance diagram for iText.Kernel.Pdf.Tagging.PdfUserProperty:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Public Types

enum   ValueType { UNKNOWN, TEXT, NUMBER, BOOLEAN }
 

Public Member Functions

  PdfUserProperty (PdfDictionary pdfObject)
 
  PdfUserProperty (String name, String value)
 
  PdfUserProperty (String name, int value)
 
  PdfUserProperty (String name, float value)
 
  PdfUserProperty (String name, bool value)
 
virtual String  GetName ()
 
virtual PdfUserProperty  SetName (String name)
 
virtual PdfUserProperty.ValueType  GetValueType ()
 
virtual PdfUserProperty  SetValue (String value)
 
virtual PdfUserProperty  SetValue (int value)
 
virtual PdfUserProperty  SetValue (float value)
 
virtual PdfUserProperty  SetValue (bool value)
 
virtual String  GetValueAsText ()
 
virtual ? float  GetValueAsFloat ()
 
virtual ? bool  GetValueAsBool ()
 
virtual String  GetValueFormattedRepresentation ()
 
virtual PdfUserProperty  SetValueFormattedRepresentation (String formattedRepresentation)
 
virtual ? bool  IsHidden ()
 
virtual PdfUserProperty  SetHidden (bool isHidden)
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T  GetPdfObject ()
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document, PdfIndirectReference reference)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  SetModified ()
 
virtual void  Flush ()
 
virtual bool  IsFlushed ()
 

Package Functions

override bool  IsWrappedObjectMustBeIndirect ()
  Defines if the object behind this wrapper must be an indirect object in the resultant document. More...
 
- Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
  PdfObjectWrapper (T pdfObject)
 
virtual void  SetPdfObject (T pdfObject)
 
virtual void  SetForbidRelease ()
 
virtual void  UnsetForbidRelease ()
 
virtual void  EnsureUnderlyingObjectHasIndirectReference ()
 

Additional Inherited Members

- Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
static void  MarkObjectAsIndirect (PdfObject pdfObject)
 
static void  EnsureObjectIsAddedToDocument (PdfObject @object)
  Some wrappers use object's indirect reference to obtain the PdfDocument to which the object belongs to. More...
 

Member Function Documentation

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.Tagging.PdfUserProperty.IsWrappedObjectMustBeIndirect ( )
inlinepackagevirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Returns
true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.