Aspose.Pdf

The Aspose.Pdf is a root namespace for all classes of Aspose.Pdf library which are either directly in it like Document or indirectly through several subnamespaces.

Classes

ClassDescription
ApsLoadOptionsClass describes aps load options.
ApsSaveOptionsSave options for export to APS XML format.
ArtifactClass represents PDF Artifact object.
ArtifactCollectionClass represents artifact collection.
BackgroundArtifactClass descibes background artifact. This artifact allows to set background of the page.
BaseActionCollectionClass incapsulates basic actions wuth page/annotation/field interactive actions
BaseOperatorCollectionRepresents base class for operator collection.
BaseParagraphRepresents a abstract base object can be added to the page(doc.Paragraphs.Add()).
BorderInfoThis class represents border for graphics elements.
BuildVersionInfoThis class provides information about current product build.
CdrLoadOptionsClass describes CDR load options.
CellRepresents a cell of the table’s row.
CellsRepresents a cells collection of row.
CgmImportOptionsImport option for import from Computer Graphics Metafile(CGM) format.
CgmLoadOptionsContains options for loading/importing CGM file into pdf document.
CollectionRepresents class for Collection(12.3.5 Collections).
ColorRepresents class for color value which can be expressed in different color space.
ColumnInfoThis class represents a columns info.
ComHelperProvides methods for COM clients to load a document into Aspose.Pdf.
CompositingParametersRepresents an object containing graphics compositing parameters of current graphics state.
DeprecatedFeatureExceptionThe exception that is thrown when a feature is deprecated in current pdf version.
DestinationCollectionClass represents the collection of all destinations (a name tree mapping name strings to destinations (see 12.3.2.3, “Named Destinations”) and (see 7.7.4, “Name Dictionary”)) in the pdf document.
DjvuLoadOptionsClass describes DJVU load options.
DocSaveOptionsSave options for export to Doc format
DocumentClass representing PDF document
DocumentFactoryClass which allows to create/load documents of different types.
DocumentInfoRepresents meta information of PDF document.
EmbeddedFileCollectionClass representing embedded files collection.
EmptyValueExceptionException which thrown when requirested value does not exists.
EncryptedPayloadRepresents encrypted payload in file specification.
EpubLoadOptionsContains options for loading/importing EPUB file into pdf document.
EpubSaveOptionsSave options for export to EPUB format
ExcelSaveOptionsSave options for export to Excel format
FileHyperlinkRepresents file hyperlink object.
FileParamsDefines an embedded file parameter dictionary that shall contain additional file-specific information.
FileSpecificationClass representing embedded file.
FloatingBox
FontEmbeddingExceptionThe exception that is thrown when an attempt to embed font became failed
FontNotFoundExceptionThe exception that is thrown when a font is not found.
FooterArtifactDescribes footer artifact. This may be used to set footer of the page.
FormattedFragmentRepresents abstract formatted fragment.
GraphInfoRepresents graphics info.
GroupA group attributes class specifying the attributes of the page’s page group for use in the transparent imaging model.
HeaderArtifactClass describes Heaader artifact. This artifacgt may be used to set heading of the page.
HeaderFooterClass represents header or footer pdf page.
HeadingRepresents heading.
HtmlFragmentRepresents html fragment.
HtmlLoadOptionsRepresents options for loading/importing html file into pdf document.
HtmlSaveOptionsSave options for export to Html format
HyperlinkRepresents abstract hyperlink.
IdRepresents file identifier structure.
ImageRepresents image.
ImagePlacementRepresents characteristics of an image placed to Pdf document page.
ImagePlacementAbsorberRepresents an absorber object of image placement objects. Performs search of image usages and provides access to search results via ImagePlacements collection.
ImagePlacementCollectionRepresents an image placements collection
ImageStampReresents graphic stamp.
ImportOptionsImportOptions type hold level of abstraction on individual import options.
IncorrectCMapUsageExceptionThe exception that is thrown when font usage is incorrect.
IncorrectFontUsageExceptionThe exception that is thrown when font usage is incorrect.
InvalidCgmFileFormatExceptionThe exception that is thrown when a Cgm file is invalid.
InvalidFileFormatExceptionThe exception that is thrown when a file is invalid.
InvalidFormTypeOperationExceptionThe exception that is thrown when an operation with form type is not valid.
InvalidPasswordExceptionThe exception that is thrown when invalid password is provided by user.
InvalidPdfFileFormatExceptionThe exception that is thrown when a pdf file is invalid.
InvalidValueFormatExceptionException which thrown when requested value has incorrect format.
JavaScriptCollectionThis class represents collection of JavaScript.
JavascriptExtensionsExceptionThe exception that is thrown on errors when working with JavascriptExtensions.
LayerRepresents page layer.
LevelFormatRepresents format of the table of contents.
LicenseProvides methods to license the component.
LoadOptionsLoadOptions type holds level of abstraction on individual load options
LocalHyperlinkRepresents local hyperlink object.
MarginInfoThis class represents a margin for different objects.
MatrixClass represents transformation matrix.
Matrix3DClass represents transformation matrix.
MdLoadOptionsLoad options for Markdown format conversion.
MetadataProvides access to XMP metadata stream.
MeteredProvides methods to set metered key.
MhtLoadOptionsRepresents options for loading/importing of .mht-file into pdf document.
MobiXmlSaveOptionsSave options for export to Xml format
NamedDestinationCollectionClass represents the collection of all destinations (a name tree mapping name strings to destinations (see 12.3.2.3, “Named Destinations”) and (see 7.7.4, “Name Dictionary”)) in the pdf document.
NoteThis class represents generator paragraph note.
OcspSettingsRepresents the ocsp settings using during signing process.
OfdLoadOptionsLoad options for OFD format.
OperatorAbstract class representing operator.
OperatorCollectionClass represents collection of operators
OperatorSelectorThis class is used for selecting operators using Visitor template idea.
OpiRepresents The Open Prepress Interface (OPI) is a mechanism for creating low-resolution placeholders, or proxies, for such high-resolution images.
OptimizedMemoryStreamDefines a MemoryStream that can contains more standard capacity
OutlineCollectionRepresents document outline hierarchy.
OutlineItemCollectionRepresents outline entry in outline hierarchy of PDF document.
OutlinesClass describes collection of outlines.
OutputIntentRepresents an output intent that matches the color characteristics of a PDF document with those of a target output device or production environment in which the document will be printed.
OutputIntentsRepresents the collection of OutputIntent.
PageClass representing page of PDF document.
PageActionCollectionThis class describes page actions
PageCollectionCollection of PDF document pages.
PageInfoRepresents the page information.
PageLabelClass representing Page Label range.
PageLabelCollectionClass represeingting page label collection.
PageNumberStampRepresents page number stamp and used to number pages.
PageSizeClass representing size of page in PDF document.
ParagraphsThis class represents paragraph collection.
PclLoadOptionsRepresents options for loading(import) PCL file into pdf document.
PdfANonSpecificationFlagsThis class holds flags to control PDF/A conversion for cases when source PDF document doesn’t correspond to PDF specification. If flags of this clas are used it decreases performance but it’s necessary when source PDF document can’t be convert into PDF/A format by usual way. By default all flags are set to false.
PdfASymbolicFontEncodingStrategyThis class describes rules which can be used to tune process of copying encoding data for cases when TrueType symbolic font has more than one encoding. Some PDF documents after conversion into PDF/A format could give an error “More than one encoding in symbolic TrueType font’s cmap”. What is a reason of this error? All TrueType symbolic fonts have special table “cmap” in it’s internal data. This table maps character codes to glyph indices. And this table could contain different encoding subtables which describe encodings used. See advanced info about cmap tables at https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6cmap.html. Usually cmap table contains several encoding subtables, but PDF/A standard requires that either only one encoding subtable must be left for this font in PDF/A document or there must be a (3,0) encoding subtable among this font subtables. And key question here - what data must be taken from another subtables to copy into destination encoding table (3,0)? Majority of fonts have ‘well-formed’ cmap tables where every encoding subtable is fully consistent with another subtable. But some fonts have cmap tables with collisions - where for example one subtable has glyph index 100 for unicode 100, but another subtable has glyph index 200 for the same unicode 100. To solve this problems special strategy needed. By default following strategy used: mac subtable(1,0) is looked for. If this table is found, only this data used to fill destination table (3,0). If mac subtable is not found then all subtables except (3,0) are iterated and used to copy data into destination (3,0) subtable. Also mapping for every unicode(unicode, glyph index) is copied into destination table only if destination table does not have this unicode at current moment. So, for example if first subtabe has glyph index 100 for unicode 100, and next subtable has glyph index 200 for the same unicode 100, only data from first subtable (unicode=100, glyph index = 100) will be copied. So each previous subtable takes precedence over the next. Properties of this class PdfASymbolicFontEncodingStrategy help tune default behaviour. If property PreferredCmapEncodingTable of type CMapEncodingTableType is set, then relevant subtable will be used in precedence to mac subtable(1,0). Value ‘MacTable’ from enumeration CMapEncodingTableType has no sense in this case, cause it points on the same mac subtable (1,0) which will be used by default. Property CmapEncodingTablesPriorityQueue discards all priorities for any subtable. If this property is set, then only subtables from declared queue will be used in specified order. If subtables specified are not found then default iteration of all subtables and copy strategy described above will be used. Object QueueItem specifies encoding subtable used. This subtable can be set via combination of members(PlatformID, PlatformSpecificId) or via CMapEncodingTableType enumeration. In case when the font has no (3,0) subtable some other subtable will be used to maintain the PDF/A compatibility. The choice of the subtable to use is made under the same rules as described earlier, so that PreferredCmapEncodingTable and CmapEncodingTablesPriorityQueue properties are used to determine the resultant subtable, and if the font doesn’t have the requested subtable(s) either then any existant subtable will be used.
PdfExceptionRepresents errors that occur during PDF application execution.
PdfFormatConversionOptionsrepresents set of options for convert PDF document
PdfPageStampClass represents stamp which uses PDF page as stamp.
PdfSaveOptionsSave options for export to Pdf format
PdfXmlLoadOptionsLoad options for PdfXml format.
PdfXmlSaveOptionsSave options for PdfXml format.
PointRepresent point with fractional coordinates.
Point3DRepresent point with fractional coordinates.
PptxSaveOptionsSave options for export to SVG format
PrintControllerRepresents print controller.
PsLoadOptionsRepresents options for loading/importing of .mht-file into pdf document.
PsSaveOptionsSave options for export to PS (PostScript) or EPS format.
RectangleClass represents rectangle.
RenderingOptionsRepresents rendering options.
ResourcesClass representing page resources.
RgbToDeviceGrayConversionStrategyRepresents rgb to device gray color spaces conversion strategy.
RowRepresents a row of the table.
RowsRepresents a rows collection of table.
SaveOptionsSaveOptions type hold level of abstraction on individual save options
StampAn abstract class for various kinds of stamps which come as descendants.
SvgLoadOptionsRepresents options for loading/importing SVG file into pdf document.
SvgSaveOptionsSave options for export to SVG format
TableRepresents a table that can be added to the page.
TeXFileSystemInputDirectoryImplements the regular file system’s method for getting a file stream to read from.
TeXFileSystemOutputDirectoryImplements the regular file system’s method for getting a file stream to write to.
TeXFragmentRepresents TeX fragment.
TeXLoadOptionsRepresents options for loading/importing TeX file into PDF document.
TeXMemoryOutputDirectoryImplements fetching an output stream from memory. You can use it, for example, when you don’t want the accompanying output (like a log file) to be written to disk but you’d like to read it afterwards from memory.
TeXSaveOptionsSave options for export to TeX format
TextStampRepresents textual stamp.
TimestampSettingsRepresents the ocsp settings using during signing process.
TocInfoRepresents table of contents info.
TxtLoadOptionsLoad options for TXT to PDF conversion.
UnifiedSaveOptionsThis class represents saving options for saving that uses unified conversion way (with unified internal document model)
UnsupportedFontTypeExceptionThe exception that is thrown when a font type is not supported.
WarningInfoImmutable object for encapsulating warning information.
WatermarkRepresents a watermark of the page.
WatermarkArtifactClass describes watermark artifact. This may be used to
WebHyperlinkRepresents web hyperlink object.
XFormClass represent XForm
XFormCollectionClass represents collection of XFormCollection.
XImageClass representing image X-Object.
XImageCollectionClass representing XImage collection.
XmlLoadOptionsRepresents options for loading/importing XML file into pdf document.
XmlSaveOptionsSave options for export to Xml format
XmpFieldRepresents XMP field.
XmpPdfAExtensionFieldThis schema describes a field in a structured type. It is very similar to the PDF/A Property Value Type schema, but defines a field in a structure instead of a property. Schema namespace URI: http://www.aiim.org/pdfa/ns/field# Required schema namespace prefix: pdfaField.
XmpPdfAExtensionObjectRepresents the base class for field, property, value type instances.
XmpPdfAExtensionPropertyDescribes a single property. Schema namespace URI: http://www.aiim.org/pdfa/ns/property# Required schema namespace prefix: pdfaProperty
XmpPdfAExtensionSchemaDescribes the XMP extension schema which is provided by PDF/A-1.
XmpPdfAExtensionSchemaDescriptionRepresents the description of XMP extension schema which is provided by PDF/A-1.
XmpPdfAExtensionValueTypeThe PDF/A ValueType schema is required for all property value types which are not defined in the XMP 2004 specification, i.e. for value types outside of the following list: - Array types (these are container types which may contain one or more fields): Alt, Bag, Seq - Basic value types: Boolean, (open and closed) Choice, Date, Dimensions, Integer, Lang Alt, Locale, MIMEType, ProperName, Real, Text, Thumbnail, URI, URL, XPath - Media Management value types: AgentName, RenditionClass, ResourceEvent, ResourceRef, Version - Basic Job/Workflow value type: Job - EXIF schema value types: Flash, CFAPattern, DeviceSettings, GPSCoordinate, OECF/SFR, Rational Schema namespace URI: http://www.aiim.org/pdfa/ns/type# Required schema namespace prefix: pdfaType
XmpValueRepresents XMP value
XpsLoadOptionsRepresents options for loading/importing xps file into pdf document.
XpsSaveOptionsSave options for export to Xps format
XslFoLoadOptionsRepresents options for loading/importing XSL-FO file into pdf document.

