Class representing XImage collection. More...

#include "XImageCollection.h"

Inherits System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XImage > >.

Classes
class	ThresholdMaskParameters

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_Count () const override

Count of images in collection. More...

ASPOSE_PDF_SHARED_API bool get_IsSynchronized ()

Returns true if object is synchronized. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Object > get_SyncRoot () const

Returns synchronization object. More...

ASPOSE_PDF_SHARED_API System::ArrayPtr< System::String > get_Names ()

Gets array of image names. More...

ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override

Gets a value indicating whether the collection is read-only. More...

ASPOSE_PDF_SHARED_API System::String AddWithName (System::SharedPtr< Aspose::Pdf::XImage > image)

Adds new image to Image list. This method adds image as reference to the same PdfObject (which allows to decrease file size) More...

ASPOSE_PDF_SHARED_API System::String Add (System::SharedPtr< System::IO::Stream > image)

Adds entity to the end of the collection, so entity can be accessed by the last index. More...

ASPOSE_PDF_SHARED_API System::String Add (System::SharedPtr< System::IO::Stream > image, Aspose::Pdf::ImageFilterType filterType)

Adds entity to the end of the collection, so entity can be accessed by the last index. More...

ASPOSE_PDF_SHARED_API void Add (System::SharedPtr< System::IO::Stream > image, int32_t quality)

Adds entity to the end of the collection, so entity can be accessed by the last index. More...

ASPOSE_PDF_SHARED_API void Delete (int32_t index)

Removes index from collection by index. More...

ASPOSE_PDF_SHARED_API void Delete (int32_t index, Aspose::Pdf::ImageDeleteAction action)

Removes image from collection by index performing action specified by action parameter. More...

ASPOSE_PDF_SHARED_API void Delete (System::String name)

Removes item from collection by name. More...

ASPOSE_PDF_SHARED_API void Delete (System::String name, Aspose::Pdf::ImageDeleteAction action)

Removes item from collection by name. More...

ASPOSE_PDF_SHARED_API void Delete ()

Deletes images from collection. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Pdf::XImage > > > GetEnumerator () override

Returns collection enumerator. More...

ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::XImage >> array, int32_t index) override

Copies array of images into collection. More...

ASPOSE_PDF_SHARED_API void Replace (int32_t index, System::SharedPtr< System::IO::Stream > stream)

Replace image in collection with another image. More...

ASPOSE_PDF_SHARED_API void Replace (int32_t index, System::SharedPtr< System::IO::Stream > stream, int32_t quality, bool isBlackAndWhite)

Replace image in collection with another image. More...

ASPOSE_PDF_SHARED_API void Replace (int32_t index, System::SharedPtr< System::IO::Stream > stream, int32_t quality)

Replace image in collection with another image. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::XImage > idx_get (int32_t index)

Gets image from collection by its index. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::XImage > idx_get (System::String name)

Gets image from collection by its name. More...

ASPOSE_PDF_SHARED_API System::String GetImageName (System::SharedPtr< Aspose::Pdf::XImage > image)

Returns name in images list which is key of the given image. More...

ASPOSE_PDF_SHARED_API void Clear () override

Clears all items from the collection. More...

ASPOSE_PDF_SHARED_API bool Contains (const System::SharedPtr< Aspose::Pdf::XImage > &item) const override

Determines whether the collection contains a specific value. More...

ASPOSE_PDF_SHARED_API bool Remove (const System::SharedPtr< Aspose::Pdf::XImage > &item) override

Removes item from collection, throws

Exceptions

NotImplementedException NotImplementedException

. More...

Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XImage > >

virtual void Add (const System::SharedPtr< Aspose::Pdf::XImage > &item)=0

Adds element into collection. More...

virtual bool Contains (const System::SharedPtr< Aspose::Pdf::XImage > &item) const=0

Checks if element is present in collection. More...

virtual bool Remove (const System::SharedPtr< Aspose::Pdf::XImage > &item)=0

Deletes element from collection. More...

virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::XImage > > array, int arrayIndex)=0

Copies all collection elements to existing array elements. More...

ICollection & operator= (ICollection &&) noexcept

Move assignment operator. More...

ICollection & operator= (const ICollection &)

Move assignment operator. More...

ICollection ()

Default constructor. More...

ICollection (const ICollection &)

Copy constructor. More...

