Aspose::Pdf Namespace Reference

Namespaces

 Annotations
 
 Collections
 
 CommonData
 
 Devices
 
 Drawing
 
 Engine
 
 Facades
 
 Forms
 
 GroupProcessor
 
 Interchange
 
 LicenseManagement
 
 LogicalStructure
 
 Operators
 
 Optimization
 
 PageModel
 
 PdfAOptionClasses
 
 Structure
 
 TaggedPdf
 
 Text
 
 Validation
 
 XfaConverter
 

Classes

class  Artifact
 Enumeration of possible artifacts subtype. More...
 
class  ArtifactCollection
 
class  AutoDetectedFormatLoadOptions
 Represents options for loading/importing PCL file into pdf document. More...
 
class  BackgroundArtifact
 Class descibes background artifact. This artifact allows to set background of the page. More...
 
class  BaseActionCollection
 Class incapsulates basic actions wuth page/annotation/field interactive actions More...
 
class  BaseOperatorCollection
 Represents base class for operator collection. More...
 
class  BaseParagraph
 Represents a abstract base object can be added to the page(doc.Paragraphs.Add()). More...
 
class  BorderInfo
 This class represents border for graphics elements. More...
 
class  Brush
 This class represents abstract brush More...
 
class  Cell
 Represents a cell of the table's row. More...
 
class  Cells
 Represents a cells collection of row. More...
 
class  CgmImportOptions
 Import option for import from Computer Graphics Metafile(CGM) format. More...
 
class  CgmLoadOptions
 Contains options for loading/importing CGM file into pdf document. More...
 
class  Collection
 Represents class for Collection(12.3.5 Collections). More...
 
class  Color
 Represents class for color value which can be expressed in different color space. More...
 
class  ColorSpaceConverter
 
class  ColumnInfo
 This class represents a columns info. More...
 
class  ComHelper
 Provides methods for COM clients to load a document into Aspose.Pdf. More...
 
class  CompositingParameters
 Represents an object containing graphics compositing parameters of current graphics state. More...
 
class  DestinationCollection
 Class 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. More...
 
class  DirectionConverter
 
class  DocSaveOptions
 Allows to specify .doc or .docx file format. More...
 
class  Document
 Class representing PDF document More...
 
class  DocumentFactory
 Class which allows to create/load documents of different types. More...
 
class  DocumentInfo
 Represents meta information of PDF document. More...
 
class  EmbeddedFileCollection
 Class representing embedded files collection. More...
 
class  EmptyValueException
 Exception which thrown when requirested value does not exists. More...
 
class  EpubLoadOptions
 Contains options for loading/importing EPUB file into pdf document. More...
 
class  ExcelSaveOptions
 Allows to specify .xls/xml or .xlsx file format. Default value is XMLSpreadSheet2003; More...
 
class  FileHyperlink
 Represents file hyperlink object. More...
 
class  FileParams
 Defines an embedded file parameter dictionary that shall contain additional file-specific information. More...
 
class  FileSpecification
 Class representing embedded file. More...
 
class  FloatingBox
 Represents a FloatingBox in a Pdf document. FloatingBox is custom positioned. More...
 
class  FontEmbeddingException
 The exception that is thrown when an attempt to embed font became failed More...
 
class  FontNotFoundException
 The exception that is thrown when a font is not found. More...
 
class  FooterArtifact
 Describes footer artifact. This may be used to set footer of the page. More...
 
class  FormattedFragment
 Represents abstract formatted fragment. More...
 
class  GraphInfo
 Represents graphics info. More...
 
class  Group
 A group attributes class specifying the attributes of the page’s page group for use in the transparent imaging model. More...
 
class  HeaderArtifact
 Class describes Heaader artifact. This artifacgt may be used to set heading of the page. More...
 
class  HeaderFooter
 Class represents header or footer pdf page. More...
 
class  Heading
 Represents heading. More...
 
class  HtmlLoadOptions
 Represents options for loading/importing html file into pdf document. More...
 
class  HtmlSaveOptions
 This enumeration defines rules which tune encoding logic More...
 
class  Hyperlink
 Represents abstract hyperlink. More...
 
class  IColorSpaceConversionStrategy
 Interface for color space conversion strategies. More...
 
class  Id
 Represents file identifier structure. More...
 
class  IIndexBitmapConverter
 This interface declared for customization algorithms of quantization. Users can implement their own realization of this algorithms (for example algorithms based on unmanaged code). More...
 
class  Image
 Represents image. More...
 
class  ImagePlacement
 Represents characteristics of an image placed to Pdf document page. More...
 
class  ImagePlacementAbsorber
 Represents an absorber object of image placement objects. Performs search of image usages and provides access to search results via ImagePlacementAbsorber::ImagePlacements collection. More...
 
class  ImagePlacementCollection
 Represents an image placements collection More...
 
class  ImageStamp
 Reresents graphic stamp. More...
 
class  ImportOptions
 ImportOptions type hold level of abstraction on individual import options. More...
 
