Inheritance diagram for SolidFramework.Pdf.PdfDocument:

Public Member Functions
override void	Dispose ()

	PdfDocument ()
	Initializes a new instance of the PdfDocument class.

	PdfDocument (string path)
	Initializes a new instance of the PdfDocument class. More...

override SolidFramework.Interop.NativeError	Close ()

void	RemoveStructTreeRoot ()
	Removes "tagging" from the PdfDocument. If the PdfDocument was not tagged then this has no effect. More...

void	Save (SolidFramework.Plumbing.OverwriteMode mode, SolidFramework.PageRange pageRange)
	Saves the specified mode. More...

SolidFramework.Interop.NativeError	EnterOwnerAuthenticationMode (string ownerPassword)

string	InquireUserPasswordByOwnerPassword (string ownerPassword)
	InquireUserPasswordByOwnerPassword returns user password by owner password for password security handlers. Works for revisions prior to Acrobat 9. In case of failure return null string

bool	CheckOwnerPassword (string password)

bool	CheckUserPassword (string password)

void	SaveProtected (SolidFramework.Pdf.PdfSecurityHandler securityHandler, SolidFramework.Plumbing.OverwriteMode overwriteMode, bool shouldOptimize)

void	SaveProtected (SolidFramework.Pdf.PdfSecurityHandler securityHandler, SolidFramework.Plumbing.OverwriteMode overwriteMode)

void	SaveProtected (SolidFramework.Pdf.PdfSecurityHandler securityHandler)

void	SaveAsProtected (string path, SolidFramework.Pdf.PdfSecurityHandler securityHandler, SolidFramework.Plumbing.OverwriteMode overwriteMode, bool shouldOptimize)

void	SaveAsProtected (string path, SolidFramework.Pdf.PdfSecurityHandler securityHandler, SolidFramework.Plumbing.OverwriteMode overwriteMode)

void	SaveAsProtected (string path, SolidFramework.Pdf.PdfSecurityHandler securityHandler)

void	SetOutputID (SolidFramework.BytesArray permanentIdentifier, SolidFramework.BytesArray changingIdentifier)
	Sets the ID to use when the document is saved. More...

void	DecodeAllStreams ()
	Decodes all streams.

void	Append (SolidFramework.Pdf.PdfDocument pdfDocumentToAppend)
	Appends the specified PDF document to append. More...

SolidFramework.Pdf.Plumbing.PdfFontsCollection	GetFonts ()
	Gets the fonts used in this document. More...

SolidFramework.Pdf.Plumbing.PdfPagesCollection	GetPages ()
	Gets the pages. More...

SolidFramework.Pdf.Plumbing.PdfPagesCollection	GetPages (int nFrom, int nTo)

SolidFramework.Interop.NativeError	RecognizeDocument (string OCRLang, SolidFramework.Converters.Plumbing.TextRecovery textRecovery, SolidFramework.Converters.Plumbing.OcrType ocrType, bool pageAutoRotate, SolidFramework.Imaging.Plumbing.ImageCompression imageCompression)

SolidFramework.Interop.NativeError	AddTextWatermark (string strWatermarkText, string strURL, bool bSerifFont, float angle, bool bFill, int dwColor, bool bStroke, float lineWeight, int zorder, int vpos, int hpos)

bool	IsPdfLoaded ()

global::System.IntPtr	NativeDataBase ()
	Gets the native data base.

	PdfDocument (Stream stream)

virtual void	Create ()
	Creates this empty instance.

void	Open ()
	Opens the document. This will throw an exception if the path has not already been specified in the constructor. More...

void	Open (string password)
	Opens the document. This will throw an exception if the path has not already been specified in the constructor. More...

void	Save ()
	Saves the document

void	Save (SolidFramework.Plumbing.OverwriteMode mode)
	Saves the document and sets overwrite mode More...

void	Save (SolidFramework.Plumbing.OverwriteMode mode, bool useOptimizer)
	Saves the the document to the specified path with using of optimization More...

void	SaveAs (string path)
	Saves the document to specified path More...

void	SaveAs (string path, SolidFramework.Plumbing.OverwriteMode mode)
	Saves to specified path More...

void	SaveAs (string path, SolidFramework.Plumbing.OverwriteMode mode, bool useOptimizer)
	Saves to specified path More...

void	SaveOptimized ()
	Saves and apply optimization

void	SaveOptimized (SolidFramework.Plumbing.OverwriteMode mode)
	Saves and apply optimization More...

void	SaveOptimizedAs (string path)
	Saves to specified path and apply optimization More...

void	SaveOptimizedAs (string path, SolidFramework.Plumbing.OverwriteMode mode)
	Saves to specified path and apply optimization More...

bool	Equals (SolidFramework.Plumbing.Document other)

override bool	Equals (object obj)

