Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Public Member Functions | Static Public Member Functions | Properties | List of all members
SolidFramework.Pdf.Transformers.TextWatermarkTransformer Class Reference

Represents text watermark pdf transformation More...

Inheritance diagram for SolidFramework.Pdf.Transformers.TextWatermarkTransformer:
SolidFramework.Pdf.Transformers.PdfTransformer

Public Member Functions

override void Dispose ()
 
 TextWatermarkTransformer ()
 Default constructor of TextWatermarkTransformer
 
 TextWatermarkTransformer (SolidFramework.Converters.Plumbing.TextWatermark watermark)
 Constructor with defined TextWatermark object More...
 
void ImportFromFile (string path)
 Adds PdfDocument to the source for transformation from the path More...
 
void ImportFromFolder (string path)
 Adds PdfDocuments to the source for transformation from the path to folder More...
 
void Clear ()
 Clears defined source for transformation and old results
 
virtual void AddDocument (SolidFramework.Pdf.PdfDocument document)
 Adds PdfDocument to the source for transformation More...
 
virtual void Transform ()
 Starts transformation
 
bool Equals (SolidFramework.Pdf.Transformers.PdfTransformer other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static SolidFramework.Pdf.Transformers.ITransformationResult Transform (SolidFramework.Pdf.PdfDocument document, SolidFramework.Pdf.Transformers.PdfTransformer transformer)
 Static function represents simple usage of single transformer More...
 
static bool operator== (SolidFramework.Pdf.Transformers.PdfTransformer obj1, SolidFramework.Pdf.Transformers.PdfTransformer obj2)
 
static bool operator!= (SolidFramework.Pdf.Transformers.PdfTransformer obj1, SolidFramework.Pdf.Transformers.PdfTransformer obj2)
 

Properties

SolidFramework.Converters.Plumbing.TextWatermark TextWatermark [getset]
 Text watermark for adding
 
SolidFramework.Pdf.Transformers.ITransformationResultsCollection Results [get]
 
SolidFramework.Pdf.Transformers.ITransformationResult this[int index] [get]
 
string OutputFolder [getset]
 Gets or sets the folder where generated files should be placed. If set then all documents will be saved in the folder and closed if they were not opened. This is a typical use case if we work with file paths instead of PdfDocuments
 
SolidFramework.Plumbing.OverwriteMode OverwriteMode [getset]
 Gets or sets whether files should be overwritten if they exist. This is only required if OutputFolder is specified.
 

Detailed Description

Represents text watermark pdf transformation

Constructor & Destructor Documentation

◆ TextWatermarkTransformer()

SolidFramework.Pdf.Transformers.TextWatermarkTransformer.TextWatermarkTransformer ( SolidFramework.Converters.Plumbing.TextWatermark  watermark)

Constructor with defined TextWatermark object

Parameters
watermarkWatermark for adding

Member Function Documentation

◆ AddDocument()

virtual void SolidFramework.Pdf.Transformers.PdfTransformer.AddDocument ( SolidFramework.Pdf.PdfDocument  document)
virtualinherited

Adds PdfDocument to the source for transformation

Parameters
documentDocument for transformation

◆ Dispose()

override void SolidFramework.Pdf.Transformers.TextWatermarkTransformer.Dispose ( )
virtual

◆ ImportFromFile()

void SolidFramework.Pdf.Transformers.PdfTransformer.ImportFromFile ( string  path)
inherited

Adds PdfDocument to the source for transformation from the path

Parameters
pathPath to the pdf file

◆ ImportFromFolder()

void SolidFramework.Pdf.Transformers.PdfTransformer.ImportFromFolder ( string  path)
inherited

Adds PdfDocuments to the source for transformation from the path to folder

Parameters
pathPath to the folder with pdf files

◆ Transform()

static SolidFramework.Pdf.Transformers.ITransformationResult SolidFramework.Pdf.Transformers.PdfTransformer.Transform ( SolidFramework.Pdf.PdfDocument  document,
SolidFramework.Pdf.Transformers.PdfTransformer  transformer 
)
staticinherited

Static function represents simple usage of single transformer

Parameters
documentDocument
transformerTransformer
Returns
Transformation results