class  INamedDestinationCollection
 Collection of Named Destinations. More...
 
class  IncorrectCMapUsageException
 The exception that is thrown when font usage is incorrect. More...
 
class  IncorrectFontUsageException
 The exception that is thrown when font usage is incorrect. More...
 
class  InvalidCgmFileFormatException
 The exception that is thrown when a Cgm file is invalid. More...
 
class  InvalidFileFormatException
 The exception that is thrown when a file is invalid. More...
 
class  InvalidFormTypeOperationException
 The exception that is thrown when an operation with form type is not valid. More...
 
class  InvalidPasswordException
 The exception that is thrown when invalid password is provided by user. More...
 
class  InvalidPdfFileFormatException
 The exception that is thrown when a pdf file is invalid. More...
 
class  InvalidValueFormatException
 Exception which thrown when requested value has incorrect format. More...
 
class  IOperatorSelector
 Defines Visitor for visiting different pdf operators. More...
 
class  ISupportsMemoryCleanup
 The interface defines ways to cleanup memory in case mass operations. More...
 
class  IWarningCallback
 Interface for user's callback mechanism support. More...
 
class  JavaScriptCollection
 This class represnets collection of JavaScript More...
 
class  LaTeXSaveOptions
 Save options for export to TeX format More...
 
class  Layer
 Represents page layer. More...
 
class  LevelFormat
 Represents format of the table of contents. More...
 
class  License
 Provides methods to license the component. More...
 
class  LicenseCore
 The actual code of the license class is put into an internal class and made into long functions to make it harder for the crackers to find anything meaningful after the dlls were cracked in November 2005. More...
 
class  LoadOptions
 ATTENTION! The feature implemented but did not put yet to public API since blocker issue in OSHARED layer revealed for sample document. More...
 
class  LocalHyperlink
 Represents local hyperlink object. More...
 
class  MarginInfo
 This class represents a margin for different objects. More...
 
class  Matrix
 Class represents transformation matrix. More...
 
class  Matrix3D
 Class represents transformation matrix. More...
 
class  Metadata
 Provides access to XMP metadata stream. More...
 
class  Metered
 Provides methods to set metered key. More...
 
class  MeteredBillingService
 This internal class is used to handle customer's matered state More...
 
class  MeteredCountService
 This internal class is used to handle customer's consumption data, the unit is MB. More...
 
class  MhtLoadOptions
 Represents options for loading/importing of .mht-file into pdf document. More...
 
class  MobiXmlSaveOptions
 Save options for export to Xml format More...
 
class  NamedDestinationCollection
 Class 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. More...
 
class  NamespaceDoc
 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. More...
 
class  Note
 This class represents generator paragraph note. More...
 
class  Operator
 Abstract class representing operator. More...
 
class  OperatorCollection
 
class  OperatorSelector
 This class is used for selecting operators using Visitor template idea. More...
 
class  Opi
 Represents The Open Prepress Interface (OPI) is a mechanism for creating low-resolution placeholders, or proxies, for such high-resolution images. More...
 
class  OutlineCollection
 Represents document outline hierarchy. More...
 
class  OutlineItemCollection
 Represents outline entry in outline hierarchy of PDF document. More...
 
class  Page
 Class representing page of PDF document. More...
 
class  PageActionCollection
 This class describes page actions More...
 
class  PageCollection
 Collection of PDF document pages. More...
 
class  PageInfo
 Represents the page information. More...
 
class  PageLabel
 Class representing Page Label range. More...
 
class  PageLabelCollection
 Class represeingting page label collection. More...
 
class  PageLayoutConverter
 
class  PageModeConverter
 
class  PageNumberStamp
 Represents page number stamp and used to number pages. More...
 
class  PageSize
 Class representing size of page in PDF document. More...
 
class  Paragraphs
 This class represents paragraph collection. More...
 
class  PclLoadOptions
 Enumerates conversion engines that can be used for conversion More...
 
class  PdfANonSpecificationFlags
 This 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. More...
 
class  PdfASymbolicFontEncodingStrategy
 This class describes rules which can be used to tune process of copy encoding data for cases when TrueType symbolic font has more than one encoding. Some PDF documents after conversion into PDF/A format could have 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 only one encoding subtable (3,0) must be leaved for this font in PDF/A document. 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 has no 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 QueueItem::CMapEncodingTableType is set, then relevant subtable will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration QueueItem::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 QueueItem::CMapEncodingTableType enumeration. More...
 
class  PdfException
 Represents errors that occur during PDF application execution. More...
 
class  PdfFormatConversionOptions
 Some documens have large size after converison into PDF/A format. To reduce file size for these documents it's necessary to define a strategy of fonts removing. This enumeration declares a strategies which can be used to optimize fonts usage. Every strategy from this enumeration has sense only when flag OptimizeFileSize is set. More...
 
class  PdfPageStamp
 Class represents stamp which uses PDF page as stamp. More...
 
class  PdfSaveOptions
 Save options for export to Pdf format More...
 
