iText 8.0.5 API
iText.Kernel.Pdf.Filespec.PdfStringFS Class Reference
Inheritance diagram for iText.Kernel.Pdf.Filespec.PdfStringFS:
iText.Kernel.Pdf.Filespec.PdfFileSpec iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >

Public Member Functions

  PdfStringFS (String @string)
 
  PdfStringFS (PdfString pdfObject)
 
- Public Member Functions inherited from iText.Kernel.Pdf.Filespec.PdfFileSpec
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec  SetFileIdentifier (PdfArray fileIdentifier)
 
virtual PdfArray  GetFileIdentifier ()
 
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec  SetVolatile (PdfBoolean isVolatile)
 
virtual PdfBoolean  IsVolatile ()
 
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec  SetCollectionItem (PdfCollectionItem item)
 
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec  SetThumbnailImage (PdfImageXObject thumbnailImage)
  PDF 2.0. More...
 
virtual PdfImageXObject  GetThumbnailImage ()
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Filespec.PdfFileSpec  Put (PdfName key, PdfObject value)
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
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.Filespec.PdfFileSpec
  PdfFileSpec (PdfObject pdfObject)
 
- Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
  PdfObjectWrapper (T pdfObject)
 
virtual void  SetPdfObject (T pdfObject)
 
virtual void  SetForbidRelease ()
 
virtual void  UnsetForbidRelease ()
 
virtual void  EnsureUnderlyingObjectHasIndirectReference ()
 

Additional Inherited Members

- Static Public Member Functions inherited from iText.Kernel.Pdf.Filespec.PdfFileSpec
static iText.Kernel.Pdf.Filespec.PdfFileSpec  WrapFileSpecObject (PdfObject fileSpecObject)
  Wrap the passed iText.Kernel.Pdf.PdfObject to the specific PdfFileSpec object, according to the type of the passed pdf object. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateExternalFileSpec (PdfDocument doc, String filePath, PdfName afRelationshipValue)
  Create an external file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateExternalFileSpec (PdfDocument doc, String filePath)
  Create an external file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String fileDisplay, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String description, String fileDisplay, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, String filePath, String fileDisplay, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, Stream @is, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
static iText.Kernel.Pdf.Filespec.PdfFileSpec  CreateEmbeddedFileSpec (PdfDocument doc, Stream @is, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
  Create an embedded file specification. More...
 
- Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
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.Filespec.PdfStringFS.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.

Reimplemented from iText.Kernel.Pdf.Filespec.PdfFileSpec.