Represents a layer within a PDF page. More...

#include "Layer.h"

Public Member Functions
ASPOSE_PDF_SHARED_API System::String	get_Name () const
	Gets the layer name. More...

ASPOSE_PDF_SHARED_API System::String	get_Id () const
	Gets the layer id. More...

ASPOSE_PDF_SHARED_API const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > &	get_Contents () const
	Gets the layer content. More...

ASPOSE_PDF_SHARED_API bool	get_Locked ()
	Gets a value indicating whether the layer is locked. More...

ASPOSE_PDF_SHARED_API	Layer (System::String id, System::String name)
	Initializes a new instance of the Layer class. More...

ASPOSE_PDF_SHARED_API void	Save (System::String outputPath)
	Saves the current layer to a PDF document. More...

ASPOSE_PDF_SHARED_API void	Flatten (bool cleanupContentStream)
	Flattens the specified layer. More...

ASPOSE_PDF_SHARED_API void	Lock ()
	Locks the layer. More...

ASPOSE_PDF_SHARED_API void	Unlock ()
	Unlocks the layer. More...

ASPOSE_PDF_SHARED_API void	Delete ()
	Deletes the current layer from the PDF 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...

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
int32_t	get_NumberOfChunks () const
	Gets the number of optional content (OC) chunks contained within the PDF layer. More...

void	set_NumberOfChunks (int32_t value)
	Sets the number of optional content (OC) chunks contained within the PDF layer. More...

int32_t	get_Position () const
	Gets the layer position in content stream. More...

void	set_Position (int32_t value)
	Gets the layer position in content stream. More...

bool	get_ParsedFromContent () const
	Gets a value indicating whether the layer was parsed from the content stream of the PDF document. More...

void	set_ParsedFromContent (bool value)
	Sets a value indicating whether the layer was parsed from the content stream of the PDF document. More...

System::SharedPtr< Aspose::Pdf::Page >	get_Page () const
	Gets the page. More...

void	set_Page (System::SharedPtr< Aspose::Pdf::Page > value)
	Sets the page. More...

const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > &	get_PageContents () const
	Gets the modified page content after performing layer extraction or removal. More...

void	set_OptionalContentProperty (System::SharedPtr< Engine::Data::IPdfPrimitive > value)
	Sets the optional content property object. More...

void	CleanupOptionalContentResources ()
	Cleans up optional content properties from the page and document. More...

virtual ASPOSE_PDF_SHARED_API	~Layer ()

Additional Inherited Members
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

Represents a layer within a PDF page.

Constructor & Destructor Documentation

◆ Layer()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Layer::Layer	(	System::String	id,
		System::String	name
	)

Initializes a new instance of the Layer class.

Parameters

id	The layer id
name	The layer name

◆ ~Layer()

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

protectedvirtual

Member Function Documentation

◆ CleanupOptionalContentResources()

void Aspose::Pdf::Layer::CleanupOptionalContentResources ( )

protected

Cleans up optional content properties from the page and document.

◆ Delete()

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

Deletes the current layer from the PDF document.

◆ Flatten()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Layer::Flatten ( bool cleanupContentStream )

Flattens the specified layer.

Parameters

cleanupContentStream Specifies whether to remove optional content group markers from the content stream.

Setting the cleanupContentStream parameter to false speeds up the process of flattening.

◆ get_Contents()

ASPOSE_PDF_SHARED_API const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > >& Aspose::Pdf::Layer::get_Contents ( ) const

Gets the layer content.

◆ get_Id()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Layer::get_Id ( ) const

Gets the layer id.

◆ get_Locked()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Layer::get_Locked ( )

Gets a value indicating whether the layer is locked.

◆ get_Name()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Layer::get_Name ( ) const

Gets the layer name.

◆ get_NumberOfChunks()

int32_t Aspose::Pdf::Layer::get_NumberOfChunks ( ) const

protected

Gets the number of optional content (OC) chunks contained within the PDF layer.

◆ get_Page()

System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::Layer::get_Page ( ) const

protected

Gets the page.

◆ get_PageContents()

const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > >& Aspose::Pdf::Layer::get_PageContents ( ) const

protected

Gets the modified page content after performing layer extraction or removal.

This property contains a list of operators representing the modified content of the page after performing layer extraction or removal.

◆ get_ParsedFromContent()

bool Aspose::Pdf::Layer::get_ParsedFromContent ( ) const

protected

Gets a value indicating whether the layer was parsed from the content stream of the PDF document.

◆ get_Position()

int32_t Aspose::Pdf::Layer::get_Position ( ) const

protected

Gets the layer position in content stream.

◆ Lock()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Layer::Lock ( )

Locks the layer.

◆ Save()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Layer::Save ( System::String outputPath )

Saves the current layer to a PDF document.

Parameters

outputPath The file path where the PDF document will be saved.

◆ set_NumberOfChunks()

void Aspose::Pdf::Layer::set_NumberOfChunks ( int32_t value )

protected

Sets the number of optional content (OC) chunks contained within the PDF layer.

◆ set_OptionalContentProperty()

void Aspose::Pdf::Layer::set_OptionalContentProperty ( System::SharedPtr< Engine::Data::IPdfPrimitive > value )

protected

Sets the optional content property object.

◆ set_Page()

void Aspose::Pdf::Layer::set_Page ( System::SharedPtr< Aspose::Pdf::Page > value )

protected

Sets the page.

◆ set_ParsedFromContent()

void Aspose::Pdf::Layer::set_ParsedFromContent ( bool value )

protected

Sets a value indicating whether the layer was parsed from the content stream of the PDF document.

◆ set_Position()

void Aspose::Pdf::Layer::set_Position ( int32_t value )

protected

Gets the layer position in content stream.

◆ Unlock()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Layer::Unlock ( )

Unlocks the layer.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Layer()

◆ ~Layer()

Member Function Documentation

◆ CleanupOptionalContentResources()

◆ Delete()

◆ Flatten()

◆ get_Contents()

◆ get_Id()

◆ get_Locked()

◆ get_Name()

◆ get_NumberOfChunks()

◆ get_Page()

◆ get_PageContents()

◆ get_ParsedFromContent()

◆ get_Position()

◆ Lock()

◆ Save()

◆ set_NumberOfChunks()

◆ set_OptionalContentProperty()

◆ set_Page()

◆ set_ParsedFromContent()

◆ set_Position()

◆ Unlock()