class  PluginLoadOptions
 Represents options for document loading/importing with the aid of a plugin. More...
 
class  PluginSaveOptions
 Save options for export to format that defined by a plugin More...
 
class  Point
 Represent point with fractional coordinates. More...
 
class  Point3D
 Represent point with fractional coordinates. More...
 
class  PptxSaveOptions
 Save options for export to SVG format More...
 
class  PrintDuplexConverter
 
class  PsLoadOptions
 Represents options for loading/importing of .mht-file into pdf document. More...
 
class  Rectangle
 Class represents rectangle. More...
 
class  RenderingOptions
 Represents rendering options. More...
 
class  Resources
 Class representing page resources. More...
 
class  RgbToDeviceGrayConversionStrategy
 Represents rgb to device gray color spaces conversion strategy. More...
 
class  Row
 Represents a row of the table. More...
 
class  Rows
 Represents a rows collection of table. More...
 
class  SaveOptions
 enumerates possible types of saved external resources More...
 
class  Stamp
 An abstract class for various kinds of stamps which come as descendants. More...
 
class  SvgLoadOptions
 Enumerates conversion engines that can be used for conversion More...
 
class  SvgSaveOptions
 enumerates possible types of image files that can be saved as external resources during during Pdf to SVG conversion More...
 
class  Table
 Represents a table that can be added to the page. More...
 
class  TextStamp
 Reresents textual stamp. More...
 
class  TimestampSettings
 Represents the ocsp settings using during signing process. More...
 
class  TocInfo
 Represents table of contents info. More...
 
class  UnifiedSaveOptions
 This class represents saving options for saving that uses unified conversion way (with unified internal document model) More...
 
class  UnsupportedFontTypeException
 The exception that is thrown when a font type is not supported. More...
 
class  WarningInfo
 Immutable object for encapsulating warning information. More...
 
class  Watermark
 Represents a watermark of the page. More...
 
class  WatermarkArtifact
 Class describes watermark artifact. This may be used to More...
 
class  WebHyperlink
 Represents web hyperlink object. More...
 
class  XForm
 Class represent XForm More...
 
class  XFormCollection
 Class represents collection of XFormCollection. More...
 
class  XImage
 Class representing image X-Object. More...
 
class  XImageCollection
 Class representing XImage collection. More...
 
class  XmlLoadOptions
 enumerates engine that loads XML that describes document More...
 
class  XmlSaveOptions
 Save options for export to Xml format More...
 
class  XmpPdfAExtensionField
 This 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. More...
 
class  XmpPdfAExtensionObject
 Represents the base class for field, property, value type instances. More...
 
class  XmpPdfAExtensionProperty
 Describes a single property. Schema namespace URI: http://www.aiim.org/pdfa/ns/property# Required schema namespace prefix: pdfaProperty More...
 
class  XmpPdfAExtensionSchema
 Describes the XMP extension schema which is provided by PDF/A-1. More...
 
class  XmpPdfAExtensionSchemaDescription
 Represents the description of XMP extension schema which is provided by PDF/A-1. More...
 
class  XmpPdfAExtensionValueType
 The 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: More...
 
class  XmpValue
 Represents XMP value More...
 
class  XpsLoadOptions
 Represents options for loading/importing xps file into pdf document. More...
 
class  XpsSaveOptions
 Save options for export to Xps format More...
 
class  XslFoLoadOptions
 Source XSLFO document can contain formatting errors. This enum enumerates possible strategies of handling of such formatting errors More...
 

Enumerations

enum  BlendMode {
  BlendMode::Normal, BlendMode::Multiply, BlendMode::Screen, BlendMode::Overlay,
  BlendMode::Darken, BlendMode::Lighten, BlendMode::ColorDodge, BlendMode::ColorBurn,
  BlendMode::HardLight, BlendMode::SoftLight, BlendMode::Difference, BlendMode::Exclusion,
  BlendMode::Hue, BlendMode::Saturation, BlendMode::Color, BlendMode::Luminosity,
  BlendMode::Compatible
}
 The blend modes enumeration. More...
 
enum  ColorSpace { ColorSpace::DeviceRGB, ColorSpace::DeviceCMYK, ColorSpace::DeviceGray }
 The color spaces enumeration. More...
 
enum  ColorType { ColorType::Rgb, ColorType::Grayscale, ColorType::BlackAndWhite, ColorType::Undefined }
 Specifies color type of elements on page. More...
 
enum  FontSubsetStrategy : uint8_t { FontSubsetStrategy::SubsetEmbeddedFontsOnly = 0, FontSubsetStrategy::SubsetAllFonts }
 enumerates strategies for font subsetting More...
 
enum  ContentDisposition { ContentDisposition::Inline = 0, ContentDisposition::Attachment = 1 }
 MIME protocol Content-Disposition header. More...
 
enum  Direction { Direction::L2R, Direction::R2L }
 Text direction. More...
 