Interfaces

InterfaceDescription
IColorSpaceConversionStrategyInterface for color space conversion strategies.
IIndexBitmapConverterThis interface declared for customization algorithms of quantization. Users can implement their own realization of this algorithms (for example algorithms based on unmanaged code).
INamedDestinationCollectionCollection of Named Destinations.
IOperatorSelectorDefines Visitor for visiting different pdf operators.
IPageSetOptionsDefines conversion options related to a set of pages to convert.
IPipelineOptionsDefines conversion options related to pipeline configuration.
ITeXInputDirectoryInterface of generalized TeX input directory.
ITeXOutputDirectoryInterface of generalized TeX output directory.
IWarningCallbackInterface for user’s callback mechanism support.

Enumeration

EnumerationDescription
AFRelationshipEnumeration describes associated files relationship.
BlendModeThe blend modes enumeration.
BorderCornerStyleEnumerates the border corner styles for border.
BorderSideEnumerates the border sides.
ColorSpaceThe color spaces enumeration.
ColorTypeSpecifies color type of elements on page.
ColumnAdjustmentEnumerates column adjustment types.
ContentDispositionMIME protocol Content-Disposition header.
ConvertErrorActionThis class represents action for conversion errors.
ConvertSoftMaskActionThis action represents actions for conversion of images with soft mask.
ConvertTransparencyActionThis class represents action for conversion of transparency.
CryptoAlgorithmRepresent type of cryptographic algorithm that used in encryption/decryption routines.
DigestHashAlgorithmRepresent type of algoritm that maps data to a “hash”
DirectionText direction.
ExtendedBooleanRepresents boolean type that supports Undefined value.
ExtractImageModeDefines different modes which can be used while extracting images from documents.
FileEncodingEncoding of the attached file. Possible values: Zip - file is compressed with ZIP, None - file is non compressed.
FixupThis enum represents an type of Fixup.
FontSubsetStrategyenumerates strategies for font subsetting
HorizontalAlignmentDescribes horizontal alignment.
HtmlDocumentTypeRepresents enumeration of the Html document types.
HtmlMediaTypeSpecifies possible media types used during rendering.
HtmlPageLayoutOptionSpecifies flags that together other options determine sizes and layouts of pages.
ImageDeleteActionAction which performed with image object when image is removed from collection. If image object is removed
ImageFileTypeEnumerates the image file types.
ImageFilterTypeEnumeration representing image filter type.
ImportFormatSpecifies import format.
LoadFormatSpecifies load format.
NumberingStyleEnumeration of supported page numbering style for PageLabel class.
PageCoordinateTypeDescribes page coordinate type.
PageLayoutDescibes page layout.
PageModeClass descibes used components of the document page.
PasswordTypeThis enum represents known password types used for password protected pdf documents.
PdfFormatThis class represents an pdf format.
PermissionsThis enum represents user’s permissions for a pdf.
PrintDuplexThe paper handling option to use when printing the file from the print dialog..
PrintScalingThe page scaling option that shall be selected when a print dialog is displayed for this document.
ProgressEventTypeThis enum describes possible progress event types that can occure during conversion
ReturnActionEnum represented a program workflow action in case of invoking the Warning method.
RotationEnumeration of possible rotation values.
SaveFormatSpecifies format
TableBrokenEnumerates the table broken.
TabOrderTab order on the page
TeXLoadResultResults for TeX load and compiling.
VerticalAlignmentEnumeration of possible vertical alignment values.
WarningTypeEnum represented warning type.
XfaTagThe xfa stream tag
XmpFieldTypeThis enum represents types of a XMP field.
XmpPdfAExtensionCategoryTypeProperty category: internal or external.