override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (SolidFramework.Plumbing.Document obj1, SolidFramework.Plumbing.Document obj2)

static bool	operator!= (SolidFramework.Plumbing.Document obj1, SolidFramework.Plumbing.Document obj2)

Properties
override SolidFramework.Plumbing.ICatalog	Catalog `[get]`
	Gets the catalog.

override string	Extension `[get]`
	Gets the extension.

SolidFramework.Pdf.Info	Info `[get]`
	Gets the info.

SolidFramework.Pdf.Plumbing.PdfDictionary	Trailer `[get]`
	Gets the trailer.

SolidFramework.Pdf.Plumbing.PdfDictionary	Root `[get]`
	Gets the root.

string	Version `[get]`
	Gets the version using either Catalog.Version or file header.

SolidFramework.Pdf.Plumbing.PdfArray	ID `[get]`
	Gets the ID.

SolidFramework.Pdf.Plumbing.PdfDictionary	CatalogDictionary `[get]`
	Gets the catalog dictionary.

SolidFramework.Pdf.Plumbing.PdfArray	IDArray `[get]`
	Gets the ID array.

SolidFramework.Pdf.Plumbing.PdfDictionary	InfoDictionary `[get]`
	Gets the info dictionary.

int	PageCount `[get]`

SolidFramework.Pdf.AuthenticationModeType	AuthenticationMode `[get]`
	Gets the authentication mode.

SolidFramework.Pdf.EncryptionAlgorithm	EncryptionAlgorithm `[get]`
	Gets or sets the encryption algorithm. More...

SolidFramework.Pdf.AccessPermissions	Permissions `[get]`
	Gets or sets the permissions. More...

bool	IsLinearized `[get]`
	Determines if the PDF is "fast web view" using the header

bool	IsModified `[get]`
	Gets a value indicating whether this document is modified. More...

string	Path `[getset]`
	Gets the path. More...

bool	IsLoaded `[get]`
	Gets a value indicating whether this document is loaded. More...

bool	RequiresOptimization `[getset]`

SolidFramework.Plumbing.OverwriteMode	OverwriteMode `[getset]`
	Gets the overwrite mode. More...

bool	Dirty `[getset]`
	Gets a value indicating whether this Document is dirty. More...

Constructor & Destructor Documentation

◆ PdfDocument()

SolidFramework.Pdf.PdfDocument.PdfDocument ( string path )

Initializes a new instance of the PdfDocument class.

Parameters

path The path.

Member Function Documentation

◆ Append()

void SolidFramework.Pdf.PdfDocument.Append ( SolidFramework.Pdf.PdfDocument pdfDocumentToAppend )

Appends the specified PDF document to append.

Parameters

pdfDocumentToAppend The PDF document to append.

◆ Close()

override SolidFramework.Interop.NativeError SolidFramework.Pdf.PdfDocument.Close ( )

virtual

Reimplemented from SolidFramework.Plumbing.Document.

◆ Dispose()

override void SolidFramework.Pdf.PdfDocument.Dispose ( )

virtual

Reimplemented from SolidFramework.Plumbing.Document.

◆ GetFonts()

SolidFramework.Pdf.Plumbing.PdfFontsCollection SolidFramework.Pdf.PdfDocument.GetFonts ( )

Gets the fonts used in this document.

Returns: The fonts.

◆ GetPages()

SolidFramework.Pdf.Plumbing.PdfPagesCollection SolidFramework.Pdf.PdfDocument.GetPages ( )

Gets the pages.

Returns: The pages.

◆ Open() [1/2]

void SolidFramework.Plumbing.Document.Open ( )

inherited

Opens the document. This will throw an exception if the path has not already been specified in the constructor.

Exceptions

System.InvalidOperationException with a message of "Path must be set before calling Open" occurs if the path has not been specified or is null.

◆ Open() [2/2]

void SolidFramework.Plumbing.Document.Open ( string password )

inherited

Opens the document. This will throw an exception if the path has not already been specified in the constructor.

Parameters

password The password to be used when opening the file.

Exceptions

System.InvalidOperationException with a message of "Path must be set before calling Open" occurs if the path has not been specified or is null.

◆ RemoveStructTreeRoot()

void SolidFramework.Pdf.PdfDocument.RemoveStructTreeRoot ( )

Removes "tagging" from the PdfDocument. If the PdfDocument was not tagged then this has no effect.

Tagging is used to indicate structure within the PdfDocument. Where text is tagged as being part of a table this will, if DetectTaggedTables is true, cause the text to always be extracted as a table, rather than the text being considered to be a table only if it "looks" like a table.

◆ Save() [1/3]

void SolidFramework.Plumbing.Document.Save ( SolidFramework.Plumbing.OverwriteMode mode )

inherited

Saves the document and sets overwrite mode

Parameters

mode The mode.

◆ Save() [2/3]