enum  PageMode {
  PageMode::UseNone, PageMode::UseOutlines, PageMode::UseThumbs, PageMode::FullScreen,
  PageMode::UseOC, PageMode::UseAttachments
}
 Class descibes used components of the document page. More...
 
enum  ExtendedBoolean { ExtendedBoolean::Undefined, ExtendedBoolean::False, ExtendedBoolean::True }
 Represents boolean type that supports Undefined value. More...
 
enum  ExtractImageMode { ExtractImageMode::DefinedInResources = 0, ExtractImageMode::ActuallyUsed = 1 }
 Defines different modes which can be used while extracting images from documents. More...
 
enum  FileEncoding { FileEncoding::None, FileEncoding::Zip }
 Encoding of the attached file. Possible values: Zip - file is compressed with ZIP, None - file is non compressed. More...
 
enum  BorderCornerStyle { BorderCornerStyle::None = 0, BorderCornerStyle::Round = 1 }
 Enumerates the border corner styles for border. More...
 
enum  BorderSide {
  BorderSide::None = 0, BorderSide::Left = 1, BorderSide::Top = 2, BorderSide::Right = 4,
  BorderSide::Bottom = 8, BorderSide::All = 15, BorderSide::Box = 15
}
 Enumerates the border sides. More...
 
enum  ColumnAdjustment { ColumnAdjustment::Customized = 0, ColumnAdjustment::AutoFitToContent = 1, ColumnAdjustment::AutoFitToWindow = 2 }
 Enumerates column adjustment types. More...
 
enum  ImageFileType { ImageFileType::Unknown = 0, ImageFileType::Svg = 1, ImageFileType::Dicom, ImageFileType::Base64 }
 Enumerates the image file types. More...
 
enum  HorizontalAlignment {
  HorizontalAlignment::None, HorizontalAlignment::Left, HorizontalAlignment::Center, HorizontalAlignment::Right,
  HorizontalAlignment::Justify, HorizontalAlignment::FullJustify
}
 Describes horizontal alignment. More...
 
enum  HtmlDocumentType { HtmlDocumentType::Xhtml, HtmlDocumentType::Html5 }
 Represents enumeration of the Html document types. More...
 
enum  HtmlMediaType { HtmlMediaType::Print = 0, HtmlMediaType::Screen = 1 }
 Specifies possible media types used during rendering. More...
 
enum  ImageFilterType { ImageFilterType::Jpeg2000, ImageFilterType::Jpeg, ImageFilterType::Flate }
 Enumeration representing image filter type. More...
 
enum  ImportFormat { ImportFormat::Cgm = 1 }
 Specifies import format. More...
 
enum  ConvertErrorAction { ConvertErrorAction::Delete, ConvertErrorAction::None }
 This class represents action for conversion errors. More...
 
enum  ConvertTransparencyAction { ConvertTransparencyAction::Default, ConvertTransparencyAction::Mask }
 This class represents action for conversion of transparency. More...
 
enum  PdfFormat {
  PdfFormat::PDF_A_1A = 0, PdfFormat::PDF_A_1B, PdfFormat::PDF_A_2A, PdfFormat::PDF_A_3A,
  PdfFormat::PDF_A_2B, PdfFormat::PDF_A_2U, PdfFormat::PDF_A_3B, PdfFormat::PDF_A_3U,
  PdfFormat::v_1_3, PdfFormat::v_1_4, PdfFormat::v_1_5, PdfFormat::v_1_6,
  PdfFormat::v_1_7, PdfFormat::PDF_UA_1, PdfFormat::PDF_X_1A, PdfFormat::PDF_X_3
}
 This class represents an pdf format. More...
 
enum  EditionType { EditionType::Professional, EditionType::Enterprise }
 Specifies the edition type of the license. More...
 
enum  LicenseState { LicenseState::Evaluation, LicenseState::Licensed }
 Represents possible license states. More...
 
enum  LoadFormat {
  LoadFormat::CGM, LoadFormat::HTML, LoadFormat::EPUB, LoadFormat::XML,
  LoadFormat::XSLFO, LoadFormat::PCL, LoadFormat::XPS, LoadFormat::TEX,
  LoadFormat::SVG, LoadFormat::MHT, LoadFormat::PS, LoadFormat::Plugin,
  LoadFormat::AutoDetect
}
 Specifies load format. More...
 
enum  WarningType {
  WarningType::SourceFileCorruption = 0, WarningType::DataLoss = 1, WarningType::MajorFormattingLoss = 2, WarningType::MinorFormattingLoss = 3,
  WarningType::CompatibilityIssue = 4, WarningType::InvalidInputStreamType = 5, WarningType::UnexpectedContent = 99
}
 Enum represented warning type. More...
 
enum  ReturnAction { ReturnAction::Continue, ReturnAction::Abort }
 Enum represented a program workflow action in case of invoking the IWarningCallback::Warning(Aspose::Pdf::WarningInfo) method. More...
 
enum  MeteredState { MeteredState::Evaluation, MeteredState::Paid }
 Represents possible metered states. More...
 