ICollection (ICollection &&) noexcept

Move constructor. More...

virtual ~ICollection ()

Destructor. More...

SharedPtr< Object > get_SyncRoot () const

Gets the object the collection is being synchronized through. More...

Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > >

System::SharedPtr< Aspose::Pdf::XImage > LINQ_ElementAt (int index)

Returns the element at a specified index in a sequence. More...

System::SharedPtr< Aspose::Pdf::XImage > LINQ_First ()

Returns the first element of a sequence. More...

System::SharedPtr< Aspose::Pdf::XImage > LINQ_First (const Func< System::SharedPtr< Aspose::Pdf::XImage >, bool > &predicate)

Returns the first element of a sequence that satisfy the specified condition. More...

System::SharedPtr< Aspose::Pdf::XImage > LINQ_FirstOrDefault ()

Returns the first element of a sequence, or a default value if the sequence is empty. More...

System::SharedPtr< Aspose::Pdf::XImage > LINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::XImage >)> predicate)

Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...

System::SharedPtr< Aspose::Pdf::XImage > LINQ_Last ()

Returns the last element of a sequence. More...

System::SharedPtr< Aspose::Pdf::XImage > LINQ_LastOrDefault ()

Returns the last element of a sequence, or a default value if the sequence is empty. More...

SharedPtr< List< System::SharedPtr< Aspose::Pdf::XImage > > > LINQ_ToList ()

Creates a List<T> from a sequence. More...

int LINQ_Count ()

Returns the number of elements in the sequence (calculated via direct counting). More...

int LINQ_Count (const Func< System::SharedPtr< Aspose::Pdf::XImage >, bool > &predicate)

Returns the number of elements in the sequence that satisfy the specified condition. More...

System::ArrayPtr< System::SharedPtr< Aspose::Pdf::XImage > > LINQ_ToArray ()

Creates an array from a sequence. More...

bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::XImage >)> predicate)

Determines whether all elements of a sequence satisfy a condition. More...

bool LINQ_Any ()

Determines whether a sequence contains any elements. More...

bool LINQ_Any (std::function< bool(System::SharedPtr< Aspose::Pdf::XImage >)> predicate)

Determines whether any element of a sequence exists or satisfies a condition. More...

SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::XImage >)> predicate)

Filters a sequence based on the specified predicate. More...

bool LINQ_Contains (System::SharedPtr< Aspose::Pdf::XImage > value)

Determines if a sequence contains a specified value. More...

SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()

Casts the elements to the specified type. More...

SharedPtr< IEnumerable< Result > > LINQ_Cast ()

SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > > > LINQ_OrderBy (const Func< System::SharedPtr< Aspose::Pdf::XImage >, Key > &keySelector)

Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...

SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)

SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > > > LINQ_OrderByDescending (const Func< System::SharedPtr< Aspose::Pdf::XImage >, Key > &keySelector)

Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...

SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)

SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()

Filters the elements of the sequence based on the specified type. More...

SharedPtr< IEnumerable< Result > > LINQ_OfType ()

SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::XImage >, ResultType > &selector)

Transforms elements of a sequence. More...

SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::XImage >, int32_t, ResultType > &selector)

Transforms each element of a sequence into a new form by incorporating the element's index. More...

SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)

SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)

SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > > > LINQ_Concat (SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > >> sequence)

Concatenates two sequences. More...

System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, System::SharedPtr< Aspose::Pdf::XImage > > > > > LINQ_GroupBy (System::Func< System::SharedPtr< Aspose::Pdf::XImage >, Key > keyPredicate)

Groups the elements of a sequence. More...

SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)

SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< System::SharedPtr< Aspose::Pdf::XImage >, SharedPtr< IEnumerable< ResultType >>> &selector)

Projects each element of a sequence and combines the resulting sequences into one sequence. More...

SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)

iterator begin ()

Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...

const_iterator begin () const

Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...

iterator end ()

Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...

const_iterator end () const

Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...

const_iterator cbegin () const

Gets iterator pointing to the first const-qualified element (if any) of the collection. More...

const_iterator cend () const

Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...

virtual virtualized_iterator * virtualizeBeginIterator ()

Gets the implementation of begin iterator for the current container. More...

virtual virtualized_iterator * virtualizeEndIterator ()

Gets the implementation of end iterator for the current container. More...

virtual virtualized_iterator * virtualizeBeginConstIterator () const