void SolidFramework.Plumbing.Document.Save	(	SolidFramework.Plumbing.OverwriteMode	mode,
		bool	useOptimizer
	)

inherited

Saves the the document to the specified path with using of optimization

Parameters

mode	The mode.
useOptimizer	if set to `true` [use optimizer].

◆ Save() [3/3]

void SolidFramework.Pdf.PdfDocument.Save	(	SolidFramework.Plumbing.OverwriteMode	mode,
		SolidFramework.PageRange	pageRange
	)

Saves the specified mode.

Parameters

mode	The mode.
pageRange	The page range.

◆ SaveAs() [1/3]

void SolidFramework.Plumbing.Document.SaveAs ( string path )

inherited

Saves the document to specified path

Parameters

path The path.

◆ SaveAs() [2/3]

void SolidFramework.Plumbing.Document.SaveAs	(	string	path,
		SolidFramework.Plumbing.OverwriteMode	mode
	)

inherited

Saves to specified path

Parameters

path	The path.
mode	The overwrite mode.

◆ SaveAs() [3/3]

void SolidFramework.Plumbing.Document.SaveAs	(	string	path,
		SolidFramework.Plumbing.OverwriteMode	mode,
		bool	useOptimizer
	)

inherited

Saves to specified path

Parameters

path	The path.
mode	The overwrite mode.
useOptimizer	if set to `true` [use optimizer].

◆ SaveOptimized()

void SolidFramework.Plumbing.Document.SaveOptimized ( SolidFramework.Plumbing.OverwriteMode mode )

inherited

Saves and apply optimization

Parameters

mode The mode.

◆ SaveOptimizedAs() [1/2]

void SolidFramework.Plumbing.Document.SaveOptimizedAs ( string path )

inherited

Saves to specified path and apply optimization

Parameters

path The path.

◆ SaveOptimizedAs() [2/2]

void SolidFramework.Plumbing.Document.SaveOptimizedAs	(	string	path,
		SolidFramework.Plumbing.OverwriteMode	mode
	)

inherited

Saves to specified path and apply optimization

Parameters

path	The path.
mode	The overwrite mode.

◆ SetOutputID()

void SolidFramework.Pdf.PdfDocument.SetOutputID	(	SolidFramework.BytesArray	permanentIdentifier,
		SolidFramework.BytesArray	changingIdentifier
	)

Sets the ID to use when the document is saved.

Parameters

permanentIdentifier	Specifies the first part of the ID (this should be unique for new PDFs but can remain unchanged when modifying an existing PDF).
changingIdentifier	Specifies the second part of the ID (this should change each time the PDF is modified).

Property Documentation

◆ Dirty

bool SolidFramework.Plumbing.Document.Dirty

getsetinherited

Gets a value indicating whether this Document is dirty.

true if dirty; otherwise, false.

◆ EncryptionAlgorithm

SolidFramework.Pdf.EncryptionAlgorithm SolidFramework.Pdf.PdfDocument.EncryptionAlgorithm

get

Gets or sets the encryption algorithm.

The encryption algorithm.

◆ IsLoaded

bool SolidFramework.Plumbing.Document.IsLoaded

getinherited

Gets a value indicating whether this document is loaded.

true if this document is loaded; otherwise, false.

◆ IsModified

bool SolidFramework.Pdf.PdfDocument.IsModified

get

Gets a value indicating whether this document is modified.

true if this document is modified; otherwise, false.

◆ OverwriteMode

SolidFramework.Plumbing.OverwriteMode SolidFramework.Plumbing.Document.OverwriteMode

getsetinherited

Gets the overwrite mode.

The overwrite mode.

◆ Path

string SolidFramework.Plumbing.Document.Path

getsetinherited

Gets the path.

The path.

◆ Permissions

SolidFramework.Pdf.AccessPermissions SolidFramework.Pdf.PdfDocument.Permissions

get

Gets or sets the permissions.

The permissions.

Public Member Functions

Static Public Member Functions

Properties

Constructor & Destructor Documentation

◆ PdfDocument()

Member Function Documentation

◆ Append()

◆ Close()

◆ Dispose()

◆ GetFonts()

◆ GetPages()

◆ Open() [1/2]

◆ Open() [2/2]

◆ RemoveStructTreeRoot()

◆ Save() [1/3]

◆ Save() [2/3]

◆ Save() [3/3]

◆ SaveAs() [1/3]

◆ SaveAs() [2/3]

◆ SaveAs() [3/3]

◆ SaveOptimized()

◆ SaveOptimizedAs() [1/2]

◆ SaveOptimizedAs() [2/2]

◆ SetOutputID()

Property Documentation

◆ Dirty

◆ EncryptionAlgorithm

◆ IsLoaded

◆ IsModified

◆ OverwriteMode

◆ Path

◆ Permissions