enum  NumberingStyle {
  NumberingStyle::NumeralsArabic, NumberingStyle::NumeralsRomanUppercase, NumberingStyle::NumeralsRomanLowercase, NumberingStyle::LettersUppercase,
  NumberingStyle::LettersLowercase, NumberingStyle::None
}
 Enumeration of supported page numbering style for PageLabel class. More...
 
enum  PageCoordinateType { PageCoordinateType::MediaBox, PageCoordinateType::CropBox }
 Describes page coordinate type. More...
 
enum  PageLayout {
  PageLayout::SinglePage, PageLayout::OneColumn, PageLayout::TwoColumnLeft, PageLayout::TwoColumnRight,
  PageLayout::TwoPageLeft, PageLayout::TwoPageRight, PageLayout::Default
}
 Descibes page layout. More...
 
enum  PasswordType { PasswordType::None, PasswordType::User, PasswordType::Owner, PasswordType::Inaccessible }
 This enum represents known password types used for password protected pdf documents. More...
 
enum  Permissions {
  Permissions::PrintDocument = static_cast<int32_t>(1 << 2), Permissions::ModifyContent = static_cast<int32_t>(1 << 3), Permissions::ExtractContent = static_cast<int32_t>(1 << 4), Permissions::ModifyTextAnnotations = static_cast<int32_t>(1 << 5),
  Permissions::FillForm = static_cast<int32_t>(1 << 8), Permissions::ExtractContentWithDisabilities = static_cast<int32_t>(1 << 9), Permissions::AssembleDocument = static_cast<int32_t>(1 << 10), Permissions::PrintingQuality = static_cast<int32_t>(1 << 11)
}
 This enum represents user's permissions for a pdf. More...
 
enum  PrintDuplex { PrintDuplex::Simplex, PrintDuplex::DuplexFlipShortEdge, PrintDuplex::DuplexFlipLongEdge }
 The paper handling option to use when printing the file from the print dialog.. More...
 
enum  Rotation { Rotation::None, Rotation::on90, Rotation::on180, Rotation::on270 }
 Enumeration of possible rotation values. More...
 
enum  SaveFormat {
  SaveFormat::Pdf = 0, SaveFormat::None = 0, SaveFormat::Doc = 1, SaveFormat::Xps = 2,
  SaveFormat::Html = 3, SaveFormat::Xml = 4, SaveFormat::TeX = 5, SaveFormat::DocX = 6,
  SaveFormat::Svg = 7, SaveFormat::MobiXml = 8, SaveFormat::Excel = 9, SaveFormat::Epub = 10,
  SaveFormat::Plugin = 11, SaveFormat::Pptx = 14
}
 Specifies format More...
 
enum  CryptoAlgorithm { CryptoAlgorithm::RC4x40, CryptoAlgorithm::RC4x128, CryptoAlgorithm::AESx128, CryptoAlgorithm::AESx256 }
 Represent type of cryptographic algorithm that used in encryption/decryption routines. More...
 
enum  TableBroken { TableBroken::None = 0, TableBroken::Vertical = 1, TableBroken::VerticalInSamePage = 2 }
 Enumerates the table broken. More...
 
enum  TabOrder {
  TabOrder::None, TabOrder::Row, TabOrder::Column, TabOrder::Default,
  TabOrder::Manual
}
 Tab order on the page More...
 
enum  ProgressEventType { ProgressEventType::TotalProgress, ProgressEventType::SourcePageAnalized, ProgressEventType::ResultPageCreated, ProgressEventType::ResultPageSaved }
 This enum describes possible progress event types that can occure during conversion More...
 
enum  VerticalAlignment { VerticalAlignment::None, VerticalAlignment::Top, VerticalAlignment::Center, VerticalAlignment::Bottom }
 Enumeration of possible vertical alignment values. More...
 
enum  XmpPdfAExtensionCategoryType { XmpPdfAExtensionCategoryType::Internal, XmpPdfAExtensionCategoryType::External }
 Property category: internal or external. More...
 

Functions

bool operator== (System::SharedPtr< Color > const &x, System::SharedPtr< Color > const &y)
 
bool operator!= (System::SharedPtr< Color > const &x, System::SharedPtr< Color > const &y)
 
 DECLARE_ENUM_OPERATORS (Aspose::Pdf::PdfFormatConversionOptions::RemoveFontsStrategy)
 
 DECLARE_ENUM_OPERATORS (Aspose::Pdf::Permissions)
 

Enumeration Type Documentation

◆ BlendMode

The blend modes enumeration.

Enumerator
Normal 

Normal blend mode.

Multiply 

Multiply blend mode.

Screen 

Screen blend mode.

Overlay 

Overlay blend mode.

Darken 

Darken blend mode.

Lighten 

Lighten blend mode.

ColorDodge 

ColorDodge blend mode.

ColorBurn 

ColorBurn blend mode.

HardLight 

HardLight blend mode.

SoftLight 

SoftLight blend mode.

Difference 

Difference blend mode.

Exclusion 

Exclusion blend mode.

Hue 

