Class representing PDF document More...

#include "Document.h"

Inherits System::IDisposable, Aspose::Pdf::ISupportsMemoryCleanup, and Aspose::Pdf::LicenseManagement::IVentureLicenseTarget.

Classes
class	CutByRestrictionWrapper

class	IDocumentFontUtilities
	Holds functionality to tune fonts More...

class	MergeOptions
	Represents the options to Merge methods. More...

class	OptimizationOptions
	Class which describes document optimization algorithm. Instance of this class may be used as parameter of OptimizeResources() method. More...

class	RepairOptions
	Represents options for repairing a PDF document. More...

Public Types
using	FontSubstitutionHandler = System::MulticastDelegate< void(System::SharedPtr< Text::Font >, System::SharedPtr< Text::Font >)>
	Represents the method that will handle FontSubstitution event. More...

using	CallBackGetHocr = System::MulticastDelegate< System::String(System::SharedPtr< System::Drawing::Image >)>
	The call back procedure for hocr recognize. More...

using	CallBackGetHocrWithPage = System::MulticastDelegate< System::String(System::SharedPtr< System::Drawing::Image >, System::SharedPtr< Page >)>
	The call back procedure for hocr recognize. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
ASPOSE_PDF_SHARED_API System::SharedPtr< JavaScriptCollection >	get_JavaScript ()
	Collection of JavaScript of document level. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::OutputIntents >	get_OutputIntents ()
	Gets the collection of Output intents in the document. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::PageInfo >	get_PageInfo ()
	Gets the page info.(for generator only, not filled in when reading document) More...

ASPOSE_PDF_SHARED_API void	set_PageInfo (System::SharedPtr< Aspose::Pdf::PageInfo > value)
	Sets the page info.(for generator only, not filled in when reading document) More...

ASPOSE_PDF_SHARED_API bool	get_EnableSignatureSanitization () const
	Gets flag to manage signature fields sanitization. Enabled by default. More...

ASPOSE_PDF_SHARED_API void	set_EnableSignatureSanitization (bool value)
	Sets flag to manage signature fields sanitization. Enabled by default. More...

ASPOSE_PDF_SHARED_API bool	get_IsPdfaCompliant ()
	Gets the is document pdfa compliant. More...

ASPOSE_PDF_SHARED_API bool	get_IsPdfUaCompliant ()
	Gets the is document pdfua compliant. More...

ASPOSE_PDF_SHARED_API bool	get_IsXrefGapsAllowed ()
	Gets the is document pdfa compliant. More...

ASPOSE_PDF_SHARED_API void	set_IsXrefGapsAllowed (bool value)
	Sets the is document pdfa compliant. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< NamedDestinationCollection >	get_NamedDestinations ()
	Collection of Named Destination in the document. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< DestinationCollection >	get_Destinations ()
	Gets the collection of destinations. Obsolete. Please use NamedDestinations. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfFormat	get_PdfFormat ()
	Gets PDF format More...

ASPOSE_PDF_SHARED_API bool	get_EmbedStandardFonts () const
	Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true. All PDF fonts can be embedded into document simply via setting of flag IsEmbedded into true, but PDF standard Type1 fonts is an exception from this rule. Standard Type1 font embedding requires much time, so to embed these fonts it's necessary not only set flag IsEmbedded into true for specified font but also set an additiona flag on document's level - EmbedStandardFonts = true; This property can be set only one time for all fonts. By default false. More...

ASPOSE_PDF_SHARED_API void	set_EmbedStandardFonts (bool value)
	Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true. All PDF fonts can be embedded into document simply via setting of flag IsEmbedded into true, but PDF standard Type1 fonts is an exception from this rule. Standard Type1 font embedding requires much time, so to embed these fonts it's necessary not only set flag IsEmbedded into true for specified font but also set an additiona flag on document's level - EmbedStandardFonts = true; This property can be set only one time for all fonts. By default false. More...

ASPOSE_PDF_SHARED_API bool	get_DisableFontLicenseVerifications () const
	Many operations with font can't be executed if these operations are prohibited by license of this font. For example some font can't be embedded into PDF document if license rules disable embedding for this font. This flag is used to disable any license restrictions for all fonts in current PDF document. Be careful when using this flag. When it is set it means that person who sets this flag, takes all responsibility of possible license/law violations on himself. So He takes it on it's own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false. More...

ASPOSE_PDF_SHARED_API void	set_DisableFontLicenseVerifications (bool value)
	Many operations with font can't be executed if these operations are prohibited by license of this font. For example some font can't be embedded into PDF document if license rules disable embedding for this font. This flag is used to disable any license restrictions for all fonts in current PDF document. Be careful when using this flag. When it is set it means that person who sets this flag, takes all responsibility of possible license/law violations on himself. So He takes it on it's own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Document::IDocumentFontUtilities >	get_FontUtilities ()
	IDocumentFontUtilities instance More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Collection >	get_Collection ()
	Gets collection of document. More...

ASPOSE_PDF_SHARED_API void	set_Collection (System::SharedPtr< Aspose::Pdf::Collection > value)
	Gets collection of document. More...

ASPOSE_PDF_SHARED_API System::String	get_Version ()
	Gets a version of Pdf from Pdf file header. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Annotations::IAppointment >	get_OpenAction ()
	Gets action performed at document opening. More...

ASPOSE_PDF_SHARED_API void	set_OpenAction (System::SharedPtr< Annotations::IAppointment > value)
	Sets action performed at document opening. More...

ASPOSE_PDF_SHARED_API bool	get_HideToolBar ()
	Gets flag specifying whether toolbar should be hidden when document is active. More...

ASPOSE_PDF_SHARED_API void	set_HideToolBar (bool value)
	Sets flag specifying whether toolbar should be hidden when document is active. More...

ASPOSE_PDF_SHARED_API bool	get_HideMenubar ()
	Gets flag specifying whether menu bar should be hidden when document is active. More...

ASPOSE_PDF_SHARED_API void	set_HideMenubar (bool value)
	Sets flag specifying whether menu bar should be hidden when document is active. More...

ASPOSE_PDF_SHARED_API bool	get_HideWindowUI ()
	Gets flag specifying whether user interface elements should be hidden when document is active. More...

ASPOSE_PDF_SHARED_API void	set_HideWindowUI (bool value)
	Sets flag specifying whether user interface elements should be hidden when document is active. More...

ASPOSE_PDF_SHARED_API bool	get_FitWindow ()
	Gets flag specifying whether document window must be resized to fit the first displayed page. More...

ASPOSE_PDF_SHARED_API void	set_FitWindow (bool value)
	Sets flag specifying whether document window must be resized to fit the first displayed page. More...

ASPOSE_PDF_SHARED_API bool	get_CenterWindow ()
	Gets flag specifying whether position of the document's window will be centerd on the screen. More...

ASPOSE_PDF_SHARED_API void	set_CenterWindow (bool value)
	Sets flag specifying whether position of the document's window will be centerd on the screen. More...

ASPOSE_PDF_SHARED_API bool	get_DisplayDocTitle ()
	Gets flag specifying whether document's window title bar should display document title. More...

ASPOSE_PDF_SHARED_API void	set_DisplayDocTitle (bool value)
	Sets flag specifying whether document's window title bar should display document title. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< PageCollection >	get_Pages ()
	Gets collection of document pages. Note that pages are numbered from 1 in collection. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< OutlineCollection >	get_Outlines ()
	Gets document outlines. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Annotations::DocumentActionCollection >	get_Actions ()
	Gets document actions. This property is instance of DocumentActions class which allows to get/set BeforClosing, BeforSaving, etc. actions. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Forms::Form >	get_Form ()
	Gets Acro Form of the document. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< EmbeddedFileCollection >	get_EmbeddedFiles ()
	Gets collection of files embedded to document. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::Direction	get_Direction ()
	Gets reading order of text: L2R (left to right) or R2L (right to left). More...

ASPOSE_PDF_SHARED_API void	set_Direction (Aspose::Pdf::Direction value)
	Sets reading order of text: L2R (left to right) or R2L (right to left). More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::PageMode	get_PageMode ()
	Gets page mode, specifying how document should be displayed when opened. More...

ASPOSE_PDF_SHARED_API void	set_PageMode (Aspose::Pdf::PageMode value)
	Sets page mode, specifying how document should be displayed when opened. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::PageMode	get_NonFullScreenPageMode ()
	Gets page mode, specifying how to display the document on exiting full-screen mode. More...

ASPOSE_PDF_SHARED_API void	set_NonFullScreenPageMode (Aspose::Pdf::PageMode value)
	Sets page mode, specifying how to display the document on exiting full-screen mode. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::PageLayout	get_PageLayout ()
	Gets page layout which shall be used when the document is opened. More...

ASPOSE_PDF_SHARED_API void	set_PageLayout (Aspose::Pdf::PageLayout value)
	Sets page layout which shall be used when the document is opened. More...

ASPOSE_PDF_SHARED_API PrintDuplex	get_Duplex ()
	Gets print duplex mode handling option to use when printing the file from the print dialog. More...

ASPOSE_PDF_SHARED_API void	set_Duplex (PrintDuplex value)
	Sets print duplex mode handling option to use when printing the file from the print dialog. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::PrintScaling	get_PrintScaling ()
	Gets the page scaling option that shall be selected when a print dialog is displayed for this document. More...

ASPOSE_PDF_SHARED_API void	set_PrintScaling (Aspose::Pdf::PrintScaling value)
	Sets the page scaling option that shall be selected when a print dialog is displayed for this document. More...

ASPOSE_PDF_SHARED_API bool	get_PickTrayByPdfSize ()
	Gets a flag specifying whether the PDF page size shall be used to select the input paper tray. More...

ASPOSE_PDF_SHARED_API void	set_PickTrayByPdfSize (bool value)
	Sets a flag specifying whether the PDF page size shall be used to select the input paper tray. More...

ASPOSE_PDF_SHARED_API System::String	get_FileName ()
	Name of the PDF file that caused this document More...