Gets the implementation of begin const iterator for the current container. More...

virtual virtualized_iterator * virtualizeEndConstIterator () const

Gets the implementation of end const iterator for the current container. 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...

Protected Member Functions
System::SharedPtr< Aspose::Pdf::Resources >	get_Parent () const

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream >	MakeImageFromStream (System::SharedPtr< System::IO::Stream > stream, int32_t quality, System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > trailerable)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream >	MakeImageFromStream (System::SharedPtr< System::IO::Stream > stream, int32_t quality)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream >	MakeMonochromeImage (System::SharedPtr< System::Drawing::Bitmap > image)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	AddGifMaskedImage (System::SharedPtr< System::IO::Stream > stream, int32_t quality)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	AddOrReplace (int32_t index, System::SharedPtr< System::IO::Stream > stream, int32_t quality, bool isBlackWhite, Aspose::Pdf::ImageFilterType filterType, uint8_t bitMask, bool isMasked)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	add (System::SharedPtr< System::IO::Stream > stream, bool isBlackWhite)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	add (System::SharedPtr< System::IO::Stream > stream, bool isBlackWhite, System::String &name)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	add (System::SharedPtr< System::IO::Stream > stream, int32_t quality, bool isBlackWhite)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	add (System::SharedPtr< System::IO::Stream > stream, int32_t quality, bool isBlackWhite, System::String &name)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	add (System::SharedPtr< System::IO::Stream > stream, int32_t quality, bool isBlackWhite, Aspose::Pdf::ImageFilterType filterType, bool isMasked, System::SharedPtr< System::IO::Stream > predefinedStream=nullptr)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	add (System::SharedPtr< System::IO::Stream > stream, int32_t quality, bool isBlackWhite, Aspose::Pdf::ImageFilterType filterType, bool isMasked, System::String &name, System::SharedPtr< System::IO::Stream > predefinedStream=nullptr)

bool	ContainsName (System::String imageName)
	Determines if collection contains image with specified name More...

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	DeleteByIndex (int32_t index)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	DeleteBySize (int32_t index)
	Returns ObjectID of deleted image. More...

	XImageCollection (System::SharedPtr< Aspose::Pdf::Resources > parent, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > xobject)

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XImageCollection, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Resources > parent, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > xobject))

void	Add (System::String name, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > image)

System::String	Add (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > image)

bool	HasImage (System::String imgName)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	DeleteBySizeAndIndex (System::SharedPtr< Aspose::Pdf::XImage > image)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	DeleteBySize (System::SharedPtr< Aspose::Pdf::XImage > image)

virtual ASPOSE_PDF_SHARED_API	~XImageCollection ()

Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > >
	~IEnumerable () override
	Destructor. More...

virtualized_iterator *	GetEnumeratorAsVirtualizedIterator ()
	Gets enumerator instance and prepares it to be used as iterator kernel. More...

virtualized_iterator *	GetEnumeratorAsVirtualizedIterator () const
	Gets enumerator instance and prepares it to be used as iterator kernel. More...

Static Protected Member Functions
static System::SharedPtr< System::Drawing::Imaging::ImageCodecInfo >	GetEncoder (System::SharedPtr< System::Drawing::Imaging::ImageFormat > format)

static System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream >	_MakeImageFromStream (System::SharedPtr< System::IO::Stream > stream, int32_t quality, System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > parent)

static System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream >	MakeMonochromeImage (System::SharedPtr< System::Drawing::Bitmap > image, System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > trailerable)

static bool	AddCCITTFaxDecodeImageMask (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > p, System::SharedPtr< Aspose::Pdf::XImageCollection::ThresholdMaskParameters > thresholdMaskParameters, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream > img)

static System::SharedPtr< System::IO::Stream >	IsMetafile (System::SharedPtr< System::IO::Stream > stream)
	Determines whether emf format is used. More...

Additional Inherited Members
Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XImage > >
typedef System::SharedPtr< Aspose::Pdf::XImage >	ValueType
	Value type name. More...

typedef ICollection< System::SharedPtr< Aspose::Pdf::XImage > >	ThisType
	Collection type name. More...

Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::XImage > >	IEnumeratorType
	Enumerator type. More...

using	ValueType = System::SharedPtr< Aspose::Pdf::XImage >

