Aspose::Pdf::ImagePlacementAbsorber Class Referencefinal

Represents an absorber object of image placement objects. Performs search of image usages and provides access to search results via ImagePlacementAbsorber::ImagePlacements collection. More...

Inherits System::Object.

Public Member Functions

bool get_IsReadOnlyMode ()
 Gets/sets read only mode for parsing operations collection. It may help against out of memory exceptions. More...
 
void set_IsReadOnlyMode (bool value)
 Gets/sets read only mode for parsing operations collection. It may help against out of memory exceptions. More...
 
System::SharedPtr< ImagePlacementCollectionget_ImagePlacements ()
 Gets collection of image placement occurrences that are presented with ImagePlacement objects. More...
 
 ImagePlacementAbsorber ()
 Initializes new instance of the ImagePlacementAbsorber object. More...
 
void Visit (System::SharedPtr< Page > page)
 Performs search on the specified page. More...
 
void Visit (System::SharedPtr< Document > pdf)
 Performs search on the specified document. 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Represents an absorber object of image placement objects. Performs search of image usages and provides access to search results via ImagePlacementAbsorber::ImagePlacements collection.

The ImagePlacementAbsorber object is basically used in images search scenario. When the search is completed the occurrences are represented with ImagePlacement objects that the ImagePlacementAbsorber::ImagePlacements collection contains. The ImagePlacement object provides access to the image placement properties: dimensions, resolution etc.

The example demonstrates how to find images on the first PDF document page and get the image placement properties.

// Open document
Document doc = new Document(@"D:\Tests\input.pdf");
// Create ImagePlacementAbsorber object to perform image placement search
// Accept the absorber for first page
doc.Pages[1].Accept(abs);
// Display image placement properties for all placements
foreach (ImagePlacement imagePlacement in abs.ImagePlacements)
{
Console.Out.WriteLine("image width:" + imagePlacement.Rectangle.Width);
Console.Out.WriteLine("image height:" + imagePlacement.Rectangle.Height);
Console.Out.WriteLine("image LLX:" + imagePlacement.Rectangle.LLX);
Console.Out.WriteLine("image LLY:" + imagePlacement.Rectangle.LLY);
Console.Out.WriteLine("image horizontal resolution:" + imagePlacement.Resolution.X);
Console.Out.WriteLine("image vertical resolution:" + imagePlacement.Resolution.Y);
}

Constructor & Destructor Documentation

◆ ImagePlacementAbsorber()

Aspose::Pdf::ImagePlacementAbsorber::ImagePlacementAbsorber ( )

Initializes new instance of the ImagePlacementAbsorber object.

Member Function Documentation

◆ get_ImagePlacements()

System::SharedPtr<ImagePlacementCollection> Aspose::Pdf::ImagePlacementAbsorber::get_ImagePlacements ( )

Gets collection of image placement occurrences that are presented with ImagePlacement objects.

◆ get_IsReadOnlyMode()

bool Aspose::Pdf::ImagePlacementAbsorber::get_IsReadOnlyMode ( )

Gets/sets read only mode for parsing operations collection. It may help against out of memory exceptions.

◆ set_IsReadOnlyMode()

void Aspose::Pdf::ImagePlacementAbsorber::set_IsReadOnlyMode ( bool  value)

Gets/sets read only mode for parsing operations collection. It may help against out of memory exceptions.

◆ Visit() [1/2]

void Aspose::Pdf::ImagePlacementAbsorber::Visit ( System::SharedPtr< Page page)

Performs search on the specified page.

Parameters
pagePdf pocument page object.

◆ Visit() [2/2]

void Aspose::Pdf::ImagePlacementAbsorber::Visit ( System::SharedPtr< Document pdf)

Performs search on the specified document.

Parameters
pdfPdf pocument object.