ASPOSE_PDF_SHARED_API System::SharedPtr< DocumentInfo >	get_Info ()
	Gets document info. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Metadata >	get_Metadata ()
	Document metadata. (A PDF document may include general information, such as the document's title, author, and creation and modification dates. Such global information about the document (as opposed to its content or structure) is called metadata and is intended to assist in cataloguing and searching for documents in external databases.) More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Structure::RootElement >	get_LogicalStructure ()
	Gets logical structure of the document. More...

ASPOSE_PDF_SHARED_API bool	get_HandleSignatureChange () const
	Throw Exception if the document will save with changes and have signature More...

ASPOSE_PDF_SHARED_API void	set_HandleSignatureChange (bool value)
	Throw Exception if the document will save with changes and have signature More...

ASPOSE_PDF_SHARED_API System::Nullable< Aspose::Pdf::CryptoAlgorithm >	get_CryptoAlgorithm ()
	Gets security settings if document is encrypted. If document is not encrypted then corresponding exception will be raised in .net 1.1 or CryptoAlgorithm will be null for other .net versions. More...

ASPOSE_PDF_SHARED_API bool	get_IsLinearized ()
	Gets a value indicating whether document is linearized. More...

ASPOSE_PDF_SHARED_API void	set_IsLinearized (bool value)
	Sets a value indicating whether document is linearized. More...

ASPOSE_PDF_SHARED_API int32_t	get_Permissions ()
	Gets permissions of the document. More...

ASPOSE_PDF_SHARED_API bool	get_IsEncrypted ()
	Gets encrypted status of the document. True if document is encrypted. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Id >	get_Id ()
	Gets the ID. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Color >	get_Background ()
	Gets the background color of the document. More...

ASPOSE_PDF_SHARED_API void	set_Background (System::SharedPtr< Color > value)
	Sets the background color of the document. More...

ASPOSE_PDF_SHARED_API bool	get_OptimizeSize ()
	Gets optimization flag. When pages are added to document, equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false. More...

ASPOSE_PDF_SHARED_API void	set_OptimizeSize (bool value)
	Sets optimization flag. When pages are added to document, equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false. More...

ASPOSE_PDF_SHARED_API bool	get_AllowReusePageContent ()
	Allows to merge page contents to optimize docuement size. If used then differnet but duplicated pages may reference to the same content object. Please note that this mode may cause side effects like changing page content when other page is changed. More...

ASPOSE_PDF_SHARED_API void	set_AllowReusePageContent (bool value)
	Allows to merge page contents to optimize docuement size. If used then differnet but duplicated pages may reference to the same content object. Please note that this mode may cause side effects like changing page content when other page is changed. More...

ASPOSE_PDF_SHARED_API bool	get_IgnoreCorruptedObjects ()
	Gets flag of ignoring errors in source files. When pages from source document copied into destination document, copying process is stopped with exception if some objects in source files are corrupted when this flag is false. example: dest.Pages.Add(src.Pages); If this flag is set to true then corrupted objects will be replaced with empty values. By default: true. More...

ASPOSE_PDF_SHARED_API void	set_IgnoreCorruptedObjects (bool value)
	Sets flag of ignoring errors in source files. When pages from source document copied into destination document, copying process is stopped with exception if some objects in source files are corrupted when this flag is false. example: dest.Pages.Add(src.Pages); If this flag is set to true then corrupted objects will be replaced with empty values. By default: true. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< PageLabelCollection >	get_PageLabels ()
	Gets page labels in the document. More...

ASPOSE_PDF_SHARED_API bool	get_EnableObjectUnload ()
	Get or sets flag which enables document partially be unloaded from memory. This allow to decrease memory usage but may have negative effect on perfomance. More...

ASPOSE_PDF_SHARED_API void	set_EnableObjectUnload (bool value)
	Get or sets flag which enables document partially be unloaded from memory. This allow to decrease memory usage but may have negative effect on perfomance. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Tagged::ITaggedContent >	get_TaggedContent ()

ASPOSE_PDF_SHARED_API void	RemovePdfaCompliance ()
	Remove pdfa compliance from the document More...

ASPOSE_PDF_SHARED_API void	RemovePdfUaCompliance ()
	Remove pdfUa compliance from the document More...

ASPOSE_PDF_SHARED_API void	SetTitle (System::String title)
	Set Title for Pdf Document More...

ASPOSE_PDF_SHARED_API	Document (System::SharedPtr< System::IO::Stream > input)
	Initialize new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API	Document (System::SharedPtr< System::IO::Stream > input, bool isManagedStream)
	Initialize new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API	Document (System::SharedPtr< System::IO::Stream > input, System::String password)
	Initialize new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API	Document (System::SharedPtr< System::IO::Stream > input, System::String password, bool isManagedStream)
	Initialize new Document instance from the input stream. More...

ASPOSE_PDF_SHARED_API	Document (System::String filename)
	Just init Document using filename . The same as Document(Stream). More...

ASPOSE_PDF_SHARED_API	Document (System::String filename, bool isManagedStream)
	Just init Document using filename . The same as Document(Stream). More...

ASPOSE_PDF_SHARED_API	Document (System::String filename, System::String password)
	Initializes new instance of the Document class for working with encrypted document. More...

ASPOSE_PDF_SHARED_API	Document (System::String filename, System::String password, bool isManagedStream)
	Initializes new instance of the Document class for working with encrypted document. More...

ASPOSE_PDF_SHARED_API	Document ()
	Initializes empty document. More...

ASPOSE_PDF_SHARED_API void	ProcessParagraphs ()
	Process paragraphs for generator. More...

ASPOSE_PDF_SHARED_API void	Save (System::SharedPtr< System::IO::Stream > output)
	Stores document into stream. More...

ASPOSE_PDF_SHARED_API void	Save (System::String outputFileName)
	Saves document into the specified file. More...

ASPOSE_PDF_SHARED_API void	ExportAnnotationsToXfdf (System::String fileName)
	Exports all document annotations to XFDF file More...

ASPOSE_PDF_SHARED_API void	ExportAnnotationsToXfdf (System::SharedPtr< System::IO::Stream > stream)
	Export all document annotations into stream. More...

ASPOSE_PDF_SHARED_API void	SendTo (System::SharedPtr< Devices::DocumentDevice > device, System::SharedPtr< System::IO::Stream > output)
	Sends the whole document to the document device for processing. More...

ASPOSE_PDF_SHARED_API void	SendTo (System::SharedPtr< Devices::DocumentDevice > device, int32_t fromPage, int32_t toPage, System::SharedPtr< System::IO::Stream > output)
	Sends the certain pages of the document to the document device for processing. More...

ASPOSE_PDF_SHARED_API void	SendTo (System::SharedPtr< Devices::DocumentDevice > device, System::String outputFileName)
	Sends the whole document to the document device for processing. More...

ASPOSE_PDF_SHARED_API void	SendTo (System::SharedPtr< Devices::DocumentDevice > device, int32_t fromPage, int32_t toPage, System::String outputFileName)
	Sends the whole document to the document device for processing. More...

ASPOSE_PDF_SHARED_API void	RemoveMetadata ()
	Removes metadata from the document. More...

ASPOSE_PDF_SHARED_API void	ImportAnnotationsFromXfdf (System::String fileName)
	Imports annotations from XFDF file to document. More...

ASPOSE_PDF_SHARED_API void	ImportAnnotationsFromXfdf (System::SharedPtr< System::IO::Stream > stream)
	Imports annotations from stream to document. More...

ASPOSE_PDF_SHARED_API bool	Validate (System::String outputLogFileName, Aspose::Pdf::PdfFormat format)
	Validate document into the specified file. More...

ASPOSE_PDF_SHARED_API bool	Convert (System::String outputLogFileName, Aspose::Pdf::PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
	Convert document and save errors into the specified file. More...

ASPOSE_PDF_SHARED_API bool	Convert (System::SharedPtr< System::IO::Stream > outputLogStream, Aspose::Pdf::PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
	Convert document and save errors into the specified file. More...

ASPOSE_PDF_SHARED_API bool	Convert (System::String outputLogFileName, Aspose::Pdf::PdfFormat format, ConvertErrorAction action)
	Convert document and save errors into the specified file. More...

ASPOSE_PDF_SHARED_API bool	Convert (System::SharedPtr< PdfFormatConversionOptions > options)
	Convert document using specified conversion options More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::MemoryStream >	ConvertPageToPNGMemoryStream (System::SharedPtr< Page > page)
	Convert page to PNG for DSR, OMR, OCR image stream. More...

ASPOSE_PDF_SHARED_API bool	Validate (System::SharedPtr< System::IO::Stream > outputLogStream, Aspose::Pdf::PdfFormat format)
	Validate document into the specified file. More...

ASPOSE_PDF_SHARED_API bool	Validate (System::SharedPtr< PdfFormatConversionOptions > options)
	Validate document into the specified file. More...

ASPOSE_PDF_SHARED_API bool	Convert (Document::CallBackGetHocrWithPage callback, bool flattenImages=false)
	Recognize images inside the document and add hocr strings over it. More...

ASPOSE_PDF_SHARED_API bool	Convert (Document::CallBackGetHocr callback, bool flattenImages=false)
	Recognize images inside the document and add hocr strings over it. More...

ASPOSE_PDF_SHARED_API bool	Convert (System::SharedPtr< System::IO::Stream > outputLogStream, Aspose::Pdf::PdfFormat format, ConvertErrorAction action)
	Convert document and save errors into the specified stream. More...

ASPOSE_PDF_SHARED_API bool	Convert (Fixup fixup, System::SharedPtr< System::IO::Stream > outputLog, bool onlyValidation=false, System::ArrayPtr< System::SharedPtr< System::Object >> parameters=nullptr)
	Convert document by applying the Fixup. More...

ASPOSE_PDF_SHARED_API bool	Convert (Fixup fixup, System::String outputLog, bool onlyValidation=false, System::ArrayPtr< System::SharedPtr< System::Object >> parameters=nullptr)
	Convert document by applying the Fixup. More...

ASPOSE_PDF_SHARED_API void	LoadFrom (System::String filename, System::SharedPtr< LoadOptions > options)
	Loads a file, converting it to PDF. More...

ASPOSE_PDF_SHARED_API	Document (System::String filename, System::SharedPtr< LoadOptions > options)
	Opens an existing document from a file providing necessary converting options to get pdf document. More...

ASPOSE_PDF_SHARED_API	Document (System::SharedPtr< System::IO::Stream > input, System::SharedPtr< LoadOptions > options)
	Opens an existing document from a stream providing necessary converting to get pdf document. More...

ASPOSE_PDF_SHARED_API void	Flatten ()
	Removes all fields from the document and place their values instead. More...

ASPOSE_PDF_SHARED_API void	Flatten (System::SharedPtr< Aspose::Pdf::Forms::Form::FlattenSettings > flattenSettings)
	Removes all fields (and annotations) from the document and place their values instead. More...

ASPOSE_PDF_SHARED_API void	FlattenTransparency ()
	Replaces transparent content with non-transparent raster and vector graphics. More...

ASPOSE_PDF_SHARED_API void	Encrypt (System::String userPassword, System::String ownerPassword, System::SharedPtr< Facades::DocumentPrivilege > privileges, Aspose::Pdf::CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
	Encrypts the document. Call then Save to get encrypted version of the document. More...

ASPOSE_PDF_SHARED_API void	Encrypt (System::String userPassword, System::String ownerPassword, Aspose::Pdf::Permissions permissions, Aspose::Pdf::CryptoAlgorithm cryptoAlgorithm)
	Encrypts the document. Call then Save to get encrypted version of the document. More...

ASPOSE_PDF_SHARED_API void	Encrypt (System::String userPassword, System::String ownerPassword, Aspose::Pdf::Permissions permissions, Aspose::Pdf::CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
	Encrypts the document. Call then Save to get encrypted version of the document. More...

ASPOSE_PDF_SHARED_API void	ChangePasswords (System::String ownerPassword, System::String newUserPassword, System::String newOwnerPassword)
	Changes document passwords. This action can be done only using owner password. More...

ASPOSE_PDF_SHARED_API void	Decrypt ()
	Decrypts the document. Call then Save to obtain decrypted version of the document. More...

ASPOSE_PDF_SHARED_API void	Optimize ()
	Linearize the document in order to More...

ASPOSE_PDF_SHARED_API void	Save ()
	Save document incrementally (i.e. using incremental update technique). More...

ASPOSE_PDF_SHARED_API void	Save (System::SharedPtr< SaveOptions > options)
	Saves the document with save options. More...

ASPOSE_PDF_SHARED_API void	Save (System::String outputFileName, SaveFormat format)
	Saves the document with a new name along with a file format. More...

ASPOSE_PDF_SHARED_API void	Save (System::SharedPtr< System::IO::Stream > outputStream, SaveFormat format)
	Saves the document with a new name along with a file format. More...

ASPOSE_PDF_SHARED_API void	Save (System::String outputFileName, System::SharedPtr< SaveOptions > options)
	Saves the document with a new name setting its save options. More...

ASPOSE_PDF_SHARED_API void	Save (System::SharedPtr< System::IO::Stream > outputStream, System::SharedPtr< SaveOptions > options)
	Saves the document to a stream with a save options. More...

ASPOSE_PDF_SHARED_API void	Save (System::SharedPtr< System::Web::HttpResponse > response, System::String outputFileName, ContentDisposition disposition, System::SharedPtr< SaveOptions > options)
	Saves the document to a response stream with a save options. More...

ASPOSE_PDF_SHARED_API void	Dispose () override
	Closes all resources used by this document. More...

ASPOSE_PDF_SHARED_API void	OptimizeResources ()
	Optimize resources in the document: More...

ASPOSE_PDF_SHARED_API void	OptimizeResources (System::SharedPtr< Aspose::Pdf::Optimization::OptimizationOptions > strategy)
	Optimize resources in the document according to defined optimization strategy. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Object >	GetCatalogValue (System::String key)
	Returns item value from catalog dictionary. More...

ASPOSE_PDF_SHARED_API void	FreeMemory () override
	Clears memory More...

ASPOSE_PDF_SHARED_API void	SaveXml (System::String file)
	Save document to XML. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Object >	GetObjectById (System::String id)
	Gets a object with specified ID in the document. More...

ASPOSE_PDF_SHARED_API void	BindXml (System::String file)
	Bind xml to document More...

ASPOSE_PDF_SHARED_API void	Repair (System::SharedPtr< Document::RepairOptions > options=nullptr)
	Repairs broken document. More...

ASPOSE_PDF_SHARED_API void	BindXml (System::String xmlFile, System::String xslFile)
	Bind xml/xsl to document More...

ASPOSE_PDF_SHARED_API void	BindXml (System::SharedPtr< System::IO::Stream > xmlStream, System::SharedPtr< System::IO::Stream > xslStream)
	Bind xml/xsl to document More...

ASPOSE_PDF_SHARED_API void	BindXml (System::SharedPtr< System::IO::Stream > xmlStream, System::SharedPtr< System::IO::Stream > xslStream, System::SharedPtr< System::Xml::XmlReaderSettings > settings)
	Bind xml/xsl to document More...

ASPOSE_PDF_SHARED_API void	BindXml (System::SharedPtr< System::IO::Stream > stream)
	Bind xml to document More...

ASPOSE_PDF_SHARED_API void	GetXmpMetadata (System::SharedPtr< System::IO::Stream > stream)
	Get XMP metadata from document. More...

ASPOSE_PDF_SHARED_API void	SetXmpMetadata (System::SharedPtr< System::IO::Stream > stream)
	Set XMP metadata of document. More...

ASPOSE_PDF_SHARED_API bool	Check (bool doRepair)
	Validates document. More...

ASPOSE_PDF_SHARED_API void	PageNodesToBalancedTree (uint8_t nodesNumInSubtrees=DefaultNodesNumInSubtrees)
	Organizes page tree nodes in a document into a balanced tree. Only if the document has more than nodesNumInSubtrees page objects, otherwise it does nothing. Do not call this method while iterating over Pages elements, it may give unpredictable results More...

ASPOSE_PDF_SHARED_API void	Merge (System::SharedPtr< Document::MergeOptions > mergeOptions, const System::ArrayPtr< System::SharedPtr< Document >> &documents)
	Merges documents. More...

ASPOSE_PDF_SHARED_API void	Merge (System::SharedPtr< Document::MergeOptions > mergeOptions, const System::ArrayPtr< System::String > &files)
	Merges documents. More...

ASPOSE_PDF_SHARED_API void	Merge (const System::ArrayPtr< System::SharedPtr< Document >> &documents)
	Merges documents. More...

ASPOSE_PDF_SHARED_API void	Merge (const System::ArrayPtr< System::String > &files)
	Merges pdf files. More...

ASPOSE_PDF_SHARED_API bool	HasIncrementalUpdate ()
	Checks if the current PDF document has been saved with incremental updates. More...

Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API	Object ()
	Creates object. Initializes all internal data structures. More...

virtual ASPOSECPP_SHARED_API	~Object ()
	Destroys object. Frees all internal data structures. More...

ASPOSECPP_SHARED_API	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

ASPOSECPP_SHARED_API void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

ASPOSECPP_SHARED_API void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual ASPOSECPP_SHARED_API bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual ASPOSECPP_SHARED_API int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual ASPOSECPP_SHARED_API String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ASPOSECPP_SHARED_API ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual ASPOSECPP_SHARED_API const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual ASPOSECPP_SHARED_API bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual ASPOSECPP_SHARED_API void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual ASPOSECPP_SHARED_API bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Static Public Member Functions
static ASPOSE_PDF_SHARED_API bool	get_IsLicensed ()
	Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...

static ASPOSE_PDF_SHARED_API int32_t	get_FileSizeLimitToMemoryLoading ()
	Get and set the file size limit for loading an entire file into memory. The value is set in megabytes. The default value is 210 Mb. More...

static ASPOSE_PDF_SHARED_API void	set_FileSizeLimitToMemoryLoading (int32_t value)
	Get and set the file size limit for loading an entire file into memory. The value is set in megabytes. The default value is 210 Mb. More...

static ASPOSE_PDF_SHARED_API void	Convert (System::String srcFileName, System::SharedPtr< LoadOptions > loadOptions, System::String dstFileName, System::SharedPtr< SaveOptions > saveOptions)
	Converts source file in source format into destination file in destination format. More...

static ASPOSE_PDF_SHARED_API void	Convert (System::SharedPtr< System::IO::Stream > srcStream, System::SharedPtr< LoadOptions > loadOptions, System::String dstFileName, System::SharedPtr< SaveOptions > saveOptions)
	Converts stream in source format into destination file in destination format. More...

static ASPOSE_PDF_SHARED_API void	Convert (System::String srcFileName, System::SharedPtr< LoadOptions > loadOptions, System::SharedPtr< System::IO::Stream > dstStream, System::SharedPtr< SaveOptions > saveOptions)
	Converts source file in source format into stream in destination format. More...

static ASPOSE_PDF_SHARED_API void	Convert (System::SharedPtr< System::IO::Stream > srcStream, System::SharedPtr< LoadOptions > loadOptions, System::SharedPtr< System::IO::Stream > dstStream, System::SharedPtr< SaveOptions > saveOptions)
	Converts stream in source format into stream in destination format. More...

static ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	MergeDocuments (System::SharedPtr< Document::MergeOptions > mergeOptions, const System::ArrayPtr< System::String > &files)
	Merges documents. More...

static ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	MergeDocuments (System::SharedPtr< Document::MergeOptions > mergeOptions, const System::ArrayPtr< System::SharedPtr< Document >> &files)
	Merges documents. More...

static ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	MergeDocuments (const System::ArrayPtr< System::String > &files)
	Merges pdf files. More...

static ASPOSE_PDF_SHARED_API System::SharedPtr< Document >	MergeDocuments (const System::ArrayPtr< System::SharedPtr< Document >> &documents)
	Merges documents. More...

static ASPOSE_PDF_SHARED_API void	SetDefaultFileSizeLimitToMemoryLoading ()
	Sets the file size limit for loading an entire file into memory to default value equals 210 Mb. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Public Attributes
System::Event< void(System::SharedPtr< Text::Font >, System::SharedPtr< Text::Font >)>	FontSubstitution
	Occurs when font replaces another font in document. More...

Static Public Attributes
static const ASPOSE_PDF_SHARED_API uint8_t	DefaultNodesNumInSubtrees

Protected Member Functions
System::Guid	get_DocumentId () const
	The unique document ID to internal purpose. it allows differentiate document instances. More...

const System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Aspose::Rendering::ApsPage > > > &	get_ApsPages () const
	List of APS pages for the case of F1-to-F2 conversion when neither F1 nor F2 is PDF. More...

void	set_ApsPages (System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Aspose::Rendering::ApsPage >>> value)
	List of APS pages for the case of F1-to-F2 conversion when neither F1 nor F2 is PDF. More...

bool	get__IsObjectLicensed ()
	Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...

bool	get_IsParagraphsAdded () const

void	set_IsParagraphsAdded (bool value)

bool	get_IsLayersAdded ()

Text::TextEditOptions::FontReplace	get_FontReplaceBehavior () const

void	set_FontReplaceBehavior (Text::TextEditOptions::FontReplace value)

bool	get_NotifyAboutFontSubstitutions ()

System::SharedPtr< Text::IFontSubstitutionRegistrator >	get_FontSubstitutionRegistrator () const

System::SharedPtr< Engine::CommonData::IDocumentSecondaryStrategies >	get_DocumentStrategies () const

System::SharedPtr< System::Collections::Generic::IDictionary< int32_t, System::SharedPtr< System::Collections::Generic::List< System::Drawing::RectangleF > > > >	get_InternalHyperlinkTargets () const

void	set_InternalHyperlinkTargets (System::SharedPtr< System::Collections::Generic::IDictionary< int32_t, System::SharedPtr< System::Collections::Generic::List< System::Drawing::RectangleF >>>> value)

bool	get_IsNotCheckMetadata () const
	Gets a metadata check for pdf/a(validation should pass this because it updates after on save). More...

bool	get_IsConvertMetadataAndCatalogOnly () const
	Gets convert parameter for pdf/ua converter (Convert only Metadata and Document Catalog if set true) More...

void	set_IsConvertMetadataAndCatalogOnly (bool value)
	Gets convert parameter for pdf/ua converter (Convert only Metadata and Document Catalog if set true) More...

int32_t	get_ParentTreeNextKey ()

void	set_ParentTreeNextKey (int32_t value)

Aspose::Pdf::UsageMode	get_UsageMode () const

System::SharedPtr< Copier >	get_DefaultCopier ()
	Returns copier used for coping pages to this document. More...

bool	get_IsConverted () const

void	ResetRestrictions ()

void	SetPlugin (Documentize::Plugin plugin)

System::Nullable< Aspose::Pdf::PdfFormat >	GetPdfACompliance ()
	Gets the PDF/A compliance level of the current document. More...

void	NotifyAboutSubstitution (System::SharedPtr< Aspose::Pdf::Text::Font > oldFont, System::SharedPtr< Aspose::Pdf::Text::Font > newFont)

void	SetSimpleFontEncodingRule (HtmlSaveOptions::FontEncodingRules rule)

void	InitInternalHyperlinksTargetsData (System::SharedPtr< UnifiedSaveOptions > options)
	Initializes the internal hyperlinks targets data on document loading. More...

void	RegisterMetadata (System::SharedPtr< Aspose::Pdf::Metadata > metadata)

	Document (PdfVersion version)
	Initializes empty document by version. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Document, CODEPORTING_ARGS(PdfVersion version))

void	ProcessLayers ()
	Process layers for generator. More...

void	AddLayers ()
	Adds layers to the document. More...

void	ValidateAnnotations ()

void	UncompressObject (System::SharedPtr< Engine::Data::IPdfObject > obj)

void	UpdatePagesResources ()
	Copies shared resources into pages. More...

void	UpdateXFormResources ()
	Copies resources from Page into its XForm. More...

bool	Convert (System::SharedPtr< System::Xml::XmlTextWriter > xml, Aspose::Pdf::PdfFormat format, bool onlyValidation, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
	Convert the PDF Document and log results. More...

bool	Convert (System::SharedPtr< System::Xml::XmlTextWriter > xml, Aspose::Pdf::PdfFormat format, bool onlyValidation, ConvertErrorAction action)
	Convert the PDF Document and log results. More...

bool	Convert (System::SharedPtr< PdfFormatConversionOptions > options, bool onlyValidation)

bool	Convert (Fixup fixup, System::SharedPtr< System::Xml::XmlTextWriter > outputLog, bool onlyValidation=false, System::ArrayPtr< System::SharedPtr< System::Object >> parameters=nullptr)

bool	ContainSignature ()
	If the document has at least 1 signature - true More...

void	LoadDocument (System::SharedPtr< System::IO::Stream > input, System::SharedPtr< LoadOptions > options)

void	FlattenA ()

void	FlattenB ()

bool	IsCertified ()

System::SharedPtr< Engine::Data::Types::IPdfStreamAccessor >	GetMetadataStream ()
	Returns raw metadata stream More...

void	UpdatePages ()

void	SuppressUpdate ()
	Suppresses update contents data for all pages The contents is not updated until ResumeUpdate is called More...

void	ResumeUpdate ()
	resumes document update More...

System::SharedPtr< Resources >	GetResourcesFor (System::SharedPtr< Engine::Data::IPdfObject > obj)

void	ReleaseResourcesFor (System::SharedPtr< Engine::Data::IPdfObject > obj)

void	SetResourcesFor (System::SharedPtr< Engine::Data::IPdfObject > obj, System::SharedPtr< Resources > res)

System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t > >	OptimizeResourceInternal (System::SharedPtr< Aspose::Pdf::Optimization::OptimizationOptions > strategy)

System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t > >	OptimizeResourceInternal ()

void	RegisterAfterImportAnnotation (System::SharedPtr< Annotations::Annotation > annotation)
	Register annotation for which AfterImport method must be called after import finished. More...

void	AfterImport ()
	Enumerate all registered annotations and call AfterImport for each of them. More...

bool	Check (bool doRepair, System::SharedPtr< System::IO::Stream > log)

void	RemoveOptionalContentPropertyWithObject (int32_t objectId)
	Removes the optional content property with the specified name from the document. More...

void	RemoveObject (System::SharedPtr< Engine::Data::IPdfObject > pdfObject)
	Removes the specified PDF object from the document. More...

void	cpp_keep_trailerable (System::SharedPtr< Engine::Data::ITrailerable > keep)

void	cpp_keep_text_segment_builder (System::SharedPtr< Engine::CommonData::Text::Segmenting::TextSegmentBuilder > builder)

void	cpp_keep_pcl_parser (System::SharedPtr< Aspose::Pcl::Parser::PCLParser > parser)

virtual ASPOSE_PDF_SHARED_API	~Document ()

Static Protected Member Functions
static bool	get__IsLicensed ()
	Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...

static bool	get_Indivisible ()

static int32_t &	IndivisibleLevel ()

static bool	get___Indivisible ()

static uint64_t	TransformRestrictionKey (uint64_t key)

static bool	Restricted (System::SharedPtr< Engine::Data::ITrailerable > tr, int32_t index)

static bool	Restricted (System::SharedPtr< Document > doc, int32_t index)

static void	Restrict (System::SharedPtr< Engine::Data::ITrailerable > tr, int32_t index)

static void	Restrict (System::SharedPtr< Document > doc, int32_t index)

static bool	IsVentureLicenseValid (System::SharedPtr< LicenseManagement::VentureLicense > _ventureLicense)

static bool	Restricted (System::SharedPtr< LicenseManagement::VentureLicense > ventureLicense, int32_t index)

static void	StartOperation ()

static void	EndOperation ()

static void	UpdateMetadata (System::SharedPtr< Engine::PdfDocument > document, System::SharedPtr< Aspose::Pdf::Metadata > metadata)

static void	PreSave (System::SharedPtr< PageCollection > pages, System::SharedPtr< SaveOptions > saveOptions)

static System::SharedPtr< System::Object >	GetObjectById (System::String id, System::SharedPtr< Paragraphs > paragraphs)

Protected Attributes
System::SharedPtr< ConversionPipeline >	Pipeline

bool	ReloadAfterLinearization

bool	IsPdfAConversionMode

System::SharedPtr< Engine::CommonData::Text::Fonts::Utilities::IDocumentFontSaveOptions >	FontSaveOptions

System::SharedPtr< Engine::IPdfDocument >	_engineDoc
	Instance of IPdfDocument used to access to internal document structure. More...

System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::SharedPtr< Engine::CommonData::Text::Segmenting::TextSegmentBuilder > > >	_commonXObjects

Static Protected Attributes
static System::SharedPtr< System::Object >	syncRoot

Detailed Description

Class representing PDF document

Member Typedef Documentation

◆ CallBackGetHocr

using Aspose::Pdf::Document::CallBackGetHocr = System::MulticastDelegate<System::String(System::SharedPtr<System::Drawing::Image>)>

The call back procedure for hocr recognize.

◆ CallBackGetHocrWithPage

using Aspose::Pdf::Document::CallBackGetHocrWithPage = System::MulticastDelegate<System::String(System::SharedPtr<System::Drawing::Image>, System::SharedPtr<Page>)>

The call back procedure for hocr recognize.

◆ FontSubstitutionHandler

using Aspose::Pdf::Document::FontSubstitutionHandler = System::MulticastDelegate<void(System::SharedPtr<Text::Font>, System::SharedPtr<Text::Font>)>

Represents the method that will handle FontSubstitution event.

Parameters

oldFont	original font
newFont	new font

Constructor & Destructor Documentation

◆ Document() [1/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document ( System::SharedPtr< System::IO::Stream > input )

Initialize new Document instance from the input stream.

Parameters

input Stream with pdf document.

◆ Document() [2/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::SharedPtr< System::IO::Stream >	input,
		bool	isManagedStream
	)

Initialize new Document instance from the input stream.

Parameters

input	Stream with pdf document.
isManagedStream	if set to `true` inner stream is closed before exit; otherwise, is not.

◆ Document() [3/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::SharedPtr< System::IO::Stream >	input,
		System::String	password
	)

Initialize new Document instance from the input stream.

Parameters

input	Input stream object, corresponding pdf is password protected.
password	User or owner password.

◆ Document() [4/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::SharedPtr< System::IO::Stream >	input,
		System::String	password,
		bool	isManagedStream
	)

Initialize new Document instance from the input stream.

Parameters

input	Stream with pdf document.
password	User or owner password.
isManagedStream	If set to `true` inner stream is closed before exit; otherwise, is not.

◆ Document() [5/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document ( System::String filename )

Just init Document using filename . The same as Document(Stream).

Parameters

filename The name of the pdf document file.

◆ Document() [6/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::String	filename,
		bool	isManagedStream
	)

Just init Document using filename . The same as Document(Stream).

Parameters

filename	The name of the pdf document file.
isManagedStream	If set to `true` inner stream is closed before exit; otherwise, is not.

◆ Document() [7/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::String	filename,
		System::String	password
	)

Initializes new instance of the Document class for working with encrypted document.

Parameters

filename	Document file name.
password	User or owner password.

◆ Document() [8/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::String	filename,
		System::String	password,
		bool	isManagedStream
	)

Initializes new instance of the Document class for working with encrypted document.

Parameters

filename	Document file name.
password	User or owner password.
isManagedStream	if set to `true` inner stream is closed before exit; otherwise, is not.

◆ Document() [9/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document ( )

Initializes empty document.

◆ Document() [10/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::String	filename,
		System::SharedPtr< LoadOptions >	options
	)

Opens an existing document from a file providing necessary converting options to get pdf document.

Parameters

filename	Input file to convert into pdf document.
options	Represents properties for converting filename into pdf document.

◆ Document() [11/12]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::Document	(	System::SharedPtr< System::IO::Stream >	input,
		System::SharedPtr< LoadOptions >	options
	)

Opens an existing document from a stream providing necessary converting to get pdf document.

Parameters

input	Input stream to convert into pdf document.
options	Represents properties for converting input into pdf document.

◆ Document() [12/12]

Aspose::Pdf::Document::Document ( PdfVersion version )

protected

Initializes empty document by version.

Parameters

version The PDF version.

◆ ~Document()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Document::~Document ( )

protectedvirtual

Member Function Documentation

◆ AddLayers()

void Aspose::Pdf::Document::AddLayers ( )

protected

Adds layers to the document.

◆ AfterImport()

void Aspose::Pdf::Document::AfterImport ( )

protected

Enumerate all registered annotations and call AfterImport for each of them.

◆ BindXml() [1/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::BindXml ( System::String file )

Bind xml to document

Parameters

file	The xml file

◆ BindXml() [2/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::BindXml	(	System::String	xmlFile,
		System::String	xslFile
	)

Bind xml/xsl to document

Parameters

xmlFile	The xml file.
xslFile	The xsl file if XSLT is used.

◆ BindXml() [3/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::BindXml	(	System::SharedPtr< System::IO::Stream >	xmlStream,
		System::SharedPtr< System::IO::Stream >	xslStream
	)

Bind xml/xsl to document

Parameters

xmlStream	The xml stream.
xslStream	The xsl stream if XSLT is used.

◆ BindXml() [4/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::BindXml	(	System::SharedPtr< System::IO::Stream >	xmlStream,
		System::SharedPtr< System::IO::Stream >	xslStream,
		System::SharedPtr< System::Xml::XmlReaderSettings >	settings
	)

Bind xml/xsl to document

Parameters

xmlStream	The xml stream.
xslStream	The xsl stream if XSLT is used.
settings	The xml reader settings.

◆ BindXml() [5/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::BindXml ( System::SharedPtr< System::IO::Stream > stream )

Bind xml to document

Parameters

stream The xml stream.

◆ ChangePasswords()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::ChangePasswords	(	System::String	ownerPassword,
		System::String	newUserPassword,
		System::String	newOwnerPassword
	)

Changes document passwords. This action can be done only using owner password.

Parameters

ownerPassword	Owner password.
newUserPassword	New user password.
newOwnerPassword	New owner password.

◆ Check() [1/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Check ( bool doRepair )

Validates document.

Parameters

doRepair If true found issues will be repaired.

Returns: True - if document repaired; otherwise, false.

◆ Check() [2/2]

bool Aspose::Pdf::Document::Check	(	bool	doRepair,
		System::SharedPtr< System::IO::Stream >	log
	)

protected

◆ ContainSignature()

bool Aspose::Pdf::Document::ContainSignature ( )

protected

If the document has at least 1 signature - true

Returns

◆ Convert() [1/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	System::String	outputLogFileName,
		Aspose::Pdf::PdfFormat	format,
		ConvertErrorAction	action,
		ConvertTransparencyAction	transparencyAction
	)

Convert document and save errors into the specified file.

Parameters

outputLogFileName	Path to file where the comments will be stored.
format	The pdf format.
action	Action for objects that can not be converted
transparencyAction	Action for image masked objects

Returns: The operation result

◆ Convert() [2/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	System::SharedPtr< System::IO::Stream >	outputLogStream,
		Aspose::Pdf::PdfFormat	format,
		ConvertErrorAction	action,
		ConvertTransparencyAction	transparencyAction
	)

Convert document and save errors into the specified file.

Parameters

outputLogStream	Stream where the comments will be stored.
format	The pdf format.
action	Action for objects that can not be converted
transparencyAction	Action for image masked objects

Returns: The operation result

◆ Convert() [3/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	System::String	outputLogFileName,
		Aspose::Pdf::PdfFormat	format,
		ConvertErrorAction	action
	)

Convert document and save errors into the specified file.

Parameters

outputLogFileName	Path to file where the comments will be stored.
format	The pdf format.
action	Action for objects that can not be converted

Returns: The operation result

◆ Convert() [4/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert ( System::SharedPtr< PdfFormatConversionOptions > options )

Convert document using specified conversion options

Parameters

options set of options for convert PDF document

Returns: The operation result

◆ Convert() [5/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	Document::CallBackGetHocrWithPage	callback,
		bool	flattenImages = `false`
	)

Recognize images inside the document and add hocr strings over it.

Parameters

callback	Action for images that will be processed by hocr recognize.
flattenImages	Text in pdf images can be painted using the mechanics of masks, in which case the images must be flattened.

Returns: The operation result. If there are no images in the document returns false.

◆ Convert() [6/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	Document::CallBackGetHocr	callback,
		bool	flattenImages = `false`
	)

Recognize images inside the document and add hocr strings over it.

Parameters

callback	Action for images that will be processed by hocr recognize.
flattenImages	Text in pdf images can be painted using the mechanics of masks, in which case the images must be flattened.

Returns: The operation result. If there are no images in the document returns false.

◆ Convert() [7/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	System::SharedPtr< System::IO::Stream >	outputLogStream,
		Aspose::Pdf::PdfFormat	format,
		ConvertErrorAction	action
	)

Convert document and save errors into the specified stream.

Parameters

outputLogStream	Stream where the comments will be stored.
format	Pdf format.
action	Action for objects that can not be converted

Returns: The operation result

◆ Convert() [8/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	Fixup	fixup,
		System::SharedPtr< System::IO::Stream >	outputLog,
		bool	onlyValidation = `false`,
		System::ArrayPtr< System::SharedPtr< System::Object >>	parameters = `nullptr`
	)

Convert document by applying the Fixup.

Parameters

fixup	The Fixup type.
outputLog	The log of process.
onlyValidation	Only document validation.
parameters	Properties for Fixup that can not be set.

Returns: The operation result.

◆ Convert() [9/17]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Convert	(	Fixup	fixup,
		System::String	outputLog,
		bool	onlyValidation = `false`,
		System::ArrayPtr< System::SharedPtr< System::Object >>	parameters = `nullptr`
	)

Convert document by applying the Fixup.

Parameters

fixup	The Fixup type.
outputLog	The log of process.
onlyValidation	Only document validation.
parameters	Properties for Fixup that can not be set.

Returns: The operation result.

◆ Convert() [10/17]

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Convert	(	System::String	srcFileName,
		System::SharedPtr< LoadOptions >	loadOptions,
		System::String	dstFileName,
		System::SharedPtr< SaveOptions >	saveOptions
	)

static

Converts source file in source format into destination file in destination format.

Parameters

srcFileName	The source file name.
loadOptions	The source file format.
dstFileName	The destination file name.
saveOptions	The destination file format.

◆ Convert() [11/17]

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Convert	(	System::SharedPtr< System::IO::Stream >	srcStream,
		System::SharedPtr< LoadOptions >	loadOptions,
		System::String	dstFileName,
		System::SharedPtr< SaveOptions >	saveOptions
	)

static

Converts stream in source format into destination file in destination format.

Parameters

srcStream	The source stream.
loadOptions	The source stream format.
dstFileName	The destination file name.
saveOptions	The destination file format.

◆ Convert() [12/17]

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Convert	(	System::String	srcFileName,
		System::SharedPtr< LoadOptions >	loadOptions,
		System::SharedPtr< System::IO::Stream >	dstStream,
		System::SharedPtr< SaveOptions >	saveOptions
	)

static

Converts source file in source format into stream in destination format.

Parameters

srcFileName	The source file name.
loadOptions	The source file format.
dstStream	The destination stream.
saveOptions	The destination stream format.

◆ Convert() [13/17]

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Convert	(	System::SharedPtr< System::IO::Stream >	srcStream,
		System::SharedPtr< LoadOptions >	loadOptions,
		System::SharedPtr< System::IO::Stream >	dstStream,
		System::SharedPtr< SaveOptions >	saveOptions
	)

static

Converts stream in source format into stream in destination format.

Parameters

srcStream	The source stream.
loadOptions	The source stream format.
dstStream	The destination stream.
saveOptions	The destination file format.

◆ Convert() [14/17]

bool Aspose::Pdf::Document::Convert	(	System::SharedPtr< System::Xml::XmlTextWriter >	xml,
		Aspose::Pdf::PdfFormat	format,
		bool	onlyValidation,
		ConvertErrorAction	action,
		ConvertTransparencyAction	transparencyAction
	)

protected

Convert the PDF Document and log results.

Parameters

xml	The log.
format	Pdf format.
onlyValidation	Only document validation.
action	Action for objects that can not be converted
transparencyAction	Action for image masked objects

Returns: The operation result

◆ Convert() [15/17]

bool Aspose::Pdf::Document::Convert	(	System::SharedPtr< System::Xml::XmlTextWriter >	xml,
		Aspose::Pdf::PdfFormat	format,
		bool	onlyValidation,
		ConvertErrorAction	action
	)

protected

Convert the PDF Document and log results.

Parameters

xml	The log.
format	Pdf format.
onlyValidation	Only document validation.
action	Action for objects that can not be converted

Returns: The operation result

◆ Convert() [16/17]

bool Aspose::Pdf::Document::Convert	(	System::SharedPtr< PdfFormatConversionOptions >	options,
		bool	onlyValidation
	)

protected

◆ Convert() [17/17]

bool Aspose::Pdf::Document::Convert	(	Fixup	fixup,
		System::SharedPtr< System::Xml::XmlTextWriter >	outputLog,
		bool	onlyValidation = `false`,
		System::ArrayPtr< System::SharedPtr< System::Object >>	parameters = `nullptr`
	)

protected

◆ ConvertPageToPNGMemoryStream()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::MemoryStream> Aspose::Pdf::Document::ConvertPageToPNGMemoryStream ( System::SharedPtr< Page > page )

Convert page to PNG for DSR, OMR, OCR image stream.

Parameters

page	Page to convert.

Returns: Image stream.

◆ cpp_keep_pcl_parser()

void Aspose::Pdf::Document::cpp_keep_pcl_parser ( System::SharedPtr< Aspose::Pcl::Parser::PCLParser > parser )

protected

◆ cpp_keep_text_segment_builder()

void Aspose::Pdf::Document::cpp_keep_text_segment_builder ( System::SharedPtr< Engine::CommonData::Text::Segmenting::TextSegmentBuilder > builder )

protected

◆ cpp_keep_trailerable()

void Aspose::Pdf::Document::cpp_keep_trailerable ( System::SharedPtr< Engine::Data::ITrailerable > keep )

protected

◆ Decrypt()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Decrypt ( )

Decrypts the document. Call then Save to obtain decrypted version of the document.

◆ Dispose()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Dispose ( )

overridevirtual

Closes all resources used by this document.

Reimplemented from System::IDisposable.

◆ Encrypt() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Encrypt	(	System::String	userPassword,
		System::String	ownerPassword,
		System::SharedPtr< Facades::DocumentPrivilege >	privileges,
		Aspose::Pdf::CryptoAlgorithm	cryptoAlgorithm,
		bool	usePdf20
	)

Encrypts the document. Call then Save to get encrypted version of the document.

Parameters

userPassword	User password.
ownerPassword	Owner password.
privileges	Document permissions, see Permissions for details.
cryptoAlgorithm	Cryptographic algorithm, see CryptoAlgorithm for details.
usePdf20	Support for revision 6 (Extension 8).

◆ Encrypt() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Encrypt	(	System::String	userPassword,
		System::String	ownerPassword,
		Aspose::Pdf::Permissions	permissions,
		Aspose::Pdf::CryptoAlgorithm	cryptoAlgorithm
	)

Encrypts the document. Call then Save to get encrypted version of the document.

Parameters

userPassword	User password.
ownerPassword	Owner password.
permissions	Document permissions, see Permissions for details.
cryptoAlgorithm	Cryptographic algorithm, see CryptoAlgorithm for details.

◆ Encrypt() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Encrypt	(	System::String	userPassword,
		System::String	ownerPassword,
		Aspose::Pdf::Permissions	permissions,
		Aspose::Pdf::CryptoAlgorithm	cryptoAlgorithm,
		bool	usePdf20
	)

Encrypts the document. Call then Save to get encrypted version of the document.

Parameters

userPassword	User password.
ownerPassword	Owner password.
permissions	Document permissions, see Permissions for details.
cryptoAlgorithm	Cryptographic algorithm, see CryptoAlgorithm for details.
usePdf20	Support for revision 6 (Extension 8).

◆ EndOperation()

static void Aspose::Pdf::Document::EndOperation ( )

staticprotected

◆ ExportAnnotationsToXfdf() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::ExportAnnotationsToXfdf ( System::String fileName )

Exports all document annotations to XFDF file

Parameters

fileName XFDF file name

◆ ExportAnnotationsToXfdf() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::ExportAnnotationsToXfdf ( System::SharedPtr< System::IO::Stream > stream )

Export all document annotations into stream.

Parameters

stream Stream where store XFDF.

◆ Flatten() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Flatten ( )

Removes all fields from the document and place their values instead.

◆ Flatten() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Flatten ( System::SharedPtr< Aspose::Pdf::Forms::Form::FlattenSettings > flattenSettings )

Removes all fields (and annotations) from the document and place their values instead.

Parameters

flattenSettings Settings for flattening process.

◆ FlattenA()

void Aspose::Pdf::Document::FlattenA ( )

protected

◆ FlattenB()

void Aspose::Pdf::Document::FlattenB ( )

protected

◆ FlattenTransparency()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::FlattenTransparency ( )

Replaces transparent content with non-transparent raster and vector graphics.

◆ FreeMemory()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::FreeMemory ( )

overridevirtual

Clears memory

Implements Aspose::Pdf::ISupportsMemoryCleanup.

◆ get___Indivisible()

static bool Aspose::Pdf::Document::get___Indivisible ( )

staticprotected

◆ get__IsLicensed()

static bool Aspose::Pdf::Document::get__IsLicensed ( )

staticprotected

Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise.

◆ get__IsObjectLicensed()

bool Aspose::Pdf::Document::get__IsObjectLicensed ( )

protected

Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise.

◆ get_Actions()

ASPOSE_PDF_SHARED_API System::SharedPtr<Annotations::DocumentActionCollection> Aspose::Pdf::Document::get_Actions ( )

Gets document actions. This property is instance of DocumentActions class which allows to get/set BeforClosing, BeforSaving, etc. actions.

◆ get_AllowReusePageContent()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_AllowReusePageContent ( )

Allows to merge page contents to optimize docuement size. If used then differnet but duplicated pages may reference to the same content object. Please note that this mode may cause side effects like changing page content when other page is changed.

◆ get_ApsPages()

const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Aspose::Rendering::ApsPage> > >& Aspose::Pdf::Document::get_ApsPages ( ) const

protected

List of APS pages for the case of F1-to-F2 conversion when neither F1 nor F2 is PDF.

◆ get_Background()

ASPOSE_PDF_SHARED_API System::SharedPtr<Color> Aspose::Pdf::Document::get_Background ( )

Gets the background color of the document.

◆ get_CenterWindow()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_CenterWindow ( )

Gets flag specifying whether position of the document's window will be centerd on the screen.

◆ get_Collection()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Collection> Aspose::Pdf::Document::get_Collection ( )

Gets collection of document.

◆ get_CryptoAlgorithm()

ASPOSE_PDF_SHARED_API System::Nullable<Aspose::Pdf::CryptoAlgorithm> Aspose::Pdf::Document::get_CryptoAlgorithm ( )

Gets security settings if document is encrypted. If document is not encrypted then corresponding exception will be raised in .net 1.1 or CryptoAlgorithm will be null for other .net versions.

◆ get_DefaultCopier()

System::SharedPtr<Copier> Aspose::Pdf::Document::get_DefaultCopier ( )

protected

Returns copier used for coping pages to this document.

◆ get_Destinations()

ASPOSE_PDF_SHARED_API System::SharedPtr<DestinationCollection> Aspose::Pdf::Document::get_Destinations ( )

Gets the collection of destinations. Obsolete. Please use NamedDestinations.

◆ get_Direction()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Direction Aspose::Pdf::Document::get_Direction ( )

Gets reading order of text: L2R (left to right) or R2L (right to left).

◆ get_DisableFontLicenseVerifications()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_DisableFontLicenseVerifications ( ) const

Many operations with font can't be executed if these operations are prohibited by license of this font. For example some font can't be embedded into PDF document if license rules disable embedding for this font. This flag is used to disable any license restrictions for all fonts in current PDF document. Be careful when using this flag. When it is set it means that person who sets this flag, takes all responsibility of possible license/law violations on himself. So He takes it on it's own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false.

◆ get_DisplayDocTitle()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_DisplayDocTitle ( )

Gets flag specifying whether document's window title bar should display document title.

◆ get_DocumentId()

System::Guid Aspose::Pdf::Document::get_DocumentId ( ) const

protected

The unique document ID to internal purpose. it allows differentiate document instances.

◆ get_DocumentStrategies()

System::SharedPtr<Engine::CommonData::IDocumentSecondaryStrategies> Aspose::Pdf::Document::get_DocumentStrategies ( ) const

protected

◆ get_Duplex()

ASPOSE_PDF_SHARED_API PrintDuplex Aspose::Pdf::Document::get_Duplex ( )

Gets print duplex mode handling option to use when printing the file from the print dialog.

◆ get_EmbeddedFiles()

ASPOSE_PDF_SHARED_API System::SharedPtr<EmbeddedFileCollection> Aspose::Pdf::Document::get_EmbeddedFiles ( )

Gets collection of files embedded to document.

◆ get_EmbedStandardFonts()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_EmbedStandardFonts ( ) const

Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true. All PDF fonts can be embedded into document simply via setting of flag IsEmbedded into true, but PDF standard Type1 fonts is an exception from this rule. Standard Type1 font embedding requires much time, so to embed these fonts it's necessary not only set flag IsEmbedded into true for specified font but also set an additiona flag on document's level - EmbedStandardFonts = true; This property can be set only one time for all fonts. By default false.

◆ get_EnableObjectUnload()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_EnableObjectUnload ( )

Get or sets flag which enables document partially be unloaded from memory. This allow to decrease memory usage but may have negative effect on perfomance.

◆ get_EnableSignatureSanitization()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_EnableSignatureSanitization ( ) const

Gets flag to manage signature fields sanitization. Enabled by default.

◆ get_FileName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Document::get_FileName ( )

Name of the PDF file that caused this document

◆ get_FileSizeLimitToMemoryLoading()

static ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Document::get_FileSizeLimitToMemoryLoading ( )

static

Get and set the file size limit for loading an entire file into memory. The value is set in megabytes. The default value is 210 Mb.

◆ get_FitWindow()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_FitWindow ( )

Gets flag specifying whether document window must be resized to fit the first displayed page.

◆ get_FontReplaceBehavior()

Text::TextEditOptions::FontReplace Aspose::Pdf::Document::get_FontReplaceBehavior ( ) const

protected

◆ get_FontSubstitutionRegistrator()

System::SharedPtr<Text::IFontSubstitutionRegistrator> Aspose::Pdf::Document::get_FontSubstitutionRegistrator ( ) const

protected

◆ get_FontUtilities()

ASPOSE_PDF_SHARED_API System::SharedPtr<Document::IDocumentFontUtilities> Aspose::Pdf::Document::get_FontUtilities ( )

IDocumentFontUtilities instance

◆ get_Form()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Forms::Form> Aspose::Pdf::Document::get_Form ( )

Gets Acro Form of the document.

◆ get_HandleSignatureChange()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_HandleSignatureChange ( ) const

Throw Exception if the document will save with changes and have signature

◆ get_HideMenubar()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_HideMenubar ( )

Gets flag specifying whether menu bar should be hidden when document is active.

◆ get_HideToolBar()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_HideToolBar ( )

Gets flag specifying whether toolbar should be hidden when document is active.

◆ get_HideWindowUI()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_HideWindowUI ( )

Gets flag specifying whether user interface elements should be hidden when document is active.

◆ get_Id()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Id> Aspose::Pdf::Document::get_Id ( )

Gets the ID.

◆ get_IgnoreCorruptedObjects()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_IgnoreCorruptedObjects ( )

Gets flag of ignoring errors in source files. When pages from source document copied into destination document, copying process is stopped with exception if some objects in source files are corrupted when this flag is false. example: dest.Pages.Add(src.Pages); If this flag is set to true then corrupted objects will be replaced with empty values. By default: true.

◆ get_Indivisible()

static bool Aspose::Pdf::Document::get_Indivisible ( )

staticprotected

◆ get_Info()

ASPOSE_PDF_SHARED_API System::SharedPtr<DocumentInfo> Aspose::Pdf::Document::get_Info ( )

Gets document info.

◆ get_InternalHyperlinkTargets()

System::SharedPtr<System::Collections::Generic::IDictionary<int32_t, System::SharedPtr<System::Collections::Generic::List<System::Drawing::RectangleF> > > > Aspose::Pdf::Document::get_InternalHyperlinkTargets ( ) const

protected

◆ get_IsConverted()

bool Aspose::Pdf::Document::get_IsConverted ( ) const

protected

◆ get_IsConvertMetadataAndCatalogOnly()

bool Aspose::Pdf::Document::get_IsConvertMetadataAndCatalogOnly ( ) const

protected

Gets convert parameter for pdf/ua converter (Convert only Metadata and Document Catalog if set true)

◆ get_IsEncrypted()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_IsEncrypted ( )

Gets encrypted status of the document. True if document is encrypted.

◆ get_IsLayersAdded()

bool Aspose::Pdf::Document::get_IsLayersAdded ( )

protected

◆ get_IsLicensed()

static ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_IsLicensed ( )

static

Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise.

◆ get_IsLinearized()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_IsLinearized ( )

Gets a value indicating whether document is linearized.

◆ get_IsNotCheckMetadata()

bool Aspose::Pdf::Document::get_IsNotCheckMetadata ( ) const

protected

Gets a metadata check for pdf/a(validation should pass this because it updates after on save).

◆ get_IsParagraphsAdded()

bool Aspose::Pdf::Document::get_IsParagraphsAdded ( ) const

protected

◆ get_IsPdfaCompliant()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_IsPdfaCompliant ( )

Gets the is document pdfa compliant.

◆ get_IsPdfUaCompliant()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_IsPdfUaCompliant ( )

Gets the is document pdfua compliant.

◆ get_IsXrefGapsAllowed()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_IsXrefGapsAllowed ( )

Gets the is document pdfa compliant.

◆ get_JavaScript()

ASPOSE_PDF_SHARED_API System::SharedPtr<JavaScriptCollection> Aspose::Pdf::Document::get_JavaScript ( )

Collection of JavaScript of document level.

◆ get_LogicalStructure()

ASPOSE_PDF_SHARED_API System::SharedPtr<Structure::RootElement> Aspose::Pdf::Document::get_LogicalStructure ( )

Gets logical structure of the document.

◆ get_Metadata()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Metadata> Aspose::Pdf::Document::get_Metadata ( )

Document metadata. (A PDF document may include general information, such as the document's title, author, and creation and modification dates. Such global information about the document (as opposed to its content or structure) is called metadata and is intended to assist in cataloguing and searching for documents in external databases.)

◆ get_NamedDestinations()

ASPOSE_PDF_SHARED_API System::SharedPtr<NamedDestinationCollection> Aspose::Pdf::Document::get_NamedDestinations ( )

Collection of Named Destination in the document.

◆ get_NonFullScreenPageMode()

ASPOSE_PDF_SHARED_API Aspose::Pdf::PageMode Aspose::Pdf::Document::get_NonFullScreenPageMode ( )

Gets page mode, specifying how to display the document on exiting full-screen mode.

◆ get_NotifyAboutFontSubstitutions()

bool Aspose::Pdf::Document::get_NotifyAboutFontSubstitutions ( )

protected

◆ get_OpenAction()

ASPOSE_PDF_SHARED_API System::SharedPtr<Annotations::IAppointment> Aspose::Pdf::Document::get_OpenAction ( )

Gets action performed at document opening.

◆ get_OptimizeSize()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_OptimizeSize ( )

Gets optimization flag. When pages are added to document, equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false.

◆ get_Outlines()

ASPOSE_PDF_SHARED_API System::SharedPtr<OutlineCollection> Aspose::Pdf::Document::get_Outlines ( )

Gets document outlines.

◆ get_OutputIntents()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::OutputIntents> Aspose::Pdf::Document::get_OutputIntents ( )

Gets the collection of Output intents in the document.

◆ get_PageInfo()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::PageInfo> Aspose::Pdf::Document::get_PageInfo ( )

Gets the page info.(for generator only, not filled in when reading document)

The page info.

◆ get_PageLabels()

ASPOSE_PDF_SHARED_API System::SharedPtr<PageLabelCollection> Aspose::Pdf::Document::get_PageLabels ( )

Gets page labels in the document.

◆ get_PageLayout()

ASPOSE_PDF_SHARED_API Aspose::Pdf::PageLayout Aspose::Pdf::Document::get_PageLayout ( )

Gets page layout which shall be used when the document is opened.

◆ get_PageMode()

ASPOSE_PDF_SHARED_API Aspose::Pdf::PageMode Aspose::Pdf::Document::get_PageMode ( )

Gets page mode, specifying how document should be displayed when opened.

◆ get_Pages()

ASPOSE_PDF_SHARED_API System::SharedPtr<PageCollection> Aspose::Pdf::Document::get_Pages ( )

Gets collection of document pages. Note that pages are numbered from 1 in collection.

◆ get_ParentTreeNextKey()

int32_t Aspose::Pdf::Document::get_ParentTreeNextKey ( )

protected

◆ get_PdfFormat()

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfFormat Aspose::Pdf::Document::get_PdfFormat ( )

Gets PDF format

◆ get_Permissions()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Document::get_Permissions ( )

Gets permissions of the document.

◆ get_PickTrayByPdfSize()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::get_PickTrayByPdfSize ( )

Gets a flag specifying whether the PDF page size shall be used to select the input paper tray.

◆ get_PrintScaling()

ASPOSE_PDF_SHARED_API Aspose::Pdf::PrintScaling Aspose::Pdf::Document::get_PrintScaling ( )

Gets the page scaling option that shall be selected when a print dialog is displayed for this document.

◆ get_TaggedContent()

ASPOSE_PDF_SHARED_API System::SharedPtr<Tagged::ITaggedContent> Aspose::Pdf::Document::get_TaggedContent ( )

Gets access to TaggedPdf content.

◆ get_UsageMode()

Aspose::Pdf::UsageMode Aspose::Pdf::Document::get_UsageMode ( ) const

protected

◆ get_Version()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Document::get_Version ( )

Gets a version of Pdf from Pdf file header.

◆ GetCatalogValue()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::Document::GetCatalogValue ( System::String key )

Returns item value from catalog dictionary.

Parameters

key	The key of item.

Returns: Item value - if key was successfully found; otherwise, null.

◆ GetMetadataStream()

System::SharedPtr<Engine::Data::Types::IPdfStreamAccessor> Aspose::Pdf::Document::GetMetadataStream ( )

protected

Returns raw metadata stream

Returns

◆ GetObjectById() [1/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::Document::GetObjectById ( System::String id )

Gets a object with specified ID in the document.

Parameters

id	The object id.

Returns: The object with specified id. Null if the id is not found.

◆ GetObjectById() [2/2]

static System::SharedPtr<System::Object> Aspose::Pdf::Document::GetObjectById	(	System::String	id,
		System::SharedPtr< Paragraphs >	paragraphs
	)

staticprotected

◆ GetPdfACompliance()

System::Nullable<Aspose::Pdf::PdfFormat> Aspose::Pdf::Document::GetPdfACompliance ( )

protected

Gets the PDF/A compliance level of the current document.

Returns: The PDF/A format of the current document if it complies with any of the PDF/A standards, otherwise null.

This method checks the metadata of the document to determine its PDF/A compliance level. It supports PDF/A-1a, PDF/A-2a , PDF/A-3a , and PDF/A-4\4e\4f formats.

◆ GetResourcesFor()

System::SharedPtr<Resources> Aspose::Pdf::Document::GetResourcesFor ( System::SharedPtr< Engine::Data::IPdfObject > obj )

protected

◆ GetXmpMetadata()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::GetXmpMetadata ( System::SharedPtr< System::IO::Stream > stream )

Get XMP metadata from document.

Parameters

stream Stream where metadata will be stored.

◆ HasIncrementalUpdate()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::HasIncrementalUpdate ( )

Checks if the current PDF document has been saved with incremental updates.

Returns: true if the PDF document has incremental updates; otherwise, false.

◆ ImportAnnotationsFromXfdf() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::ImportAnnotationsFromXfdf ( System::String fileName )

Imports annotations from XFDF file to document.

Parameters

fileName XFDF file name

◆ ImportAnnotationsFromXfdf() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::ImportAnnotationsFromXfdf ( System::SharedPtr< System::IO::Stream > stream )

Imports annotations from stream to document.

Parameters

stream Stream contains XFDF data.

◆ IndivisibleLevel()

static int32_t& Aspose::Pdf::Document::IndivisibleLevel ( )

staticprotected

◆ InitInternalHyperlinksTargetsData()

void Aspose::Pdf::Document::InitInternalHyperlinksTargetsData ( System::SharedPtr< UnifiedSaveOptions > options )

protected

Initializes the internal hyperlinks targets data on document loading.

◆ IsCertified()

bool Aspose::Pdf::Document::IsCertified ( )

protected

◆ IsVentureLicenseValid()

static bool Aspose::Pdf::Document::IsVentureLicenseValid ( System::SharedPtr< LicenseManagement::VentureLicense > _ventureLicense )

staticprotected

◆ LoadDocument()

void Aspose::Pdf::Document::LoadDocument	(	System::SharedPtr< System::IO::Stream >	input,
		System::SharedPtr< LoadOptions >	options
	)

protected

◆ LoadFrom()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::LoadFrom	(	System::String	filename,
		System::SharedPtr< LoadOptions >	options
	)

Loads a file, converting it to PDF.

Parameters

filename	The path to the file to open.
options	The load options.

Exceptions

PdfException	If the file cannot be loaded.
FileNotFoundException	If the file is not found.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Document::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Document	,
		CODEPORTING_ARGS(PdfVersion version)
	)

protected

◆ Merge() [1/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Merge	(	System::SharedPtr< Document::MergeOptions >	mergeOptions,
		const System::ArrayPtr< System::SharedPtr< Document >> &	documents
	)

Merges documents.

Parameters

mergeOptions	The merge options.
documents	The documents to merge.

◆ Merge() [2/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Merge	(	System::SharedPtr< Document::MergeOptions >	mergeOptions,
		const System::ArrayPtr< System::String > &	files
	)

Merges documents.

Parameters

mergeOptions	The merge options.
files	The pdf-files to merge.

◆ Merge() [3/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Merge ( const System::ArrayPtr< System::SharedPtr< Document >> & documents )

Merges documents.

Parameters

documents The documents to merge.

◆ Merge() [4/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Merge ( const System::ArrayPtr< System::String > & files )

Merges pdf files.

Parameters

files The pdf-files to merge.

◆ MergeDocuments() [1/4]

static ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::Document::MergeDocuments	(	System::SharedPtr< Document::MergeOptions >	mergeOptions,
		const System::ArrayPtr< System::String > &	files
	)

static

Merges documents.

Parameters

mergeOptions	The merge options.
files	The pdf-files to merge.

Returns: The merged document.

◆ MergeDocuments() [2/4]

static ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::Document::MergeDocuments	(	System::SharedPtr< Document::MergeOptions >	mergeOptions,
		const System::ArrayPtr< System::SharedPtr< Document >> &	files
	)

static

Merges documents.

Parameters

mergeOptions
files	The documents to merge.

Returns: The merged document.

◆ MergeDocuments() [3/4]

static ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::Document::MergeDocuments ( const System::ArrayPtr< System::String > & files )

static

Merges pdf files.

Parameters

files The pdf-files to merge.

Returns: The merged document.

◆ MergeDocuments() [4/4]

static ASPOSE_PDF_SHARED_API System::SharedPtr<Document> Aspose::Pdf::Document::MergeDocuments ( const System::ArrayPtr< System::SharedPtr< Document >> & documents )

static

Merges documents.

Parameters

documents The documents to merge.

Returns: The merged document.

◆ NotifyAboutSubstitution()

void Aspose::Pdf::Document::NotifyAboutSubstitution	(	System::SharedPtr< Aspose::Pdf::Text::Font >	oldFont,
		System::SharedPtr< Aspose::Pdf::Text::Font >	newFont
	)

protected

◆ Optimize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Optimize ( )

Linearize the document in order to

open the first page as quickly as possible;
display next page or follow by link to the next page as quickly as possible;
display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first);
permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed. Invoking this method doesn't actually saves the document. On the contrary the document only is prepared to have optimized structure, call then Save to get optimized document.

◆ OptimizeResourceInternal() [1/2]

System::SharedPtr<System::Collections::Generic::Dictionary<int32_t, int32_t> > Aspose::Pdf::Document::OptimizeResourceInternal ( System::SharedPtr< Aspose::Pdf::Optimization::OptimizationOptions > strategy )

protected

◆ OptimizeResourceInternal() [2/2]

System::SharedPtr<System::Collections::Generic::Dictionary<int32_t, int32_t> > Aspose::Pdf::Document::OptimizeResourceInternal ( )

protected

◆ OptimizeResources() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::OptimizeResources ( )

Optimize resources in the document:

Resources which are not used on the document pages are removed;
Equal resources are joined into one object;
Unused objects are deleted.

◆ OptimizeResources() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::OptimizeResources ( System::SharedPtr< Aspose::Pdf::Optimization::OptimizationOptions > strategy )

Optimize resources in the document according to defined optimization strategy.

Parameters

strategy Optimization strategy.

◆ PageNodesToBalancedTree()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::PageNodesToBalancedTree ( uint8_t nodesNumInSubtrees = DefaultNodesNumInSubtrees )

Organizes page tree nodes in a document into a balanced tree. Only if the document has more than nodesNumInSubtrees page objects, otherwise it does nothing. Do not call this method while iterating over Pages elements, it may give unpredictable results

Parameters

nodesNumInSubtrees Desired number of subnodes. Default value is ten.

◆ PreSave()

static void Aspose::Pdf::Document::PreSave	(	System::SharedPtr< PageCollection >	pages,
		System::SharedPtr< SaveOptions >	saveOptions
	)

staticprotected

◆ ProcessLayers()

void Aspose::Pdf::Document::ProcessLayers ( )

protected

Process layers for generator.

◆ ProcessParagraphs()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::ProcessParagraphs ( )

Process paragraphs for generator.

◆ RegisterAfterImportAnnotation()

void Aspose::Pdf::Document::RegisterAfterImportAnnotation ( System::SharedPtr< Annotations::Annotation > annotation )

protected

Register annotation for which AfterImport method must be called after import finished.

Parameters

annotation

◆ RegisterMetadata()

void Aspose::Pdf::Document::RegisterMetadata ( System::SharedPtr< Aspose::Pdf::Metadata > metadata )

protected

◆ ReleaseResourcesFor()

void Aspose::Pdf::Document::ReleaseResourcesFor ( System::SharedPtr< Engine::Data::IPdfObject > obj )

protected

◆ RemoveMetadata()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::RemoveMetadata ( )

Removes metadata from the document.

◆ RemoveObject()

void Aspose::Pdf::Document::RemoveObject ( System::SharedPtr< Engine::Data::IPdfObject > pdfObject )

protected

Removes the specified PDF object from the document.

Parameters

pdfObject The PDF object to be removed.

◆ RemoveOptionalContentPropertyWithObject()

void Aspose::Pdf::Document::RemoveOptionalContentPropertyWithObject ( int32_t objectId )

protected

Removes the optional content property with the specified name from the document.

Parameters

objectId The object id of the optional content property to be removed.

◆ RemovePdfaCompliance()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::RemovePdfaCompliance ( )

Remove pdfa compliance from the document

◆ RemovePdfUaCompliance()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::RemovePdfUaCompliance ( )

Remove pdfUa compliance from the document

◆ Repair()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Repair ( System::SharedPtr< Document::RepairOptions > options = nullptr )

Repairs broken document.

Parameters

options An optional parameter of type RepairOptions to specify repair settings. If not provided, default settings will be used.

◆ ResetRestrictions()

void Aspose::Pdf::Document::ResetRestrictions ( )

protected

◆ Restrict() [1/2]

static void Aspose::Pdf::Document::Restrict	(	System::SharedPtr< Engine::Data::ITrailerable >	tr,
		int32_t	index
	)

staticprotected

◆ Restrict() [2/2]

static void Aspose::Pdf::Document::Restrict	(	System::SharedPtr< Document >	doc,
		int32_t	index
	)

staticprotected

◆ Restricted() [1/3]

static bool Aspose::Pdf::Document::Restricted	(	System::SharedPtr< Engine::Data::ITrailerable >	tr,
		int32_t	index
	)

staticprotected

◆ Restricted() [2/3]

static bool Aspose::Pdf::Document::Restricted	(	System::SharedPtr< Document >	doc,
		int32_t	index
	)

staticprotected

◆ Restricted() [3/3]

static bool Aspose::Pdf::Document::Restricted	(	System::SharedPtr< LicenseManagement::VentureLicense >	ventureLicense,
		int32_t	index
	)

staticprotected

◆ ResumeUpdate()

void Aspose::Pdf::Document::ResumeUpdate ( )

protected

resumes document update

◆ Save() [1/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save ( System::SharedPtr< System::IO::Stream > output )

Stores document into stream.

Parameters

output Stream where document shell be stored.

◆ Save() [2/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save ( System::String outputFileName )

Saves document into the specified file.

Parameters

outputFileName Path to file where the document will be stored.

◆ Save() [3/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save ( )

Save document incrementally (i.e. using incremental update technique).

In order to save document incrementally we should open the document file for writing. Therefore Document must be initialized with writable stream like in the next code snippet: Document doc = new Document(new FileStream("document.pdf", FileMode.Open, FileAccess.ReadWrite)); // make some changes and save the document incrementally doc.Save();

◆ Save() [4/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save ( System::SharedPtr< SaveOptions > options )

Saves the document with save options.

Parameters

options Save options.

◆ Save() [5/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save	(	System::String	outputFileName,
		SaveFormat	format
	)

Saves the document with a new name along with a file format.

Parameters

outputFileName	Path to file where the document will be stored.
format	Format options.

◆ Save() [6/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save	(	System::SharedPtr< System::IO::Stream >	outputStream,
		SaveFormat	format
	)

Saves the document with a new name along with a file format.

Exceptions

ArgumentException ArgumentException when HtmlSaveOptions is passed to a method. Save a document to the html stream is not supported. Please use method save to the file.

Parameters

outputStream	Stream where the document will be stored.
format	Format options.

◆ Save() [7/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save	(	System::String	outputFileName,
		System::SharedPtr< SaveOptions >	options
	)

Saves the document with a new name setting its save options.

Parameters

outputFileName	Path to file where the document will be stored.
options	Save options.

◆ Save() [8/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save	(	System::SharedPtr< System::IO::Stream >	outputStream,
		System::SharedPtr< SaveOptions >	options
	)

Saves the document to a stream with a save options.

Exceptions

ArgumentException ArgumentException when HtmlSaveOptions is passed to a method. Save a document to the html stream is not supported. Please use method save to the file.

Parameters

outputStream	Stream where the document will be stored.
options	Save options.

◆ Save() [9/9]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::Save	(	System::SharedPtr< System::Web::HttpResponse >	response,
		System::String	outputFileName,
		ContentDisposition	disposition,
		System::SharedPtr< SaveOptions >	options
	)

Saves the document to a response stream with a save options.

Parameters

response	Encapsulates HTTP-response information.
outputFileName	Simple file name, i.e. without path.
disposition	Represents a MIME protocol Content-Disposition header.
options	Save options.

◆ SaveXml()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SaveXml ( System::String file )

Save document to XML.

Parameters

file	The document model xml file

◆ SendTo() [1/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SendTo	(	System::SharedPtr< Devices::DocumentDevice >	device,
		System::SharedPtr< System::IO::Stream >	output
	)

Sends the whole document to the document device for processing.

Parameters

device	Document device which is used to process the document.
output	Output stream contains the results of the document processing with given device.

◆ SendTo() [2/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SendTo	(	System::SharedPtr< Devices::DocumentDevice >	device,
		int32_t	fromPage,
		int32_t	toPage,
		System::SharedPtr< System::IO::Stream >	output
	)

Sends the certain pages of the document to the document device for processing.

Parameters

device	Document device which is used to process the document.
fromPage	The first page for processing.
toPage	The last page for processing.
output	Output stream contains the results of the document pages processing with given device.

◆ SendTo() [3/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SendTo	(	System::SharedPtr< Devices::DocumentDevice >	device,
		System::String	outputFileName
	)

Sends the whole document to the document device for processing.

Parameters

device	Document device which is used to process the document.
outputFileName	Output file name with the results of processing.

◆ SendTo() [4/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SendTo	(	System::SharedPtr< Devices::DocumentDevice >	device,
		int32_t	fromPage,
		int32_t	toPage,
		System::String	outputFileName
	)

Sends the whole document to the document device for processing.

Parameters

device	Document device which is used to process the document.
fromPage	The first page for processing.
toPage	The last page for processing.
outputFileName	Output file name with the results of processing.

◆ set_AllowReusePageContent()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_AllowReusePageContent ( bool value )

Allows to merge page contents to optimize docuement size. If used then differnet but duplicated pages may reference to the same content object. Please note that this mode may cause side effects like changing page content when other page is changed.

◆ set_ApsPages()

void Aspose::Pdf::Document::set_ApsPages ( System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Aspose::Rendering::ApsPage >>> value )

protected

List of APS pages for the case of F1-to-F2 conversion when neither F1 nor F2 is PDF.

◆ set_Background()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_Background ( System::SharedPtr< Color > value )

Sets the background color of the document.

◆ set_CenterWindow()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_CenterWindow ( bool value )

Sets flag specifying whether position of the document's window will be centerd on the screen.

◆ set_Collection()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_Collection ( System::SharedPtr< Aspose::Pdf::Collection > value )

Gets collection of document.

◆ set_Direction()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_Direction ( Aspose::Pdf::Direction value )

Sets reading order of text: L2R (left to right) or R2L (right to left).

◆ set_DisableFontLicenseVerifications()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_DisableFontLicenseVerifications ( bool value )

Many operations with font can't be executed if these operations are prohibited by license of this font. For example some font can't be embedded into PDF document if license rules disable embedding for this font. This flag is used to disable any license restrictions for all fonts in current PDF document. Be careful when using this flag. When it is set it means that person who sets this flag, takes all responsibility of possible license/law violations on himself. So He takes it on it's own risk. It's strongly recommended to use this flag only when you are fully confident that you are not breaking the copyright law. By default false.

◆ set_DisplayDocTitle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_DisplayDocTitle ( bool value )

Sets flag specifying whether document's window title bar should display document title.

◆ set_Duplex()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_Duplex ( PrintDuplex value )

Sets print duplex mode handling option to use when printing the file from the print dialog.

◆ set_EmbedStandardFonts()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_EmbedStandardFonts ( bool value )

Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true. All PDF fonts can be embedded into document simply via setting of flag IsEmbedded into true, but PDF standard Type1 fonts is an exception from this rule. Standard Type1 font embedding requires much time, so to embed these fonts it's necessary not only set flag IsEmbedded into true for specified font but also set an additiona flag on document's level - EmbedStandardFonts = true; This property can be set only one time for all fonts. By default false.

◆ set_EnableObjectUnload()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_EnableObjectUnload ( bool value )

Get or sets flag which enables document partially be unloaded from memory. This allow to decrease memory usage but may have negative effect on perfomance.

◆ set_EnableSignatureSanitization()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_EnableSignatureSanitization ( bool value )

Sets flag to manage signature fields sanitization. Enabled by default.

◆ set_FileSizeLimitToMemoryLoading()

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_FileSizeLimitToMemoryLoading ( int32_t value )

static

Get and set the file size limit for loading an entire file into memory. The value is set in megabytes. The default value is 210 Mb.

◆ set_FitWindow()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_FitWindow ( bool value )

Sets flag specifying whether document window must be resized to fit the first displayed page.

◆ set_FontReplaceBehavior()

void Aspose::Pdf::Document::set_FontReplaceBehavior ( Text::TextEditOptions::FontReplace value )

protected

◆ set_HandleSignatureChange()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_HandleSignatureChange ( bool value )

Throw Exception if the document will save with changes and have signature

◆ set_HideMenubar()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_HideMenubar ( bool value )

Sets flag specifying whether menu bar should be hidden when document is active.

◆ set_HideToolBar()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_HideToolBar ( bool value )

Sets flag specifying whether toolbar should be hidden when document is active.

◆ set_HideWindowUI()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_HideWindowUI ( bool value )

Sets flag specifying whether user interface elements should be hidden when document is active.

◆ set_IgnoreCorruptedObjects()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_IgnoreCorruptedObjects ( bool value )

Sets flag of ignoring errors in source files. When pages from source document copied into destination document, copying process is stopped with exception if some objects in source files are corrupted when this flag is false. example: dest.Pages.Add(src.Pages); If this flag is set to true then corrupted objects will be replaced with empty values. By default: true.

◆ set_InternalHyperlinkTargets()

void Aspose::Pdf::Document::set_InternalHyperlinkTargets ( System::SharedPtr< System::Collections::Generic::IDictionary< int32_t, System::SharedPtr< System::Collections::Generic::List< System::Drawing::RectangleF >>>> value )

protected

◆ set_IsConvertMetadataAndCatalogOnly()

void Aspose::Pdf::Document::set_IsConvertMetadataAndCatalogOnly ( bool value )

protected

Gets convert parameter for pdf/ua converter (Convert only Metadata and Document Catalog if set true)

◆ set_IsLinearized()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_IsLinearized ( bool value )

Sets a value indicating whether document is linearized.

◆ set_IsParagraphsAdded()

void Aspose::Pdf::Document::set_IsParagraphsAdded ( bool value )

protected

◆ set_IsXrefGapsAllowed()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_IsXrefGapsAllowed ( bool value )

Sets the is document pdfa compliant.

◆ set_NonFullScreenPageMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_NonFullScreenPageMode ( Aspose::Pdf::PageMode value )

Sets page mode, specifying how to display the document on exiting full-screen mode.

◆ set_OpenAction()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_OpenAction ( System::SharedPtr< Annotations::IAppointment > value )

Sets action performed at document opening.

◆ set_OptimizeSize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_OptimizeSize ( bool value )

Sets optimization flag. When pages are added to document, equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false.

◆ set_PageInfo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_PageInfo ( System::SharedPtr< Aspose::Pdf::PageInfo > value )

Sets the page info.(for generator only, not filled in when reading document)

The page info.

◆ set_PageLayout()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_PageLayout ( Aspose::Pdf::PageLayout value )

Sets page layout which shall be used when the document is opened.

◆ set_PageMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_PageMode ( Aspose::Pdf::PageMode value )

Sets page mode, specifying how document should be displayed when opened.

◆ set_ParentTreeNextKey()

void Aspose::Pdf::Document::set_ParentTreeNextKey ( int32_t value )

protected

◆ set_PickTrayByPdfSize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_PickTrayByPdfSize ( bool value )

Sets a flag specifying whether the PDF page size shall be used to select the input paper tray.

◆ set_PrintScaling()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::set_PrintScaling ( Aspose::Pdf::PrintScaling value )

Sets the page scaling option that shall be selected when a print dialog is displayed for this document.

◆ SetDefaultFileSizeLimitToMemoryLoading()

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SetDefaultFileSizeLimitToMemoryLoading ( )

static

Sets the file size limit for loading an entire file into memory to default value equals 210 Mb.

◆ SetPlugin()

void Aspose::Pdf::Document::SetPlugin ( Documentize::Plugin plugin )

protected

◆ SetResourcesFor()

void Aspose::Pdf::Document::SetResourcesFor	(	System::SharedPtr< Engine::Data::IPdfObject >	obj,
		System::SharedPtr< Resources >	res
	)

protected

◆ SetSimpleFontEncodingRule()

void Aspose::Pdf::Document::SetSimpleFontEncodingRule ( HtmlSaveOptions::FontEncodingRules rule )

protected

◆ SetTitle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SetTitle ( System::String title )

Set Title for Pdf Document

Parameters

title Document's title

◆ SetXmpMetadata()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Document::SetXmpMetadata ( System::SharedPtr< System::IO::Stream > stream )

Set XMP metadata of document.

Parameters

stream Stream which contains XMP metadata.

◆ StartOperation()

static void Aspose::Pdf::Document::StartOperation ( )

staticprotected

◆ SuppressUpdate()

void Aspose::Pdf::Document::SuppressUpdate ( )

protected

Suppresses update contents data for all pages The contents is not updated until ResumeUpdate is called

◆ TransformRestrictionKey()

static uint64_t Aspose::Pdf::Document::TransformRestrictionKey ( uint64_t key )

staticprotected

◆ UncompressObject()

void Aspose::Pdf::Document::UncompressObject ( System::SharedPtr< Engine::Data::IPdfObject > obj )

protected

◆ UpdateMetadata()

static void Aspose::Pdf::Document::UpdateMetadata	(	System::SharedPtr< Engine::PdfDocument >	document,
		System::SharedPtr< Aspose::Pdf::Metadata >	metadata
	)

staticprotected

◆ UpdatePages()

void Aspose::Pdf::Document::UpdatePages ( )

protected

◆ UpdatePagesResources()

void Aspose::Pdf::Document::UpdatePagesResources ( )

protected

Copies shared resources into pages.

◆ UpdateXFormResources()

void Aspose::Pdf::Document::UpdateXFormResources ( )

protected

Copies resources from Page into its XForm.

◆ Validate() [1/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Validate	(	System::String	outputLogFileName,
		Aspose::Pdf::PdfFormat	format
	)

Validate document into the specified file.

Parameters

outputLogFileName	Path to file where the comments will be stored.
format	The pdf format.

Returns: The operation result

◆ Validate() [2/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Validate	(	System::SharedPtr< System::IO::Stream >	outputLogStream,
		Aspose::Pdf::PdfFormat	format
	)

Validate document into the specified file.

Parameters

outputLogStream	Stream where the comments will be stored.
format	The pdf format.

Returns: The operation result

◆ Validate() [3/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Document::Validate ( System::SharedPtr< PdfFormatConversionOptions > options )

Validate document into the specified file.

Parameters

options set of options for convert PDF document

Returns: The operation result

◆ ValidateAnnotations()

void Aspose::Pdf::Document::ValidateAnnotations ( )

protected

Member Data Documentation

◆ _commonXObjects

System::SharedPtr<System::Collections::Generic::Dictionary<System::String, System::SharedPtr<Engine::CommonData::Text::Segmenting::TextSegmentBuilder> > > Aspose::Pdf::Document::_commonXObjects

protected

◆ _engineDoc

System::SharedPtr<Engine::IPdfDocument> Aspose::Pdf::Document::_engineDoc

protected

Instance of IPdfDocument used to access to internal document structure.

◆ DefaultNodesNumInSubtrees

const ASPOSE_PDF_SHARED_API uint8_t Aspose::Pdf::Document::DefaultNodesNumInSubtrees

static

◆ FontSaveOptions

System::SharedPtr<Engine::CommonData::Text::Fonts::Utilities::IDocumentFontSaveOptions> Aspose::Pdf::Document::FontSaveOptions

protected

◆ FontSubstitution

System::Event<void(System::SharedPtr<Text::Font>, System::SharedPtr<Text::Font>)> Aspose::Pdf::Document::FontSubstitution

Occurs when font replaces another font in document.

◆ IsPdfAConversionMode

bool Aspose::Pdf::Document::IsPdfAConversionMode

protected

◆ Pipeline

System::SharedPtr<ConversionPipeline> Aspose::Pdf::Document::Pipeline

protected

◆ ReloadAfterLinearization

bool Aspose::Pdf::Document::ReloadAfterLinearization

protected

◆ syncRoot

System::SharedPtr<System::Object> Aspose::Pdf::Document::syncRoot

staticprotected

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CallBackGetHocr

◆ CallBackGetHocrWithPage

◆ FontSubstitutionHandler

Constructor & Destructor Documentation

◆ Document() [1/12]

◆ Document() [2/12]

◆ Document() [3/12]

◆ Document() [4/12]

◆ Document() [5/12]

◆ Document() [6/12]

◆ Document() [7/12]

◆ Document() [8/12]

◆ Document() [9/12]

◆ Document() [10/12]

◆ Document() [11/12]

◆ Document() [12/12]

◆ ~Document()

Member Function Documentation

◆ AddLayers()

◆ AfterImport()

◆ BindXml() [1/5]

◆ BindXml() [2/5]

◆ BindXml() [3/5]

◆ BindXml() [4/5]

◆ BindXml() [5/5]

◆ ChangePasswords()

◆ Check() [1/2]

◆ Check() [2/2]

◆ ContainSignature()

◆ Convert() [1/17]

◆ Convert() [2/17]

◆ Convert() [3/17]

◆ Convert() [4/17]

◆ Convert() [5/17]

◆ Convert() [6/17]

◆ Convert() [7/17]

◆ Convert() [8/17]

◆ Convert() [9/17]

◆ Convert() [10/17]

◆ Convert() [11/17]

◆ Convert() [12/17]

◆ Convert() [13/17]

◆ Convert() [14/17]

◆ Convert() [15/17]

◆ Convert() [16/17]

◆ Convert() [17/17]

◆ ConvertPageToPNGMemoryStream()

◆ cpp_keep_pcl_parser()

◆ cpp_keep_text_segment_builder()

◆ cpp_keep_trailerable()

◆ Decrypt()

◆ Dispose()

◆ Encrypt() [1/3]

◆ Encrypt() [2/3]

◆ Encrypt() [3/3]

◆ EndOperation()

◆ ExportAnnotationsToXfdf() [1/2]

◆ ExportAnnotationsToXfdf() [2/2]

◆ Flatten() [1/2]

◆ Flatten() [2/2]

◆ FlattenA()

◆ FlattenB()

◆ FlattenTransparency()

◆ FreeMemory()

◆ get___Indivisible()

◆ get__IsLicensed()

◆ get__IsObjectLicensed()

◆ get_Actions()