Hue blend mode.

Saturation 

Saturation blend mode.

Color 

Color blend mode.

Luminosity 

Luminosity blend mode.

Compatible 

Compatible blend mode.

◆ BorderCornerStyle

Enumerates the border corner styles for border.

Enumerator
None 

None border style.

Round 

Round border style.

◆ BorderSide

Enumerates the border sides.

Enumerator
None 

No border.

Left 

Left border.

Top 

Top border.

Right 

Right border.

Bottom 

Bottom border.

All 

All sides borders.It has the same meaning when useing "Box" and will be replaced by "Box" one year later. So, please use "Box" if possible.

Box 

Four sides borders.

◆ ColorSpace

The color spaces enumeration.

Enumerator
DeviceRGB 

The device-dependent RGB color space.

DeviceCMYK 

The device-dependent CMYK color space.

DeviceGray 

The device-dependent gray color space.

◆ ColorType

Specifies color type of elements on page.

Enumerator
Rgb 

RGB color type.

Grayscale 

Grayscale color type.

BlackAndWhite 

Black and white color type.

Undefined 

Undefined color type value.

◆ ColumnAdjustment

Enumerates column adjustment types.

Enumerator
Customized 

Customized.

AutoFitToContent 

Auto fit to content.

AutoFitToWindow 

Auto fit to window.

◆ ContentDisposition

MIME protocol Content-Disposition header.

Enumerator
Inline 

Result is shown inline.

Attachment 

Result is saved as attachment.

◆ ConvertErrorAction

This class represents action for conversion errors.

Enumerator
Delete 

Delete convert errors.

None 

Do nothing with convert errors.

◆ ConvertTransparencyAction

This class represents action for conversion of transparency.

Enumerator
Default 

Use default strategy, no adding masks.

Mask 

Add transparent mask image.

◆ CryptoAlgorithm

Represent type of cryptographic algorithm that used in encryption/decryption routines.

Enumerator
RC4x40 

RC4 with key length 40.

RC4x128 

RC4 with key length 128.

AESx128 

AES with key length 128.

AESx256 

AES with key length 256.

◆ Direction

Text direction.

Enumerator
L2R 

Left to right direction.

R2L 

Right to left direction.

◆ EditionType

Specifies the edition type of the license.

Enumerator
Professional 
Enterprise 

◆ ExtendedBoolean

Represents boolean type that supports Undefined value.

Enumerator
Undefined 

Undefined value value of ExtendnedBoolean.

False 

False value of ExtendnedBoolean.

True 

True value of ExtendnedBoolean.

◆ ExtractImageMode

Defines different modes which can be used while extracting images from documents.

Enumerator
DefinedInResources 

Defines image extraction mode in which all images defined in resources for particular page are extracted.

ActuallyUsed 

Defines image extraction mode in which only those images are extracted that are actually shown on a page.

◆ FileEncoding

Encoding of the attached file. Possible values: Zip - file is compressed with ZIP, None - file is non compressed.

Enumerator
None 

File is not compressed.

Zip 

File is compressed with ZIP algorithhm.

◆ FontSubsetStrategy

enum Aspose::Pdf::FontSubsetStrategy : uint8_t
strong

enumerates strategies for font subsetting

Enumerator
SubsetEmbeddedFontsOnly 

Declares to subset only fonts which are embedded in document already

SubsetAllFonts 

Declares to subsets all the fonts, non-embedded and embedded both

◆ HorizontalAlignment

Describes horizontal alignment.

Enumerator
None 

No alignment.

Left 

Align to left.

Center 

Center alignment.

Right 

Align to right.

Justify 

Justify alignment. Text will be aligned on both left and right margins.

FullJustify 

Similar to 'Justify' alignment, except that the very last line will only be left-aligned in 'Justify' mode, while in 'FullJustify' mode all lines will be left- and right-aligned.

◆ HtmlDocumentType

Represents enumeration of the Html document types.

Enumerator
Xhtml 

The XHtml Document Type.

Html5 

The HTML5 Document Type.

◆ HtmlMediaType

Specifies possible media types used during rendering.

Enumerator
Print 
Screen 

◆ ImageFileType

Enumerates the image file types.

Enumerator
Unknown 

Unknown type.

Svg 

svg image file type.

Dicom 

Dicom image file type.

Base64 

Base64 image file type.

◆ ImageFilterType

Enumeration representing image filter type.

Enumerator
Jpeg2000 
Jpeg 
Flate 

◆ ImportFormat

Specifies import format.

Enumerator
Cgm 

Computer Graphics Metafile format.

◆ LicenseState

Represents possible license states.

Enumerator
Evaluation 

The license is Evaluation

Licensed 

The license is a proper valid license.

◆ LoadFormat

Specifies load format.

Enumerator
CGM 

means loading of document in CGM format

HTML 

means loading of document in HTML format

EPUB 

means loading of document in EPUB format(special format of e-books)

XML 

means loading of document in XML format(special XML that represent logical structure of PDF document)

XSLFO 

