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.Catalog Class Reference

Represents PDF catalog More...

Inheritance diagram for SolidFramework.Pdf.Catalog:
SolidFramework.Plumbing.ICatalog

Public Member Functions

override void Dispose ()
 
SolidFramework.Pdf.ViewerPreferences GetViewerPreferences ()
 Gets the viewer preferences. More...
 
SolidFramework.Pdf.ViewerPreferences GetViewerPreferences (bool create)
 Gets the viewer preferences, optionally creating them if they don't already exist. More...
 
void RemoveViewerPreferences ()
 Removes the viewer preferences.
 
bool Equals (SolidFramework.Plumbing.ICatalog other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static SolidFramework.Plumbing.ICatalog Create (SolidFramework.Pdf.PdfDocument doc)
 Creates the specified document. More...
 
static bool operator== (SolidFramework.Plumbing.ICatalog obj1, SolidFramework.Plumbing.ICatalog obj2)
 
static bool operator!= (SolidFramework.Plumbing.ICatalog obj1, SolidFramework.Plumbing.ICatalog obj2)
 

Properties

override int CurrentPage [getset]
 Gets the current page number
 
override SolidFramework.Plumbing.IPagesCollection Pages [get]
 Gets the pages collection
 
SolidFramework.Pdf.Plumbing.PdfDictionary Dests [get]
 
SolidFramework.Pdf.Plumbing.PdfDictionary Names [get]
 
SolidFramework.Pdf.Plumbing.PdfItem OpenAction [getset]
 Gets the OpenAction if present.
 
SolidFramework.Pdf.Plumbing.PdfOutlines Outlines [get]
 Gets the outlines.
 
SolidFramework.Pdf.OptionalContentProperties OptionalContentProperties [get]
 Gets the optional content properties.
 
string Version [get]
 Gets the version.
 
string Type [get]
 Gets the type.
 
bool IsTagged [get]
 Is this a Tagged PDF? (Must have MarkInfo with Marked true).
 
SolidFramework.Pdf.PageLayout PageLayout [getset]
 Gets the page layout. More...
 
SolidFramework.Pdf.PageMode PageMode [getset]
 Gets or sets the page mode. More...
 

Detailed Description

Represents PDF catalog

Member Function Documentation

◆ Create()

static SolidFramework.Plumbing.ICatalog SolidFramework.Pdf.Catalog.Create ( SolidFramework.Pdf.PdfDocument  doc)
static

Creates the specified document.

Parameters
docThe document.
Returns

◆ Dispose()

override void SolidFramework.Pdf.Catalog.Dispose ( )
virtual

Reimplemented from SolidFramework.Plumbing.ICatalog.

◆ GetViewerPreferences() [1/2]

SolidFramework.Pdf.ViewerPreferences SolidFramework.Pdf.Catalog.GetViewerPreferences ( )

Gets the viewer preferences.

Returns
The viewer preferences, or null if there were no viewer preferences.

◆ GetViewerPreferences() [2/2]

SolidFramework.Pdf.ViewerPreferences SolidFramework.Pdf.Catalog.GetViewerPreferences ( bool  create)

Gets the viewer preferences, optionally creating them if they don't already exist.

Parameters
createWhether to create viewer preferences if they don't already exist.
Returns
The viewer preferences, or null if there were no viewer preferences and create was set to false.

Property Documentation

◆ PageLayout

SolidFramework.Pdf.PageLayout SolidFramework.Pdf.Catalog.PageLayout
getset

Gets the page layout.

The page layout.

◆ PageMode

SolidFramework.Pdf.PageMode SolidFramework.Pdf.Catalog.PageMode
getset

Gets or sets the page mode.

The page mode.