Aspose::Pdf Namespace Reference

Namespaces

 Collections
 
 Devices
 
 DOM
 
 Drawing
 
 Engine
 
 Exceptions
 
 Facades
 
 Generator
 
 InteractiveFeatures
 
 Operators
 
 PageModel
 
 Structure
 
 Tests
 
 Text
 

Classes

class  Artifact
 Enumeration of possible artifacts subtype. More...
 
class  ArtifactCollection
 
class  AssemblyConstants
 Defines the constants that participate in the license check for the component. These used to be defined directly as assembly attributes, but I moved them into separate class because in .NET Compact Framework I cannot access assembly attributes. Now the licensing code when compiled for the .NET Compact Framework uses these constants instead of the assembly attributes. 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  BuildVersionInfo
 This class provides information about current product build. 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  DocumentInfo
 Represents meta information of PDF document. More...
 
class  EmbeddedFileCollection
 Class representing embedded files collection. More...
 
class  EpubLoadOptions
 Contains options for loading/importing EPUB file into pdf document. More...
 
class  ExcelSaveOptions
 Save options for export to Excel format 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  FooterArtifact
 Describes footer artifact. This may be used to set footer of the page. 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  Hyperlink
 Represents abstract hyperlink. 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  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  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
 LoadOptions type holds level of abstraction on individual load options More...
 
class  LocalHyperlink
 Represents local hyperlink object. More...
 
class  MarginInfo
 This class represents a margin for different objects. More...
 
class  Metadata
 Provides access to XMP metadata stream. More...
 
class  MobiXmlSaveOptions
 Save options for export to Xml format 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  NewParagraphPlacementInfo
 This class represents a placement info for new paragraph. 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  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  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  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  Rectangle
 Class represents rectangle. More...
 
class  RenderingOptions
 Represents rendering options. More...
 
class  Resources
 Class representing page resources. 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  Selector
 Base abstract class for selecting routines which are defined in concrete descendants. More...
 
class  Stamp
 An abstract class for various kinds of stamps which come as descendants. 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 enum describes possible progress event types that can occure during conversion 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
 Represents options for loading/importing XML file into pdf 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  XpsLoadOptions
 Represents options for loading/importing xps file into pdf document. More...
 
class  XpsSaveOptions
 Save options for export to Xps format More...
 
class  XslFoLoadOptions
 Represents options for loading/importing XSL-FO file into pdf document. 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
}
 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  ContentDisposition { ContentDisposition::Inline = 0, ContentDisposition::Attachment = 1 }
 MIME protocol Content-Disposition header. More...
 
enum  Direction { Direction::L2R, Direction::R2L }
 Text direction. 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 }
 Enumerates column adjustment types. More...
 
enum  ImageFileType { ImageFileType::Unknown = 0, ImageFileType::Svg = 1 }
 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  ImportFormat { ImportFormat::Cgm = 1 }
 Specifies import format. More...
 
enum  ConvertErrorAction { ConvertErrorAction::Delete, ConvertErrorAction::None }
 This class represents action for conversion errors. 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_3B, PdfFormat::v_1_3, PdfFormat::v_1_4,
  PdfFormat::v_1_5, PdfFormat::v_1_6, PdfFormat::v_1_7, 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::XPS, 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::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  NumberingStyle {
  NumberingStyle::None, NumberingStyle::NumeralsArabic, NumberingStyle::NumeralsRomanUppercase, NumberingStyle::NumeralsRomanLowercase,
  NumberingStyle::LettersUppercase, NumberingStyle::LettersLowercase
}
 Enumeration of supported page numbering style for PageLabel class. 'None' should be first item to be compatible with c++ 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 = 1 << 2, Permissions::ModifyContent = 1 << 3, Permissions::ExtractContent = 1 << 4, Permissions::ModifyTextAnnotations = 1 << 5,
  Permissions::FillForm = 1 << 8, Permissions::ExtractContentWithDisabilities = 1 << 9, Permissions::AssembleDocument = 1 << 10, Permissions::PrintingQuality = 1 << 11
}
 This enum represents user's permissions for a pdf. 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::Xml = 4, SaveFormat::DocX = 6, SaveFormat::MobiXml = 8, SaveFormat::Excel = 9,
  SaveFormat::Epub = 10, SaveFormat::Plugin = 11
}
 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  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 > x, System::SharedPtr< Color > y)
 
bool operator!= (System::SharedPtr< Color > x, System::SharedPtr< Color > y)
 
 DECLARE_ENUM_OPERATORS (Aspose::Pdf::Permissions)
 
 DECLARE_ENUM_OPERATORS (Aspose::Pdf::CryptoAlgorithm)
 

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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ ImageFileType

Enumerates the image file types.

Enumerator
Unknown 

Unknown type.

Svg 

svg image file type.

◆ 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

XPS 

means loading of document in XPS format

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

◆ NumberingStyle

Enumeration of supported page numbering style for PageLabel class. 'None' should be first item to be compatible with c++

Enumerator
None 

No numbering.

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...).

◆ 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.

◆ 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_3B 

Pdf/A-3b 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_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.

◆ 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

Xml 

means saving in XML format

DocX 

means saving in DOCX 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

◆ 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.

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::CryptoAlgorithm  )

◆ DECLARE_ENUM_OPERATORS() [2/2]

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

◆ operator!=()

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

◆ operator==()

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