means loading of document in XSLFO format

PCL 

means loading of document in PCL format

XPS 

means loading of document in XPS format

TEX 

means loading of document in TEX format - format of Latex text editor

SVG 

means loading of document in SVG format - format of Latex text editor

MHT 

means loading of document in MHT format(that is packed HTML format)

PS 

means loading of document in PS format(format of PostScript document)

Plugin 

means loading of document with the aid of a plugin

AutoDetect 

This option allows to loading engine try detection of format itself Currently only SVG,XML,XSLFO formats can be autodetected. If engine cannot detect type of file, HTML will be used. This logic came from old GEnerator cause method itself came from old Genedrator

◆ MeteredState

Represents possible metered states.

Enumerator
Evaluation 

The metered is evaluation

Paid 

The metered is a paid customer.

◆ NumberingStyle

Enumeration of supported page numbering style for PageLabel class.

Enumerator
NumeralsArabic 

Arabic decimal numbers.

NumeralsRomanUppercase 

Uppercase roman numbers (I, II, III...).

NumeralsRomanLowercase 

Lowercase roman numbers (i, ii, iii...).

LettersUppercase 

Uppercase latin letters (A, B, C...).

LettersLowercase 

Lowercase latin letters (a, b, c...).

None 

No numbering.

◆ PageCoordinateType

Describes page coordinate type.

Enumerator
MediaBox 

The MediaBox is used to specify the width and height of the page. For the average user, this probably equals the actual page size. The MediaBox is the largest page box in a PDF. The other page boxes can equal the size of the MediaBox but they cannot be larger.

CropBox 

The CropBox defines the region to which the page contents are to be clipped. Acrobat uses this size for screen display and printing.

◆ PageLayout

Descibes page layout.

Enumerator
SinglePage 

Single page.

OneColumn 

Display the pages in one column.

TwoColumnLeft 

Display the pages in two columns, with odd-numbered pages on the left.

TwoColumnRight 

Display the pages in two columns, with odd-numbered pages on the right.

TwoPageLeft 

Display the pages two at a time, with odd-numbered pages on the left.

TwoPageRight 

Display the pages two at a time, with odd-numbered pages on the right.

Default 

Default layout.

◆ PageMode

enum Aspose::Pdf::PageMode
strong

Class descibes used components of the document page.

Enumerator
UseNone 

Dont use any components.

UseOutlines 

Document outline visible.

UseThumbs 

Thumbnail images visible.

FullScreen 

FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible.

UseOC 

Optional content group panel visible.

UseAttachments 

Attachments panel visible.

◆ PasswordType

This enum represents known password types used for password protected pdf documents.

Enumerator
None 

Pdf document is not password protected.

User 

Pdf document was opened using document open password (restricted access).

Owner 

Pdf document was opened using change permissions password (full access).

Inaccessible 

Pdf document is password protected but both user and owner passwords are not empty and none of the passwords was defined or supplied password was incorrect. So it impossible to deduce the type of the password.

◆ PdfFormat

This class represents an pdf format.

Enumerator
PDF_A_1A 

Pdf/A-1a format.

PDF_A_1B 

Pdf/A-1b format.

PDF_A_2A 

Pdf/A-2a format.

PDF_A_3A 

Pdf/A-3a format.

PDF_A_2B 

Pdf/A-2b format.

PDF_A_2U 

Pdf/A-2u format.

PDF_A_3B 

Pdf/A-3b format.

PDF_A_3U 

Pdf/A-3u format.

v_1_3 

Adobe version 1.3.

v_1_4 

Adobe version 1.4.

v_1_5 

Adobe version 1.5.

v_1_6 

Adobe version 1.6.

v_1_7 

Adobe version 1.7.

PDF_UA_1 

PDF/UA-1 format.

PDF_X_1A 

PDF/X-1a format.

PDF_X_3 

PDF/X-3 format.

◆ Permissions

This enum represents user's permissions for a pdf.

Enumerator
PrintDocument 

(Security handlers of revision 2) Print the document. (Security handlers of revision 3 or greater) Print the document (possibly not at the highest quality level, depending on whether PrintingQuality is also set).

ModifyContent 

Modify the contents of the document by operations other than those controlled by ModifyTextAnnotations, FillForm, and 11.

ExtractContent 

(Security handlers of revision 2) Copy or otherwise extract text and graphics from the document, including extracting text and graphics (in support of accessibility to users with disabilities or for other purposes). (Security handlers of revision 3 or greater) Copy or otherwise extract text and graphics from the document by operations other than that controlled by ExtractContentWithDisabilities.

ModifyTextAnnotations 

Add or modify text annotations, fill in interactive form fields, and, if ModifyContent is also set, create or modify interactive form fields (including signature fields).

FillForm 

(Security handlers of revision 3 or greater) Fill in existing interactive form fields (including signature fields), even if ModifyTextAnnotations is clear.

ExtractContentWithDisabilities 

(Security handlers of revision 3 or greater) Extract text and graphics (in support of accessibility to users with disabilities or for other purposes).

