Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Classes | Enumerations | Functions
SolidFramework.Plumbing Namespace Reference

Classes

class  Document
 Represents wrapper other document More...
 
class  GZip
 Represents GZip functionality More...
 
class  GZippedFile
 Represents GZipped file More...
 
class  GZipResult
 Represents GZip result More...
 
class  ICatalog
 Interface for PDF catalog More...
 
interface  IMacroEngine
 IMacro Interface allows interception of all the UI form activity in Solid Framework More...
 
class  IPagesCollection
 Interface for PDF catalog More...
 
class  Logging
 Represents Logging functionality More...
 
class  ProgressTicker
 Represents Progress ticker More...
 
class  ProgressTickerEventArgs
 
class  Utilities
 Represents Utilities More...
 
class  VerifyVersions
 Represents static class for the Verify versions functionality More...
 

Enumerations

enum  CatalogType { ICatalog , Catalog }
 
enum  DocumentType { Document , PdfDocument }
 
enum  enActivationType {
  ltInvalid = 0 , ltDeveloper = 1 , ltProfessional = 2 , ltTools = 3 ,
  ltFree = 4 , ltToolsInternal = 5 , ltProfessionalInternal = 6 , ltToolsRepublisher = 7 ,
  ltProfessionalRepublisher = 8 , ltProfessionalOcrInternal = 9 , ltProfessionalOcrRepublisher = 10 , ltProfessionalOcr = 11 ,
  ltClientTrial = 12 , ltProfessionalUniversal = 13
}
 
enum  LicensePermissions {
  None = 0x0000 , PdfToWord = 0x0001 , PdfTools = 0x0002 , PdfFree = 0x0004 ,
  Ocr = 0x0008
}
 License permissions More...
 
enum  LicenseType {
  Invalid = 0 , Developer = 1 , Professional = 2 , Tools = 3 ,
  Free = 4 , ToolsInternal = 5 , ProfessionalInternal = 6 , ToolsRepublisher = 7 ,
  ProfessionalRepublisher = 8 , ProfessionalOcrInternal = 9 , ProfessionalOcrRepublisher = 10 , ProfessionalOcr = 11 ,
  ClientTrial = 12 , ProfessionalUniversal = 13
}
 License type More...
 
enum  OverwriteMode { FailIfExists = 0 , ForceOverwrite = 1 }
 Defines whether to overwrite or fail the conversion if the output file exists. More...
 
enum  PageRanges {
  None = 0 , Odd = 0x01 , Even = 0x02 , All = 0x03 ,
  Portrait = 0x04 , Landscape = 0x08 , Selected = 0x10 , Current = 0x20
}
 Represents types of Page ranges More...
 
enum  ValidationMode {
  Detect , Pdf , PdfA1B , PdfA1A ,
  PdfA2B , PdfA2A , PdfA2U , PdfA3B ,
  PdfA3A , PdfA3U
}
 Variant of PDFa formats More...
 
enum  WarningLevelType {
  none , force , errors , verbose ,
  engineer_l1 , engineer_l2 , details
}
 
enum  LicenseState {
  Valid = 0 , Generated = 1 , Invalid = 2 , Expired = 3 ,
  WebCallFailure = 4 , Denied = 5
}
 Used as return value by License.Validate More...
 
enum  ProgressTickerStatus {
  StartEpisode , EndEpisode , TickEpisode , StartSeason ,
  EndSeason , TickSeason
}
 Represents types of Progress ticker statuses More...
 
enum  StatusWindowAction { CloseOnCompletion = 0 , KeepOpen }
 Represents types of Status window action More...
 

Functions

delegate Boolean ProgressTickerEventDelegate (int progress, int progressMax, ProgressTickerStatus status, string name)
 Progress Ticker Event Handler Delegate More...
 

Enumeration Type Documentation

◆ CatalogType

Enumerator
ICatalog 
Catalog 

◆ LicensePermissions

License permissions

Enumerator
None 

No permissions

PdfToWord 

Permission to use 'conversion' features

PdfTools 

Permission to use 'tools' features

PdfFree 

Permission to use 'free' features

Ocr 

Permission to use OCR

◆ LicenseState

Used as return value by License.Validate

Enumerator
Valid 

License passed in is ok

Generated 

License passed in was not valid so new license was generated and returned

Invalid 

License passed in was not valid (not valid and not found in developer account)

Expired 

License passed in was not valid and account is in need of renewal

WebCallFailure 

There was a failure attempting to call the Solid Documents license server (http call)

Denied 

Validate isn't supported for your account, please contact suppo.nosp@m.rt@s.nosp@m.olidd.nosp@m.ocum.nosp@m.ents..nosp@m.com to discuss options.

◆ LicenseType

License type

Enumerator
Invalid 

Invalid license

Developer 

Developer license

Professional 

Professional license

Tools 

Tools license

Free 

Free license

ToolsInternal 

Internal Tools license

ProfessionalInternal 

Internal Professional license

ToolsRepublisher 

Republisher Tools license

ProfessionalRepublisher 

Republisher Professional license

ProfessionalOcrInternal 

Internal Professional licence with OCR

ProfessionalOcrRepublisher 

Republisher Professional licence with OCR

ProfessionalOcr 

Professional licence with OCR

ClientTrial 

Trial license

ProfessionalUniversal 

Universal Professional licence

◆ OverwriteMode

Defines whether to overwrite or fail the conversion if the output file exists.

Enumerator
FailIfExists 

If output file exists, fail conversion.

ForceOverwrite 

If output file exists, overwrite file.

◆ PageRanges

Represents types of Page ranges

Enumerator
None 

None

Odd 

Odd pages

Even 

Even pages

All 

All pages

Portrait 

Portrait pages

Landscape 

Landscape pages

Selected 

Selected pages

Current 

Current

◆ ProgressTickerStatus

Represents types of Progress ticker statuses

Enumerator
StartEpisode 

Ticker is starting episode

EndEpisode 

Ticker is ending episode

TickEpisode 

Ticker is ticking episode

StartSeason 

Ticker is starting season

EndSeason 

Ticker is ending season

TickSeason 

Ticker is ticking season

◆ StatusWindowAction

Represents types of Status window action

Enumerator
CloseOnCompletion 

Close window on completion

KeepOpen 

Keep window open

◆ ValidationMode

Variant of PDFa formats

Enumerator
Detect 

Detect mode to validate

Pdf 

Not PDF/A. Attempting to convert to PDF with ValidationMode set to PDF will throw an exception.

PdfA1B 

Pdf/A 1B

PdfA1A 

Pdf/A 1A

PdfA2B 

Pdf/A 2B

PdfA2A 

Pdf/A 2A

PdfA2U 

Pdf/A 2U

PdfA3B 

Pdf/A 3B

PdfA3A 

Pdf/A 3A

PdfA3U 

Pdf/A 3U

◆ WarningLevelType

Enumerator
none 
force 
errors 
verbose 
engineer_l1 
engineer_l2 
details 

Function Documentation

◆ ProgressTickerEventDelegate()

delegate Boolean SolidFramework.Plumbing.ProgressTickerEventDelegate ( int  progress,
int  progressMax,
ProgressTickerStatus  status,
string  name 
)

Progress Ticker Event Handler Delegate

Parameters
progressThe progress.
progressMaxThe progress max.
statusThe status.
nameThe name.
Returns