Class representing page of PDF document. More...

#include "Page.h"

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

Public Types

using BeforePageGenerate = System::MulticastDelegate< void(System::SharedPtr< Page >)>
 Procedure for customize header and footer. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_IsAddParagraphsAfterLast () const
 Gets the addition of paragraphs after the last paragraph of the page More...
 
ASPOSE_PDF_SHARED_API void set_IsAddParagraphsAfterLast (bool value)
 Sets the addition of paragraphs after the last paragraph of the page More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Imageget_BackgroundImage () const
 Gets background image for page (for generator only). More...
 
ASPOSE_PDF_SHARED_API void set_BackgroundImage (System::SharedPtr< Image > value)
 Sets background image for page (for generator only). More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::TocInfoget_TocInfo () const
 Gets table of contents info. More...
 
ASPOSE_PDF_SHARED_API void set_TocInfo (System::SharedPtr< Aspose::Pdf::TocInfo > value)
 Sets table of contents info. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< HeaderFooterget_Header () const
 Gets page header. More...
 
ASPOSE_PDF_SHARED_API void set_Header (System::SharedPtr< HeaderFooter > value)
 Sets page header. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Layer > > > get_Layers ()
 Gets layers collection. More...
 
ASPOSE_PDF_SHARED_API void set_Layers (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Layer >>> value)
 Sets layers collection. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< HeaderFooterget_Footer () const
 Gets page footer. More...
 
ASPOSE_PDF_SHARED_API void set_Footer (System::SharedPtr< HeaderFooter > value)
 Sets page footer. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Paragraphsget_Paragraphs ()
 Gets the paragraphs. More...
 
ASPOSE_PDF_SHARED_API void set_Paragraphs (System::SharedPtr< Aspose::Pdf::Paragraphs > value)
 Gets the paragraphs. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::PageInfoget_PageInfo ()
 Gets the page info (for generator only, not filled in when reading file). 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 file). More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_Rect ()
 Gets rectangle of the page. For get: page crop box is returned if specified, otherwise page media box is returned. For set: page media box always set. Please note that this property don't consider page rotation. To get page rectangle considering rotation please use ActualRect. More...
 
ASPOSE_PDF_SHARED_API void set_Rect (System::SharedPtr< Aspose::Pdf::Rectangle > value)
 Sets rectangle of the page. For get: page crop box is returned if specified, otherwise page media box is returned. For set: page media box always set. Please note that this property don't consider page rotation. To get page rectangle considering rotation please use ActualRect. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::ColorType get_ColorType ()
 Sets color type of the pages based on information getting from operators SetColor, images and forms. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< GraphInfoget_NoteLineStyle () const
 Gets the line style for notes.(for generator only) More...
 
ASPOSE_PDF_SHARED_API void set_NoteLineStyle (System::SharedPtr< GraphInfo > value)
 Sets the line style for notes.(for generator only) More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::TabOrder get_TabOrder ()
 Gets tab order of the page. Possible values: Row, Column. Default, Manual More...
 
ASPOSE_PDF_SHARED_API void set_TabOrder (Aspose::Pdf::TabOrder value)
 Sets tab order of the page. Possible values: Row, Column. Default, Manual More...
 
ASPOSE_PDF_SHARED_API double get_Duration ()
 Gets of set page display duration. This is time in seconds that page shall be displayed during presentation. Returs -1 if duration is not defined. More...
 
ASPOSE_PDF_SHARED_API void set_Duration (double value)
 Gets of set page display duration. This is time in seconds that page shall be displayed during presentation. Returs -1 if duration is not defined. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< OperatorCollectionget_Contents ()
 Gets collection of operators in the content stream of the page. OperatorCollection More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Groupget_Group ()
 Gets a group attributes class specifying the attributes of the page�s page group for use in the transparent imaging model. More...
 
ASPOSE_PDF_SHARED_API void set_Group (System::SharedPtr< Aspose::Pdf::Group > value)
 Sets a group attributes class specifying the attributes of the page�s page group for use in the transparent imaging model. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Annotations::AnnotationCollectionget_Annotations ()
 Gets collection of page annotations. Annotations More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Resourcesget_Resources ()
 Gets page resources. Resources object contains collections of images, forms and fonts. Resources More...
 
ASPOSE_PDF_SHARED_API Rotation get_Rotate ()
 Gets rotation of the page. More...
 
ASPOSE_PDF_SHARED_API void set_Rotate (Rotation value)
 Sets rotation of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_TrimBox ()
 Gets trim box of the page. More...
 
ASPOSE_PDF_SHARED_API void set_TrimBox (System::SharedPtr< Aspose::Pdf::Rectangle > value)
 Sets trim box of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_ArtBox ()
 Gets art box of the page. More...
 
ASPOSE_PDF_SHARED_API void set_ArtBox (System::SharedPtr< Aspose::Pdf::Rectangle > value)
 Sets art box of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_BleedBox ()
 Gets bleed box of the page. More...
 
ASPOSE_PDF_SHARED_API void set_BleedBox (System::SharedPtr< Aspose::Pdf::Rectangle > value)
 Sets bleed box of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_CropBox ()
 Gets crop box of the page. More...
 
ASPOSE_PDF_SHARED_API void set_CropBox (System::SharedPtr< Aspose::Pdf::Rectangle > value)
 Sets crop box of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_MediaBox ()
 Gets media box of the page. More...
 
ASPOSE_PDF_SHARED_API void set_MediaBox (System::SharedPtr< Aspose::Pdf::Rectangle > value)
 Sets media box of the page. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Number ()
 Get number of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Matrixget_RotationMatrix ()
 Gets transofmation matrix for the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Colorget_Background ()
 Gets the background color of the page. More...
 