using	iterator = System::Details::VirtualizedIterator< System::SharedPtr< Aspose::Pdf::XImage > >
	Iterator type. More...

using	const_iterator = System::Details::VirtualizedConstIterator< System::SharedPtr< Aspose::Pdf::XImage > >
	Const iterator type. More...

using	virtualized_iterator = System::Details::VirtualizedIteratorBase< System::SharedPtr< Aspose::Pdf::XImage > >
	Inner iterator base type. More...

using	virtualized_iterator_element = System::SharedPtr< Aspose::Pdf::XImage >
	Inner iterator element type. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. 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...

Detailed Description

Class representing XImage collection.

Constructor & Destructor Documentation

◆ XImageCollection()

Aspose::Pdf::XImageCollection::XImageCollection	(	System::SharedPtr< Aspose::Pdf::Resources >	parent,
		System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >	xobject
	)

protected

◆ ~XImageCollection()

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

protectedvirtual

Member Function Documentation

◆ _MakeImageFromStream()

static System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDataStream> Aspose::Pdf::XImageCollection::_MakeImageFromStream	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >	parent
	)

staticprotected

◆ Add() [1/5]

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XImageCollection::Add ( System::SharedPtr< System::IO::Stream > image )

Adds entity to the end of the collection, so entity can be accessed by the last index.

Parameters

image Stream containing image data (in JPEG format).

Returns: Name of the added image.

◆ Add() [2/5]

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XImageCollection::Add	(	System::SharedPtr< System::IO::Stream >	image,
		Aspose::Pdf::ImageFilterType	filterType
	)

Adds entity to the end of the collection, so entity can be accessed by the last index.

Parameters

image	Stream containing image data.
filterType	The image filter type.

Returns: Name of the added image.

◆ Add() [3/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Add	(	System::SharedPtr< System::IO::Stream >	image,
		int32_t	quality
	)

Adds entity to the end of the collection, so entity can be accessed by the last index.

Parameters

image	Stream containing image data (in JPEG format).
quality	JPEG quality.

◆ add() [1/6]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::add	(	System::SharedPtr< System::IO::Stream >	stream,
		bool	isBlackWhite
	)

protected

◆ add() [2/6]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::add	(	System::SharedPtr< System::IO::Stream >	stream,
		bool	isBlackWhite,
		System::String &	name
	)

protected

◆ add() [3/6]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::add	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		bool	isBlackWhite
	)

protected

◆ add() [4/6]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::add	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		bool	isBlackWhite,
		System::String &	name
	)

protected

◆ add() [5/6]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::add	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		bool	isBlackWhite,
		Aspose::Pdf::ImageFilterType	filterType,
		bool	isMasked,
		System::SharedPtr< System::IO::Stream >	predefinedStream = `nullptr`
	)

protected

◆ add() [6/6]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::add	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		bool	isBlackWhite,
		Aspose::Pdf::ImageFilterType	filterType,
		bool	isMasked,
		System::String &	name,
		System::SharedPtr< System::IO::Stream >	predefinedStream = `nullptr`
	)

protected

◆ Add() [4/5]

void Aspose::Pdf::XImageCollection::Add	(	System::String	name,
		System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	image
	)

protected

◆ Add() [5/5]

System::String Aspose::Pdf::XImageCollection::Add ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > image )

protected

◆ AddCCITTFaxDecodeImageMask()

static bool Aspose::Pdf::XImageCollection::AddCCITTFaxDecodeImageMask	(	System::SharedPtr< System::IO::Stream >	stream,
		System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >	p,
		System::SharedPtr< Aspose::Pdf::XImageCollection::ThresholdMaskParameters >	thresholdMaskParameters,
		System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream >	img
	)

staticprotected

◆ AddGifMaskedImage()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::AddGifMaskedImage	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality
	)

protected

◆ AddOrReplace()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::AddOrReplace	(	int32_t	index,
		System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		bool	isBlackWhite,
		Aspose::Pdf::ImageFilterType	filterType,
		uint8_t	bitMask,
		bool	isMasked
	)

protected

◆ AddWithName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XImageCollection::AddWithName ( System::SharedPtr< Aspose::Pdf::XImage > image )

Adds new image to Image list. This method adds image as reference to the same PdfObject (which allows to decrease file size)

Parameters

image XImage to be added.

Returns: Name of the added image.