AssembleDocument 

(Security handlers of revision 3 or greater) Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if ModifyContent is clear.

PrintingQuality 

(Security handlers of revision 3 or greater) Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this bit is clear (and bit 3 is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality.

◆ PrintDuplex

The paper handling option to use when printing the file from the print dialog..

Enumerator
Simplex 

Print single-sided.

DuplexFlipShortEdge 

Duplex and flip on the short edge of the sheet.

DuplexFlipLongEdge 

Duplex and flip on the long edge of the sheet.

◆ ProgressEventType

This enum describes possible progress event types that can occure during conversion

Enumerator
TotalProgress 

means that occured event informs about total progress of conversion

SourcePageAnalized 

means that occured event informs about end of analysys of one of pages before conversion

ResultPageCreated 

means that occured event informs about creation of one result page before phisical export

ResultPageSaved 

means that occured event informs about finished saving of one result page

◆ ReturnAction

Enum represented a program workflow action in case of invoking the IWarningCallback::Warning(Aspose::Pdf::WarningInfo) method.

Enumerator
Continue 

Used for continue flow.

Abort 

Used for abort flow.

◆ Rotation

enum Aspose::Pdf::Rotation
strong

Enumeration of possible rotation values.

Enumerator
None 

Non-rotated.

on90 

Rotated on 90 degrees clockwise.

on180 

Rotated on 180 degrees.

on270 

Rotated on 270 degrees clockwise.

◆ SaveFormat

Specifies format

Enumerator
Pdf 

means saving without change of format, i.e. as PDF use it please instead of 'SaveFormat.None', that is obsolete one

None 

means saving without change of format, i.e. as PDF It's obsolete one and will be deleted eventually, please use instead 'SaveFormat.Pdf'

Doc 

means saving in DOC format

Xps 

means saving in XPS format

Html 

means saving in HTML format

Xml 

means saving in XML format

TeX 

means saving in TEX format i.e. format suitable for Latex text editor

DocX 

means saving in DOCX format

Svg 

means saving in SVG format

MobiXml 

means saving in MobiXML format(special format of e-books)

Excel 

means saving in MsExcel format

Epub 

means saving in EPUB format(special format of e-books)

Plugin 

means saving with the aid of a plugin

Pptx 

means saving in MHT(WebArchieve)

Convet document to Mht format. This code was experimental one used during works related to https://pdf.aspose.com/jira/browse/PDFNEWNET-36340 is not going on production, cause there are cross-browsers problems with created MHT - so, it can be used in the future if finally it will be necessary to create MHT itself. PDFNEWNET-36340 was resolved with usage of DataSceme URLs(embedding data into HTML http://en.wikipedia.org/wiki/Data_URI_scheme) So, this conversion really not used right now.

///

means saving in PPTX format

◆ TableBroken

Enumerates the table broken.

Enumerator
None 

No broken.

Vertical 

Vertical broken.

VerticalInSamePage 

Vertical broken in same page.

◆ TabOrder

enum Aspose::Pdf::TabOrder
strong

Tab order on the page

Enumerator
None 

No tab order.

Row 

Row order.

Column 

Column order.

Default 

Default tab order.

Manual 

Manual tab order.

◆ VerticalAlignment

Enumeration of possible vertical alignment values.

Enumerator
None 

No alignment (use specified position).

Top 

Align to top.

Center 

Center alignment.

Bottom 

Align to bottom.

◆ WarningType

Enum represented warning type.

Enumerator
SourceFileCorruption 

The file is corrupted.

DataLoss 

Text/chart/image or other data is completely missing from either the documet tree following load, or the created document following save.

MajorFormattingLoss 

Major formatting losses compared to the original document. This is for occasions when the formatting loss is substantial but the data is still there.

MinorFormattingLoss 

Minor formatting losses compared to the original document. This is for minor losses of fidelity.

CompatibilityIssue 

Known issue that will prevent the document being opened by certain user agents, or previous versions of user agents.

InvalidInputStreamType 

Invalid input stream type

UnexpectedContent 

The file has unexpected content.

◆ XmpPdfAExtensionCategoryType

Property category: internal or external.

Enumerator
Internal 

Internal properties are created automatically from document content.

External 

External properties are based on user input.

Function Documentation

◆ DECLARE_ENUM_OPERATORS() [1/2]

Aspose::Pdf::DECLARE_ENUM_OPERATORS ( Aspose::Pdf::Permissions  )

◆ DECLARE_ENUM_OPERATORS() [2/2]

Aspose::Pdf::DECLARE_ENUM_OPERATORS ( Aspose::Pdf::PdfFormatConversionOptions::RemoveFontsStrategy  )

◆ operator!=()

bool Aspose::Pdf::operator!= ( System::SharedPtr< Color > const &  x,
System::SharedPtr< Color > const &  y 
)

◆ operator==()

bool Aspose::Pdf::operator== ( System::SharedPtr< Color > const &  x,
System::SharedPtr< Color > const &  y 
)