ASPOSE_PDF_SHARED_API void set_Background (System::SharedPtr< Color > value)
 Sets the background color of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Watermarkget_Watermark ()
 Gets the watermark of the page. More...
 
ASPOSE_PDF_SHARED_API void set_Watermark (System::SharedPtr< Aspose::Pdf::Watermark > value)
 Sets the watermark of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< ArtifactCollectionget_Artifacts ()
 Gets collection of artifacts on the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< PageActionCollectionget_Actions ()
 Gets collection of page properties. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< Forms::Field > > > get_FieldsInTabOrder ()
 Gets list of Field object in Tab order on this page. More...
 
ASPOSE_PDF_SHARED_API double get_UserUnit ()
 Gets UserUnit value. A positive number giving the size of default user space units, in multiples of 1 ⁄ 72 inch. Default value is 1. Please set zero or negative value in order to clear this entry in page. More...
 
ASPOSE_PDF_SHARED_API void set_UserUnit (double value)
 Sets UserUnit value. A positive number giving the size of default user space units, in multiples of 1 ⁄ 72 inch. Default value is 1. Please set zero or negative value in order to clear this entry in page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::MemoryStreamConvertToPNGMemoryStream ()
 Convert page to PNG for DSR, OMR, OCR image stream. More...
 
ASPOSE_PDF_SHARED_API bool IsBlank (double fillThresholdFactor)
 Gets the flag whether page is blank or not. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::RectangleGetPageRect (bool considerRotation)
 Returns rectangle of the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::RectangleCalculateContentBBox ()
 Calculates bbox value - rectangle containing contents without visible margins. More...
 
ASPOSE_PDF_SHARED_API void SendTo (System::SharedPtr< Devices::PageDevice > device, System::SharedPtr< System::IO::Stream > output)
 Sends page to process with given page device. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< Annotations::AnnotationSelector > visitor)
 Accepts AnnotationSelector visitor object that provides functionality to work with annotations. More...
 
ASPOSE_PDF_SHARED_API void AddStamp (System::SharedPtr< Stamp > stamp)
 Put stamp into page. Stamp can be page number, image or simple text, e.g. some logo. More...
 
ASPOSE_PDF_SHARED_API void AddImage (System::SharedPtr< System::IO::Stream > imageStream, System::SharedPtr< Aspose::Pdf::Rectangle > imageRect)
 Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion. More...
 
ASPOSE_PDF_SHARED_API void AddImage (System::String hocr, System::SharedPtr< System::IO::Stream > imageStream, System::SharedPtr< Aspose::Pdf::Rectangle > imageRect)
 Adds searchable image onto the page and locates it in the middle of specified rectangle saving image's proportion. More...
 
ASPOSE_PDF_SHARED_API void AddImage (System::SharedPtr< System::IO::Stream > imageStream, System::SharedPtr< Aspose::Pdf::Rectangle > imageRect, int32_t imageWidth, int32_t imageHeight, bool saveImageProportions)
 Adds image on page and places it depend on image rectangle position. More...
 
ASPOSE_PDF_SHARED_API void AddImage (System::String imagePath, System::SharedPtr< Aspose::Pdf::Rectangle > rectangle)
 Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion. More...
 
ASPOSE_PDF_SHARED_API void SendTo (System::SharedPtr< Devices::PageDevice > device, System::String outputFileName)
 Sends page to process with given page device. More...
 
ASPOSE_PDF_SHARED_API void Flatten ()
 Removes all fields located on the page and place their values instead. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< Text::TextFragmentAbsorber > visitor)
 Accepts TextFragmentAbsorber visitor object that provides functionality to work with text objects. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< ImagePlacementAbsorber > visitor)
 Accepts ImagePlacementAbsorber visitor object that provides functionality to work with image placement objects. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< Text::TextAbsorber > visitor)
 Accepts TextAbsorber visitor object that provides functionality to work with text objects. More...
 
ASPOSE_PDF_SHARED_API void SetPageSize (double width, double height)
 Sets page size for page. More...
 
ASPOSE_PDF_SHARED_API void Dispose () override
 Frees up memory More...
 
ASPOSE_PDF_SHARED_API void MakeGrayscale ()
 Converts the page to grayscale. More...
 
ASPOSE_PDF_SHARED_API void FreeMemory () override
 Clears cached data More...
 
ASPOSE_PDF_SHARED_API System::String GetNotifications ()
 Returns notifications about inside operations with page content. (Only notifications about paragraph events in text adding scenarios are supported now.) More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< uint8_t > AsByteArray (System::SharedPtr< Devices::Resolution > resolution)
 Converts current page as bitmap and than returns array of bytes. More...
 
ASPOSE_PDF_SHARED_API System::String AsXml ()
 Converts current page as xml in utf8 encoding. 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 TypeInfoGetType () 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 int32_t RotationToInt (Rotation rotation)
 Translates rotation enumeration member into integer value. More...
 
static ASPOSE_PDF_SHARED_API Rotation IntToRotation (int32_t rotation)
 Translates integer value into corresponding rotation enumeration member. 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Public Attributes

System::Event< void(System::SharedPtr< Page >)> OnBeforePageGenerate
 Event for customize header and footer. More...
 

Protected Member Functions

bool get_IsRowExceedPageMode () const
 
void set_IsRowExceedPageMode (bool value)
 
double get_IsRowExceedPageHeigth () const
 
void set_IsRowExceedPageHeigth (double value)
 