◆ Clear()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Clear ( )

overridevirtual

Clears all items from the collection.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XImage > >.

◆ Contains()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XImageCollection::Contains ( const System::SharedPtr< Aspose::Pdf::XImage > & item ) const

override

Determines whether the collection contains a specific value.

Parameters

item	The object to locate in the collection.

Returns: true if item is found in the collection; otherwise, false.

◆ ContainsName()

bool Aspose::Pdf::XImageCollection::ContainsName ( System::String imageName )

protected

Determines if collection contains image with specified name

Parameters

imageName Image name to check

Returns: True if collection contains image with specified name, otherwise false

◆ CopyTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::CopyTo	(	System::ArrayPtr< System::SharedPtr< Aspose::Pdf::XImage >>	array,
		int32_t	index
	)

override

Copies array of images into collection.

Parameters

array	Array to be copied.
index	Index where images will be copied into collection.

◆ Delete() [1/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Delete ( int32_t index )

Removes index from collection by index.

Parameters

index Image index.

◆ Delete() [2/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Delete	(	int32_t	index,
		Aspose::Pdf::ImageDeleteAction	action
	)

Removes image from collection by index performing action specified by action parameter.

Parameters

index	Index of the image to be removed.
action	Action perfromed after image deleting.

◆ Delete() [3/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Delete ( System::String name )

Removes item from collection by name.

Parameters

name	Name of image which must to be deleted.

◆ Delete() [4/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Delete	(	System::String	name,
		Aspose::Pdf::ImageDeleteAction	action
	)

Removes item from collection by name.

Parameters

name	Name of image which must to be deleted.
action	Action to be performed with image object.

◆ Delete() [5/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Delete ( )

Deletes images from collection.

◆ DeleteByIndex()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::DeleteByIndex ( int32_t index )

protected

◆ DeleteBySize() [1/2]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::DeleteBySize ( int32_t index )

protected

Returns ObjectID of deleted image.

Parameters

index

Returns

◆ DeleteBySize() [2/2]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::DeleteBySize ( System::SharedPtr< Aspose::Pdf::XImage > image )

protected

◆ DeleteBySizeAndIndex()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::XImageCollection::DeleteBySizeAndIndex ( System::SharedPtr< Aspose::Pdf::XImage > image )

protected

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::XImageCollection::get_Count ( ) const

overridevirtual

Count of images in collection.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XImage > >.

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XImageCollection::get_IsReadOnly ( ) const

overridevirtual

Gets a value indicating whether the collection is read-only.

Reimplemented from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XImage > >.

◆ get_IsSynchronized()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XImageCollection::get_IsSynchronized ( )

Returns true if object is synchronized.

◆ get_Names()

ASPOSE_PDF_SHARED_API System::ArrayPtr<System::String> Aspose::Pdf::XImageCollection::get_Names ( )

Gets array of image names.

◆ get_Parent()

System::SharedPtr<Aspose::Pdf::Resources> Aspose::Pdf::XImageCollection::get_Parent ( ) const

protected

◆ get_SyncRoot()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::XImageCollection::get_SyncRoot ( ) const

Returns synchronization object.

◆ GetEncoder()

static System::SharedPtr<System::Drawing::Imaging::ImageCodecInfo> Aspose::Pdf::XImageCollection::GetEncoder ( System::SharedPtr< System::Drawing::Imaging::ImageFormat > format )

staticprotected

◆ GetEnumerator()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Pdf::XImage> > > Aspose::Pdf::XImageCollection::GetEnumerator ( )

overridevirtual

Returns collection enumerator.

Returns: Enumerator of collection

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::XImage > >.

◆ GetImageName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XImageCollection::GetImageName ( System::SharedPtr< Aspose::Pdf::XImage > image )

Returns name in images list which is key of the given image.

Parameters

image Image to search.

Returns: Name (key) of the found image; null if images was not found.

◆ HasImage()

bool Aspose::Pdf::XImageCollection::HasImage ( System::String imgName )

protected

◆ idx_get() [1/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::XImage> Aspose::Pdf::XImageCollection::idx_get ( int32_t index )

Gets image from collection by its index.

Parameters

index Image index

Returns: Retrieved image.

◆ idx_get() [2/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::XImage> Aspose::Pdf::XImageCollection::idx_get ( System::String name )

Gets image from collection by its name.

Parameters

name	Image name.

Returns: Retrieved image.

◆ IsMetafile()

static System::SharedPtr<System::IO::Stream> Aspose::Pdf::XImageCollection::IsMetafile ( System::SharedPtr< System::IO::Stream > stream )

staticprotected

Determines whether emf format is used.

Parameters

stream Input stream with image.

Returns: Is emf format is detected than jpeg stream returned; otherwise, input stream.

◆ MakeImageFromStream() [1/2]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDataStream> Aspose::Pdf::XImageCollection::MakeImageFromStream	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >	trailerable
	)

protected

◆ MakeImageFromStream() [2/2]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDataStream> Aspose::Pdf::XImageCollection::MakeImageFromStream	(	System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality
	)

protected

◆ MakeMonochromeImage() [1/2]

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDataStream> Aspose::Pdf::XImageCollection::MakeMonochromeImage ( System::SharedPtr< System::Drawing::Bitmap > image )

protected

◆ MakeMonochromeImage() [2/2]

static System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDataStream> Aspose::Pdf::XImageCollection::MakeMonochromeImage	(	System::SharedPtr< System::Drawing::Bitmap >	image,
		System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >	trailerable
	)

staticprotected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::XImageCollection::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	XImageCollection	,
		CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Resources > parent, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > xobject)
	)

protected

◆ Remove()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XImageCollection::Remove ( const System::SharedPtr< Aspose::Pdf::XImage > & item )

override

Removes item from collection, throws

Exceptions

NotImplementedException NotImplementedException

.

Parameters

item	Item to remove.

Returns

Exceptions

NotImplementedException NotImplementedException

◆ Replace() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Replace	(	int32_t	index,
		System::SharedPtr< System::IO::Stream >	stream
	)

Replace image in collection with another image.

Parameters

index	Index of collection item which will be replaced.
stream	Stream containing image data (in JPEG format).

◆ Replace() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Replace	(	int32_t	index,
		System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality,
		bool	isBlackAndWhite
	)

Replace image in collection with another image.

Parameters

index	Index of collection item which will be replaced.
stream	Stream containing image data (in JPEG format).
quality	Quality of JPEG compression, in percent (valid vaues are 0..100).
isBlackAndWhite	If true, image is compressed with CCITT compression method which provides better compression for black nad white image. May be used only for black and white images.

◆ Replace() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XImageCollection::Replace	(	int32_t	index,
		System::SharedPtr< System::IO::Stream >	stream,
		int32_t	quality
	)

Replace image in collection with another image.

Parameters

index	Index of collection item which will be replaced.
stream	Stream containing image data (in JPEG format).
quality	JPEG quality.

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XImageCollection()

◆ ~XImageCollection()

Member Function Documentation

◆ _MakeImageFromStream()

◆ Add() [1/5]

◆ Add() [2/5]

◆ Add() [3/5]

◆ add() [1/6]

◆ add() [2/6]

◆ add() [3/6]

◆ add() [4/6]

◆ add() [5/6]

◆ add() [6/6]

◆ Add() [4/5]

◆ Add() [5/5]

◆ AddCCITTFaxDecodeImageMask()

◆ AddGifMaskedImage()

◆ AddOrReplace()

◆ AddWithName()

◆ Clear()

◆ Contains()

◆ ContainsName()

◆ CopyTo()

◆ Delete() [1/5]

◆ Delete() [2/5]

◆ Delete() [3/5]

◆ Delete() [4/5]

◆ Delete() [5/5]

◆ DeleteByIndex()

◆ DeleteBySize() [1/2]

◆ DeleteBySize() [2/2]

◆ DeleteBySizeAndIndex()

◆ get_Count()

◆ get_IsReadOnly()

◆ get_IsSynchronized()

◆ get_Names()

◆ get_Parent()

◆ get_SyncRoot()

◆ GetEncoder()

◆ GetEnumerator()

◆ GetImageName()

◆ HasImage()

◆ idx_get() [1/2]

◆ idx_get() [2/2]

◆ IsMetafile()

◆ MakeImageFromStream() [1/2]

◆ MakeImageFromStream() [2/2]

◆ MakeMonochromeImage() [1/2]

◆ MakeMonochromeImage() [2/2]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

◆ Remove()

◆ Replace() [1/3]

◆ Replace() [2/3]

◆ Replace() [3/3]