bool get_IsTextAddedOnPage () const
 Gets whether text is added on page. Value indicates if the text operators on the page have been changed. Need if we use ContentsAppender class to update contents. See PDFNET-47949. More...
 
void set_IsTextAddedOnPage (bool value)
 Sets whether text is added on page. Value indicates if the text operators on the page have been changed. Need if we use ContentsAppender class to update contents. See PDFNET-47949. More...
 
double get_CurY () const
 Gets page current Y coordinate. More...
 
void set_CurY (double value)
 Sets page current Y coordinate. More...
 
bool get_IgnoreAnnotationExceptions () const
 Determines should be exceptions ignored during processing of annotations. More...
 
void set_IgnoreAnnotationExceptions (bool value)
 Determines should be exceptions ignored during processing of annotations. More...
 
System::SharedPtr< PageCollectionget_Pages () const
 Gets the pages collection. More...
 
void set_Pages (System::SharedPtr< PageCollection > value)
 Gets the pages collection. More...
 
System::String get_Id () const
 Gets the page id More...
 
void set_Id (System::String value)
 Sets the page id More...
 
System::SharedPtr< Aspose::Pdf::Rectangleget_Rectangle ()
 
bool get_IsNoteMoreThanPage () const
 
void set_IsNoteMoreThanPage (bool value)
 
int32_t get___BadNumber ()
 
System::SharedPtr< Aspose::Pdf::ContentsAppender > get_ContentsAppender ()
 Gets current contents appender. ContentsAppender More...
 
void _SetPageNumber (int32_t number)
 
void ProcessHeaderFooters ()
 Process header and footer. More...
 
void SetPageInfo ()
 
void ProcessParagraphs ()
 Process generator paragraphs. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > Accept (System::SharedPtr< Aspose::Rendering::ApsNode > node, System::Drawing::RectangleF rectangle)
 Accepts ApsNode aps root node (page, canvas, path, etc) object that needed to add onto the page, the clipping feature is skipped. The content is added onto the page. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > Accept (System::SharedPtr< Aspose::Rendering::ApsNode > node, System::Drawing::RectangleF rectangle, bool useClipping)
 Accepts ApsNode aps root node (page, canvas, path, etc) object that needed to add onto the page with clipping feature. The content is added onto the page. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > Accept (System::SharedPtr< Aspose::Rendering::ApsNode > node, System::Drawing::RectangleF rectangle, bool useClipping, bool addContent)
 Accepts ApsNode aps root node (page, canvas, path, etc) object that needed to add onto the page. More...
 
System::SharedPtr< Aspose::Pdf::RectangleGetRect ()
 Returns rectanlge of the page according to its CropBox and Media box; More...
 
void InvalidateAnnotations ()
 
 Page (System::SharedPtr< Engine::CommonData::IPage > page)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Page, CODEPORTING_ARGS(System::SharedPtr< Engine::CommonData::IPage > page))
 
System::SharedPtr< System::Collections::Generic::Dictionary< double, int32_t > > GetTextRotationStatistic ()
 Returns dictionary that contains frequencies for every unique rotation angle of text found. More...
 
void UpdateContents ()
 
void UpdateResources ()
 Updates the resources. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > AddImage (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Aspose::Pdf::Rectangle > rectangle, System::SharedPtr< CompositingParameters > compositingParameters)
 Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > AddImage (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Aspose::Pdf::Rectangle > rectangle, System::SharedPtr< Matrix > rotationMatrix, System::SharedPtr< CompositingParameters > compositingParameters, System::SharedPtr< Engine::Data::IPdfObject > &pdfObject, bool isTagged=false, int32_t MCID=0)
 Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > AddImage (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Aspose::Pdf::Rectangle > rectangle, System::SharedPtr< CompositingParameters > compositingParameters, bool addImage, bool isBlackWhite, System::SharedPtr< System::IO::Stream > predefinedStream=nullptr, bool isTagged=false, int32_t MCID=0)
 Adds image onto the page. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > AddImage (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Aspose::Pdf::Rectangle > rectangle, System::SharedPtr< Matrix > rotationMatrix, System::SharedPtr< CompositingParameters > compositingParameters, bool addImage, bool isBlackWhite, System::SharedPtr< Engine::Data::IPdfObject > &pdfObject, System::SharedPtr< System::IO::Stream > predefinedStream=nullptr, bool isTagged=false, int32_t MCID=0)
 Adds image onto the page. More...
 
void Flatten4 (bool doRemoveFiedls)
 
void SetTransition (System::SharedPtr< Engine::Data::IPdfDictionary > transition)
 
void RemoveObjectReferences (System::String name)
 Remove references to XObject from page contents (i.e. all Do operators which use name of object). More...
 
bool IsUsedOnPage (System::String name)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< System::Object > > > FindReferences (System::String name)
 
void FillUsedObjectsTable (System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t >> usageTable, System::SharedPtr< Engine::Data::IPdfDictionary > CommonResources)
 
void DeleteUnusedResources (System::SharedPtr< Engine::Data::IPdfDictionary > resources, System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t >> usageTable)
 
void DeleteUnusedResources (System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t >> usageTable)
 
void ClearContents ()
 
void RegisterObservation (System::String message)
 
void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)
 
void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)
 
void ReleaseResources ()
 
virtual ASPOSE_PDF_SHARED_API ~Page ()
 

Static Protected Member Functions

static System::SharedPtr< PageGetNextPage (System::SharedPtr< Page > page)
 Get next page and apply defaults. More...
 
static void PrintBackgroundImage (System::SharedPtr< Image > image, double width, double height, double curX, double curY, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> operators, System::SharedPtr< Page > page)
 
static System::SharedPtr< PageProcessPage (System::SharedPtr< Page > page)
 
static void RemoveObjectReferences (System::SharedPtr< OperatorCollection > contents, System::String name)
 
static System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< System::Object > > > FindReferences (System::SharedPtr< OperatorCollection > Contents, System::String name)
 Returns list of operators which uses resource with specified name. More...
 

Protected Attributes

bool detached
 
System::WeakPtr< Document_document
 
System::SharedPtr< Engine::CommonData::IPage > EnginePage
 

Detailed Description

Class representing page of PDF document.

Member Typedef Documentation

◆ BeforePageGenerate

Procedure for customize header and footer.

///

Parameters
pageThe current page.

Constructor & Destructor Documentation

◆ Page()

Aspose::Pdf::Page::Page ( System::SharedPtr< Engine::CommonData::IPage >  page)
protected

◆ ~Page()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Page::~Page ( )
protectedvirtual

Member Function Documentation

◆ _SetPageNumber()

void Aspose::Pdf::Page::_SetPageNumber ( int32_t  number)
protected

◆ Accept() [1/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::Accept ( System::SharedPtr< Annotations::AnnotationSelector visitor)

Accepts AnnotationSelector visitor object that provides functionality to work with annotations.

Parameters
visitorAnnotation selector sobject.

◆ Accept() [2/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::Accept ( System::SharedPtr< Text::TextFragmentAbsorber visitor)

Accepts TextFragmentAbsorber visitor object that provides functionality to work with text objects.

Parameters
visitorText absorber object.

◆ Accept() [3/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::Accept ( System::SharedPtr< ImagePlacementAbsorber visitor)

Accepts ImagePlacementAbsorber visitor object that provides functionality to work with image placement objects.

Parameters
visitorImage placement absorber object.

◆ Accept() [4/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::Accept ( System::SharedPtr< Text::TextAbsorber visitor)

Accepts TextAbsorber visitor object that provides functionality to work with text objects.

Parameters
visitorText absorber object.

◆ Accept() [5/7]

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Page::Accept ( System::SharedPtr< Aspose::Rendering::ApsNode >  node,
System::Drawing::RectangleF  rectangle 
)
protected

Accepts ApsNode aps root node (page, canvas, path, etc) object that needed to add onto the page, the clipping feature is skipped. The content is added onto the page.

Parameters
nodeThe aps root node object.
rectangleThe size of area to add apps node object.

◆ Accept() [6/7]

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Page::Accept ( System::SharedPtr< Aspose::Rendering::ApsNode >  node,
System::Drawing::RectangleF  rectangle,
bool  useClipping 
)
protected

Accepts ApsNode aps root node (page, canvas, path, etc) object that needed to add onto the page with clipping feature. The content is added onto the page.

Parameters
nodeThe aps root node object.
rectangleThe size of area to add apps node object.
useClippingThe flag determines whether aps fragment is being clipped or not.
Returns

◆ Accept() [7/7]

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Page::Accept ( System::SharedPtr< Aspose::Rendering::ApsNode >  node,
System::Drawing::RectangleF  rectangle,
bool  useClipping,
bool  addContent 
)
protected

Accepts ApsNode aps root node (page, canvas, path, etc) object that needed to add onto the page.

Parameters
nodeThe aps root node object.
rectangleThe size of area to add apps node object.
useClippingThe flag determines whether aps fragment is being clipped or not.
addContentThe flag determines whether aps fragment is being drawed or not.
Returns
The list of operators that aps fragment conatains.

◆ AddImage() [1/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::AddImage ( System::SharedPtr< System::IO::Stream imageStream,
System::SharedPtr< Aspose::Pdf::Rectangle imageRect 
)

Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion.

Parameters
imageStreamThe stream of the image.
imageRectThe position of the image.

◆ AddImage() [2/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::AddImage ( System::String  hocr,
System::SharedPtr< System::IO::Stream imageStream,
System::SharedPtr< Aspose::Pdf::Rectangle imageRect 
)

Adds searchable image onto the page and locates it in the middle of specified rectangle saving image's proportion.

Parameters
hocrThe hocr of the image.
imageStreamThe stream of the image.
imageRectThe position of the image.

◆ AddImage() [3/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::AddImage ( System::SharedPtr< System::IO::Stream imageStream,
System::SharedPtr< Aspose::Pdf::Rectangle imageRect,
int32_t  imageWidth,
int32_t  imageHeight,
bool  saveImageProportions 
)

Adds image on page and places it depend on image rectangle position.

Parameters
imageStreamThe stream of the image.
imageRectThe default position of the image on page.
imageWidthThe width of the image.
imageHeightThe height of the image.
saveImageProportionsIf the flag set to true than image placed in rectangle position; otherwise, the size of rectange is becoming equal to image size.

◆ AddImage() [4/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::AddImage ( System::String  imagePath,
System::SharedPtr< Aspose::Pdf::Rectangle rectangle 
)

Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion.

Parameters
imagePathThe path to image.
rectangleThe position of the image.

◆ AddImage() [5/8]

Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion.

Parameters
streamThe stream of the image.
rectangleThe position of the image.
compositingParametersThe compositing parameters.
Returns
List of operators that add image.

◆ AddImage() [6/8]

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Page::AddImage ( System::SharedPtr< System::IO::Stream stream,
System::SharedPtr< Aspose::Pdf::Rectangle rectangle,
System::SharedPtr< Matrix rotationMatrix,
System::SharedPtr< CompositingParameters compositingParameters,
System::SharedPtr< Engine::Data::IPdfObject > &  pdfObject,
bool  isTagged = false,
int32_t  MCID = 0 
)
protected

Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion.

Parameters
streamThe stream of the image.
rectangleThe position of the image.
rotationMatrixThe rotation matrix.
compositingParametersThe compositing parameters.
pdfObjectReturns the created image pdf object.
Returns
List of operators that add image.

◆ AddImage() [7/8]

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Page::AddImage ( System::SharedPtr< System::IO::Stream stream,
System::SharedPtr< Aspose::Pdf::Rectangle rectangle,
System::SharedPtr< CompositingParameters compositingParameters,
bool  addImage,
bool  isBlackWhite,
System::SharedPtr< System::IO::Stream predefinedStream = nullptr,
bool  isTagged = false,
int32_t  MCID = 0 
)
protected

Adds image onto the page.

Parameters
streamThe stream of the image.
rectangleThe position of the image. If the rectangle is the point image will be added in original size.
compositingParametersThe compositing parameters.
addImageIf true image will be added otherwise not.
isBlackWhiteIf true the image is black and white otherwise not.
Returns
List of operators that add image.

◆ AddImage() [8/8]

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Page::AddImage ( System::SharedPtr< System::IO::Stream stream,
System::SharedPtr< Aspose::Pdf::Rectangle rectangle,
System::SharedPtr< Matrix rotationMatrix,
System::SharedPtr< CompositingParameters compositingParameters,
bool  addImage,
bool  isBlackWhite,
System::SharedPtr< Engine::Data::IPdfObject > &  pdfObject,
System::SharedPtr< System::IO::Stream predefinedStream = nullptr,
bool  isTagged = false,
int32_t  MCID = 0 
)
protected

Adds image onto the page.

Parameters
streamThe stream of the image.
rectangleThe position of the image. If the rectangle is the point image will be added in original size.
rotationMatrixThe rotation matrix.
compositingParametersThe compositing parameters.
addImageIf true image will be added otherwise not.
isBlackWhiteIf true the image is black and white otherwise not.
pdfObjectReturns the created image pdf object.
Returns
List of operators that add image.

◆ AddStamp()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::AddStamp ( System::SharedPtr< Stamp stamp)

Put stamp into page. Stamp can be page number, image or simple text, e.g. some logo.

Parameters
stampStamp to add on the page. Each stamp has its coordinates and corresponding properties regarding to the kind of stamp, i.e. image or text value.

◆ AsByteArray()

ASPOSE_PDF_SHARED_API System::ArrayPtr<uint8_t> Aspose::Pdf::Page::AsByteArray ( System::SharedPtr< Devices::Resolution resolution)

Converts current page as bitmap and than returns array of bytes.

Parameters
resolutionThe resolution.
Returns
Converted array of image bytes.

◆ AsXml()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Page::AsXml ( )

Converts current page as xml in utf8 encoding.

Returns
Converted xml string.

◆ CalculateContentBBox()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::CalculateContentBBox ( )

Calculates bbox value - rectangle containing contents without visible margins.

Returns
Bbox value - rectangle containing contents without visible margins

◆ ClearContents()

void Aspose::Pdf::Page::ClearContents ( )
protected

◆ ConvertToPNGMemoryStream()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::MemoryStream> Aspose::Pdf::Page::ConvertToPNGMemoryStream ( )

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

Returns
Image stream.

◆ DeleteUnusedResources() [1/2]

void Aspose::Pdf::Page::DeleteUnusedResources ( System::SharedPtr< Engine::Data::IPdfDictionary >  resources,
System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t >>  usageTable 
)
protected

◆ DeleteUnusedResources() [2/2]

void Aspose::Pdf::Page::DeleteUnusedResources ( System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t >>  usageTable)
protected

◆ Deserialize()

void Aspose::Pdf::Page::Deserialize ( System::SharedPtr< System::Xml::XmlReader reader)
protected

◆ Dispose()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::Dispose ( )
overridevirtual

Frees up memory

Reimplemented from System::IDisposable.

◆ FillUsedObjectsTable()

void Aspose::Pdf::Page::FillUsedObjectsTable ( System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t >>  usageTable,
System::SharedPtr< Engine::Data::IPdfDictionary >  CommonResources 
)
protected

◆ FindReferences() [1/2]

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<System::Object> > > Aspose::Pdf::Page::FindReferences ( System::String  name)
protected

◆ FindReferences() [2/2]

static System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<System::Object> > > Aspose::Pdf::Page::FindReferences ( System::SharedPtr< OperatorCollection Contents,
System::String  name 
)
staticprotected

Returns list of operators which uses resource with specified name.

Parameters
name
Returns

◆ Flatten()

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

Removes all fields located on the page and place their values instead.

◆ Flatten4()

void Aspose::Pdf::Page::Flatten4 ( bool  doRemoveFiedls)
protected

◆ FreeMemory()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::FreeMemory ( )
overridevirtual

Clears cached data

Implements Aspose::Pdf::ISupportsMemoryCleanup.

◆ get___BadNumber()

int32_t Aspose::Pdf::Page::get___BadNumber ( )
protected

◆ get_Actions()

ASPOSE_PDF_SHARED_API System::SharedPtr<PageActionCollection> Aspose::Pdf::Page::get_Actions ( )

Gets collection of page properties.

◆ get_Annotations()

ASPOSE_PDF_SHARED_API System::SharedPtr<Annotations::AnnotationCollection> Aspose::Pdf::Page::get_Annotations ( )

Gets collection of page annotations. Annotations

◆ get_ArtBox()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::get_ArtBox ( )

Gets art box of the page.

◆ get_Artifacts()

ASPOSE_PDF_SHARED_API System::SharedPtr<ArtifactCollection> Aspose::Pdf::Page::get_Artifacts ( )

Gets collection of artifacts on the page.

◆ get_Background()

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

Gets the background color of the page.

◆ get_BackgroundImage()

ASPOSE_PDF_SHARED_API System::SharedPtr<Image> Aspose::Pdf::Page::get_BackgroundImage ( ) const

Gets background image for page (for generator only).

◆ get_BleedBox()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::get_BleedBox ( )

Gets bleed box of the page.

◆ get_ColorType()

ASPOSE_PDF_SHARED_API Aspose::Pdf::ColorType Aspose::Pdf::Page::get_ColorType ( )

Sets color type of the pages based on information getting from operators SetColor, images and forms.

◆ get_Contents()

ASPOSE_PDF_SHARED_API System::SharedPtr<OperatorCollection> Aspose::Pdf::Page::get_Contents ( )

Gets collection of operators in the content stream of the page. OperatorCollection

◆ get_ContentsAppender()

System::SharedPtr<Aspose::Pdf::ContentsAppender> Aspose::Pdf::Page::get_ContentsAppender ( )
protected

Gets current contents appender. ContentsAppender

◆ get_CropBox()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::get_CropBox ( )

Gets crop box of the page.

◆ get_CurY()

double Aspose::Pdf::Page::get_CurY ( ) const
protected

Gets page current Y coordinate.

◆ get_Duration()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Page::get_Duration ( )

Gets of set page display duration. This is time in seconds that page shall be displayed during presentation. Returs -1 if duration is not defined.

◆ get_FieldsInTabOrder()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Forms::Field> > > Aspose::Pdf::Page::get_FieldsInTabOrder ( )

Gets list of Field object in Tab order on this page.

◆ get_Footer()

ASPOSE_PDF_SHARED_API System::SharedPtr<HeaderFooter> Aspose::Pdf::Page::get_Footer ( ) const

Gets page footer.

The page footer.

◆ get_Group()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Group> Aspose::Pdf::Page::get_Group ( )

Gets a group attributes class specifying the attributes of the page�s page group for use in the transparent imaging model.

◆ get_Header()

ASPOSE_PDF_SHARED_API System::SharedPtr<HeaderFooter> Aspose::Pdf::Page::get_Header ( ) const

Gets page header.

The page header.

◆ get_Id()

System::String Aspose::Pdf::Page::get_Id ( ) const
protected

Gets the page id

The page id.

◆ get_IgnoreAnnotationExceptions()

bool Aspose::Pdf::Page::get_IgnoreAnnotationExceptions ( ) const
protected

Determines should be exceptions ignored during processing of annotations.

◆ get_IsAddParagraphsAfterLast()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Page::get_IsAddParagraphsAfterLast ( ) const

Gets the addition of paragraphs after the last paragraph of the page

Value indicates whether paragraphs will be added after the last paragraph of the page. Paragraphs will be added after the last paragraph of the page if value is true.

◆ get_IsNoteMoreThanPage()

bool Aspose::Pdf::Page::get_IsNoteMoreThanPage ( ) const
protected

◆ get_IsRowExceedPageHeigth()

double Aspose::Pdf::Page::get_IsRowExceedPageHeigth ( ) const
protected

◆ get_IsRowExceedPageMode()

bool Aspose::Pdf::Page::get_IsRowExceedPageMode ( ) const
protected

◆ get_IsTextAddedOnPage()

bool Aspose::Pdf::Page::get_IsTextAddedOnPage ( ) const
protected

Gets whether text is added on page. Value indicates if the text operators on the page have been changed. Need if we use ContentsAppender class to update contents. See PDFNET-47949.

◆ get_Layers()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Layer> > > Aspose::Pdf::Page::get_Layers ( )

Gets layers collection.

The layers collection.

◆ get_MediaBox()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::get_MediaBox ( )

Gets media box of the page.

◆ get_NoteLineStyle()

ASPOSE_PDF_SHARED_API System::SharedPtr<GraphInfo> Aspose::Pdf::Page::get_NoteLineStyle ( ) const

Gets the line style for notes.(for generator only)

The note style.

◆ get_Number()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Page::get_Number ( )

Get number of the page.

◆ get_PageInfo()

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

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

The page info.

◆ get_Pages()

System::SharedPtr<PageCollection> Aspose::Pdf::Page::get_Pages ( ) const
protected

Gets the pages collection.

The pages collection.

◆ get_Paragraphs()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Paragraphs> Aspose::Pdf::Page::get_Paragraphs ( )

Gets the paragraphs.

The paragraphs.

◆ get_Rect()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::get_Rect ( )

Gets rectangle of the page. For get: page crop box is returned if specified, otherwise page media box is returned. For set: page media box always set. Please note that this property don't consider page rotation. To get page rectangle considering rotation please use ActualRect.

◆ get_Rectangle()

System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::get_Rectangle ( )
protected

◆ get_Resources()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Resources> Aspose::Pdf::Page::get_Resources ( )

Gets page resources. Resources object contains collections of images, forms and fonts. Resources

◆ get_Rotate()

ASPOSE_PDF_SHARED_API Rotation Aspose::Pdf::Page::get_Rotate ( )

Gets rotation of the page.

◆ get_RotationMatrix()

ASPOSE_PDF_SHARED_API System::SharedPtr<Matrix> Aspose::Pdf::Page::get_RotationMatrix ( )

Gets transofmation matrix for the page.

◆ get_TabOrder()

ASPOSE_PDF_SHARED_API Aspose::Pdf::TabOrder Aspose::Pdf::Page::get_TabOrder ( )

Gets tab order of the page. Possible values: Row, Column. Default, Manual

◆ get_TocInfo()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::TocInfo> Aspose::Pdf::Page::get_TocInfo ( ) const

Gets table of contents info.

The table of contents info - default null. If it set this page will contain table of contents.

◆ get_TrimBox()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::get_TrimBox ( )

Gets trim box of the page.

◆ get_UserUnit()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Page::get_UserUnit ( )

Gets UserUnit value. A positive number giving the size of default user space units, in multiples of 1 ⁄ 72 inch. Default value is 1. Please set zero or negative value in order to clear this entry in page.

◆ get_Watermark()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Watermark> Aspose::Pdf::Page::get_Watermark ( )

Gets the watermark of the page.

◆ GetNextPage()

static System::SharedPtr<Page> Aspose::Pdf::Page::GetNextPage ( System::SharedPtr< Page page)
staticprotected

Get next page and apply defaults.

◆ GetNotifications()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Page::GetNotifications ( )

Returns notifications about inside operations with page content. (Only notifications about paragraph events in text adding scenarios are supported now.)

Returns
String representing notifications about inside operations with page content.

◆ GetPageRect()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::GetPageRect ( bool  considerRotation)

Returns rectangle of the page.

Parameters
considerRotationIf true then rotation of the page will be considered in rect calculation.
Returns
Rectangle of the page.

◆ GetRect()

System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Page::GetRect ( )
protected

Returns rectanlge of the page according to its CropBox and Media box;

Returns

◆ GetTextRotationStatistic()

System::SharedPtr<System::Collections::Generic::Dictionary<double, int32_t> > Aspose::Pdf::Page::GetTextRotationStatistic ( )
protected

Returns dictionary that contains frequencies for every unique rotation angle of text found.

Returns
Returns dictionary that contains frequencies for every unique rotation angle of text found.

◆ IntToRotation()

static ASPOSE_PDF_SHARED_API Rotation Aspose::Pdf::Page::IntToRotation ( int32_t  rotation)
static

Translates integer value into corresponding rotation enumeration member.

Parameters
rotationInteger value to convert
Returns
Rotation enumeration member

◆ InvalidateAnnotations()

void Aspose::Pdf::Page::InvalidateAnnotations ( )
protected

◆ IsBlank()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Page::IsBlank ( double  fillThresholdFactor)

Gets the flag whether page is blank or not.

Parameters
fillThresholdFactorThe fill threshold value that manages the sensitivity of detection. Should be equal or greater than 0.01.
Returns
True - if page is blank; otherwise, false.

◆ IsUsedOnPage()

bool Aspose::Pdf::Page::IsUsedOnPage ( System::String  name)
protected

◆ MakeGrayscale()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::MakeGrayscale ( )

Converts the page to grayscale.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Page::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( Page  ,
CODEPORTING_ARGS(System::SharedPtr< Engine::CommonData::IPage > page)   
)
protected

◆ PrintBackgroundImage()

static void Aspose::Pdf::Page::PrintBackgroundImage ( System::SharedPtr< Image image,
double  width,
double  height,
double  curX,
double  curY,
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>>  operators,
System::SharedPtr< Page page 
)
staticprotected

◆ ProcessHeaderFooters()

void Aspose::Pdf::Page::ProcessHeaderFooters ( )
protected

Process header and footer.

◆ ProcessPage()

static System::SharedPtr<Page> Aspose::Pdf::Page::ProcessPage ( System::SharedPtr< Page page)
staticprotected

◆ ProcessParagraphs()

void Aspose::Pdf::Page::ProcessParagraphs ( )
protected

Process generator paragraphs.

◆ RegisterObservation()

void Aspose::Pdf::Page::RegisterObservation ( System::String  message)
protected

◆ ReleaseResources()

void Aspose::Pdf::Page::ReleaseResources ( )
protected

◆ RemoveObjectReferences() [1/2]

void Aspose::Pdf::Page::RemoveObjectReferences ( System::String  name)
protected

Remove references to XObject from page contents (i.e. all Do operators which use name of object).

Parameters
name

◆ RemoveObjectReferences() [2/2]

static void Aspose::Pdf::Page::RemoveObjectReferences ( System::SharedPtr< OperatorCollection contents,
System::String  name 
)
staticprotected

◆ RotationToInt()

static ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Page::RotationToInt ( Rotation  rotation)
static

Translates rotation enumeration member into integer value.

Parameters
rotationRotation enumeratioom member.
Returns
Corresponding integer value

◆ SendTo() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::SendTo ( System::SharedPtr< Devices::PageDevice device,
System::SharedPtr< System::IO::Stream output 
)

Sends page to process with given page device.

Parameters
deviceThe device to process page.
outputResult stream which is used with device to save its output.

◆ SendTo() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::SendTo ( System::SharedPtr< Devices::PageDevice device,
System::String  outputFileName 
)

Sends page to process with given page device.

Parameters
deviceThe device to process page.
outputFileNameFile which is used with device to save its output.

◆ Serialize()

void Aspose::Pdf::Page::Serialize ( System::SharedPtr< System::Xml::XmlTextWriter writer)
protected

◆ set_ArtBox()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_ArtBox ( System::SharedPtr< Aspose::Pdf::Rectangle value)

Sets art box of the page.

◆ set_Background()

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

Sets the background color of the page.

◆ set_BackgroundImage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_BackgroundImage ( System::SharedPtr< Image value)

Sets background image for page (for generator only).

◆ set_BleedBox()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_BleedBox ( System::SharedPtr< Aspose::Pdf::Rectangle value)

Sets bleed box of the page.

◆ set_CropBox()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_CropBox ( System::SharedPtr< Aspose::Pdf::Rectangle value)

Sets crop box of the page.

◆ set_CurY()

void Aspose::Pdf::Page::set_CurY ( double  value)
protected

Sets page current Y coordinate.

◆ set_Duration()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Duration ( double  value)

Gets of set page display duration. This is time in seconds that page shall be displayed during presentation. Returs -1 if duration is not defined.

◆ set_Footer()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Footer ( System::SharedPtr< HeaderFooter value)

Sets page footer.

The page footer.

◆ set_Group()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Group ( System::SharedPtr< Aspose::Pdf::Group value)

Sets a group attributes class specifying the attributes of the page�s page group for use in the transparent imaging model.

◆ set_Header()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Header ( System::SharedPtr< HeaderFooter value)

Sets page header.

The page header.

◆ set_Id()

void Aspose::Pdf::Page::set_Id ( System::String  value)
protected

Sets the page id

The page id.

◆ set_IgnoreAnnotationExceptions()

void Aspose::Pdf::Page::set_IgnoreAnnotationExceptions ( bool  value)
protected

Determines should be exceptions ignored during processing of annotations.

◆ set_IsAddParagraphsAfterLast()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_IsAddParagraphsAfterLast ( bool  value)

Sets the addition of paragraphs after the last paragraph of the page

Value indicates whether paragraphs will be added after the last paragraph of the page. Paragraphs will be added after the last paragraph of the page if value is true.

◆ set_IsNoteMoreThanPage()

void Aspose::Pdf::Page::set_IsNoteMoreThanPage ( bool  value)
protected

◆ set_IsRowExceedPageHeigth()

void Aspose::Pdf::Page::set_IsRowExceedPageHeigth ( double  value)
protected

◆ set_IsRowExceedPageMode()

void Aspose::Pdf::Page::set_IsRowExceedPageMode ( bool  value)
protected

◆ set_IsTextAddedOnPage()

void Aspose::Pdf::Page::set_IsTextAddedOnPage ( bool  value)
protected

Sets whether text is added on page. Value indicates if the text operators on the page have been changed. Need if we use ContentsAppender class to update contents. See PDFNET-47949.

◆ set_Layers()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Layers ( System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Layer >>>  value)

Sets layers collection.

The layers collection.

◆ set_MediaBox()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_MediaBox ( System::SharedPtr< Aspose::Pdf::Rectangle value)

Sets media box of the page.

◆ set_NoteLineStyle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_NoteLineStyle ( System::SharedPtr< GraphInfo value)

Sets the line style for notes.(for generator only)

The note style.

◆ set_PageInfo()

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

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

The page info.

◆ set_Pages()

void Aspose::Pdf::Page::set_Pages ( System::SharedPtr< PageCollection value)
protected

Gets the pages collection.

The pages collection.

◆ set_Paragraphs()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Paragraphs ( System::SharedPtr< Aspose::Pdf::Paragraphs value)

Gets the paragraphs.

The paragraphs.

◆ set_Rect()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Rect ( System::SharedPtr< Aspose::Pdf::Rectangle value)

Sets rectangle of the page. For get: page crop box is returned if specified, otherwise page media box is returned. For set: page media box always set. Please note that this property don't consider page rotation. To get page rectangle considering rotation please use ActualRect.

◆ set_Rotate()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Rotate ( Rotation  value)

Sets rotation of the page.

◆ set_TabOrder()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_TabOrder ( Aspose::Pdf::TabOrder  value)

Sets tab order of the page. Possible values: Row, Column. Default, Manual

◆ set_TocInfo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_TocInfo ( System::SharedPtr< Aspose::Pdf::TocInfo value)

Sets table of contents info.

The table of contents info - default null. If it set this page will contain table of contents.

◆ set_TrimBox()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_TrimBox ( System::SharedPtr< Aspose::Pdf::Rectangle value)

Sets trim box of the page.

◆ set_UserUnit()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_UserUnit ( double  value)

Sets UserUnit value. A positive number giving the size of default user space units, in multiples of 1 ⁄ 72 inch. Default value is 1. Please set zero or negative value in order to clear this entry in page.

◆ set_Watermark()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::set_Watermark ( System::SharedPtr< Aspose::Pdf::Watermark value)

Sets the watermark of the page.

◆ SetPageInfo()

void Aspose::Pdf::Page::SetPageInfo ( )
protected

◆ SetPageSize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Page::SetPageSize ( double  width,
double  height 
)

Sets page size for page.

Parameters
widthPage width.
heightPage size.

◆ SetTransition()

void Aspose::Pdf::Page::SetTransition ( System::SharedPtr< Engine::Data::IPdfDictionary >  transition)
protected

Parameters
transition

◆ UpdateContents()

void Aspose::Pdf::Page::UpdateContents ( )
protected

◆ UpdateResources()

void Aspose::Pdf::Page::UpdateResources ( )
protected

Updates the resources.

Member Data Documentation

◆ _document

System::WeakPtr<Document> Aspose::Pdf::Page::_document
protected

◆ detached

bool Aspose::Pdf::Page::detached
protected

◆ EnginePage

System::SharedPtr<Engine::CommonData::IPage> Aspose::Pdf::Page::EnginePage
protected

◆ OnBeforePageGenerate

System::Event<void(System::SharedPtr<Page>)> Aspose::Pdf::Page::OnBeforePageGenerate

Event for customize header and footer.