Represents base options for plugins. More...

#include "OrganizerBaseOptions.h"

Inherits Aspose::Pdf::Plugins::IPluginOptions, Aspose::Pdf::Plugins::IDataContainer, and Aspose::Pdf::Plugins::ISaveInstruction.

Inherited by Aspose::Pdf::Plugins::CompressOptions, Aspose::Pdf::Plugins::DecryptionOptions, Aspose::Pdf::Plugins::EncryptionOptions, Aspose::Pdf::Plugins::MergeOptions, Aspose::Pdf::Plugins::OptimizeOptions, Aspose::Pdf::Plugins::ResizeOptions, Aspose::Pdf::Plugins::RotateOptions, Aspose::Pdf::Plugins::SignOptions, and Aspose::Pdf::Plugins::SplitOptions.

Public Member Functions
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< IDataSource > > >	get_Inputs () override
	Returns OrganizerOptions plugin data collection. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< IDataSource > > >	get_Outputs () override
	Gets collection of added targets for saving operation results. More...

ASPOSE_PDF_SHARED_API bool	get_CloseInputStreams () const
	Close input streams after operation completed. More...

ASPOSE_PDF_SHARED_API void	set_CloseInputStreams (bool value)
	Close input streams after operation completed. More...

ASPOSE_PDF_SHARED_API bool	get_CloseOutputStreams () const
	Close output streams after operation completed. More...

ASPOSE_PDF_SHARED_API void	set_CloseOutputStreams (bool value)
	Close output streams after operation completed. More...

ASPOSE_PDF_SHARED_API void	AddInput (System::SharedPtr< IDataSource > dataSource) override
	Adds new data source to the PdfOrganizer plugin data collection. More...

ASPOSE_PDF_SHARED_API void	AddOutput (System::SharedPtr< IDataSource > saveDataSource) override
	Adds new data source to the PdfOrganizer plugin data collection. 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
	OrganizerBaseOptions ()
	Initializes new instance of the OrganizerBaseOptions object. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (OrganizerBaseOptions, CODEPORTING_ARGS())

System::SharedPtr< Document >	OpenDocument (System::SharedPtr< System::IO::Stream > stream, Plugin plugin, System::String ownerPassword=nullptr)
	Open document for plugin. More...

System::ArrayPtr< System::SharedPtr< Document > >	OpenDocuments (System::ArrayPtr< System::SharedPtr< System::IO::Stream >> streams, Plugin plugin)
	Open documents from the streams. More...

void	CloseStreams (System::ArrayPtr< System::SharedPtr< System::IO::Stream >> streams)
	Close the streams. More...

void	CloseStream (System::SharedPtr< System::IO::Stream > stream)
	Close the stream. More...

System::SharedPtr< System::IO::Stream >	GetInputStream (int32_t i, System::SharedPtr< IDataContainer > dataContainer)
	Return input stream from Options.DataCollection. More...

void	AddResult (System::SharedPtr< ResultContainer > results, System::SharedPtr< ISaveInstruction > options, System::SharedPtr< System::IO::Stream > outputStream, int32_t index)
	Add result in result collection. More...

System::SharedPtr< System::IO::Stream >	GetInputStream (System::SharedPtr< IDataSource > dataSource)

System::ArrayPtr< System::SharedPtr< System::IO::Stream > >	GetInputStreams ()

System::SharedPtr< System::IO::Stream >	GetOutputStream (int32_t i)

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 base options for plugins.

Constructor & Destructor Documentation

◆ OrganizerBaseOptions()

Aspose::Pdf::Plugins::OrganizerBaseOptions::OrganizerBaseOptions ( )

protected

Initializes new instance of the OrganizerBaseOptions object.

Member Function Documentation

◆ AddInput()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::OrganizerBaseOptions::AddInput ( System::SharedPtr< IDataSource > dataSource )

overridevirtual

Adds new data source to the PdfOrganizer plugin data collection.

Parameters

dataSource Data source to add.

Implements Aspose::Pdf::Plugins::IDataContainer.

◆ AddOutput()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::OrganizerBaseOptions::AddOutput ( System::SharedPtr< IDataSource > saveDataSource )

overridevirtual

Adds new data source to the PdfOrganizer plugin data collection.

Parameters

saveDataSource Data source (file or stream) for saving operation results.

Exceptions

NotImplementedException

Implements Aspose::Pdf::Plugins::ISaveInstruction.

◆ AddResult()

void Aspose::Pdf::Plugins::OrganizerBaseOptions::AddResult	(	System::SharedPtr< ResultContainer >	results,
		System::SharedPtr< ISaveInstruction >	options,
		System::SharedPtr< System::IO::Stream >	outputStream,
		int32_t	index
	)

protected

Add result in result collection.

Parameters

results	Result Container.
options	Options with save instructions.
outputStream	Output stream (if it should be stream).
index	Index in SaveTargetsCollection.

◆ CloseStream()

void Aspose::Pdf::Plugins::OrganizerBaseOptions::CloseStream ( System::SharedPtr< System::IO::Stream > stream )

protected

Close the stream.

Parameters

stream Stream for closing.

◆ CloseStreams()

void Aspose::Pdf::Plugins::OrganizerBaseOptions::CloseStreams ( System::ArrayPtr< System::SharedPtr< System::IO::Stream >> streams )

protected

Close the streams.

Parameters

streams Streams for closing.

◆ get_CloseInputStreams()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Plugins::OrganizerBaseOptions::get_CloseInputStreams ( ) const

Close input streams after operation completed.

◆ get_CloseOutputStreams()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Plugins::OrganizerBaseOptions::get_CloseOutputStreams ( ) const

Close output streams after operation completed.

◆ get_Inputs()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<IDataSource> > > Aspose::Pdf::Plugins::OrganizerBaseOptions::get_Inputs ( )

overridevirtual

Returns OrganizerOptions plugin data collection.

Implements Aspose::Pdf::Plugins::IDataContainer.

◆ get_Outputs()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<IDataSource> > > Aspose::Pdf::Plugins::OrganizerBaseOptions::get_Outputs ( )

overridevirtual

Gets collection of added targets for saving operation results.

Implements Aspose::Pdf::Plugins::ISaveInstruction.

◆ GetInputStream() [1/2]

System::SharedPtr<System::IO::Stream> Aspose::Pdf::Plugins::OrganizerBaseOptions::GetInputStream	(	int32_t	i,
		System::SharedPtr< IDataContainer >	dataContainer
	)

protected

Return input stream from Options.DataCollection.

Parameters

i	Index in DataCollection.
dataContainer	The options.

Returns

Exceptions

ArgumentException If DataType is not supported

◆ GetInputStream() [2/2]

System::SharedPtr<System::IO::Stream> Aspose::Pdf::Plugins::OrganizerBaseOptions::GetInputStream ( System::SharedPtr< IDataSource > dataSource )

protected

◆ GetInputStreams()

System::ArrayPtr<System::SharedPtr<System::IO::Stream> > Aspose::Pdf::Plugins::OrganizerBaseOptions::GetInputStreams ( )

protected

◆ GetOutputStream()

System::SharedPtr<System::IO::Stream> Aspose::Pdf::Plugins::OrganizerBaseOptions::GetOutputStream ( int32_t i )

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Plugins::OrganizerBaseOptions::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	OrganizerBaseOptions	,
		CODEPORTING_ARGS()
	)

protected

◆ OpenDocument()

System::SharedPtr<Document> Aspose::Pdf::Plugins::OrganizerBaseOptions::OpenDocument	(	System::SharedPtr< System::IO::Stream >	stream,
		Plugin	plugin,
		System::String	ownerPassword = `nullptr`
	)

protected

Open document for plugin.

Parameters

stream	The Stream with data.
plugin	Type of the Plugin.
ownerPassword	The password for the Document.

Returns: The Document object.

◆ OpenDocuments()

System::ArrayPtr<System::SharedPtr<Document> > Aspose::Pdf::Plugins::OrganizerBaseOptions::OpenDocuments	(	System::ArrayPtr< System::SharedPtr< System::IO::Stream >>	streams,
		Plugin	plugin
	)

protected

Open documents from the streams.

Parameters

streams	The streams with data.
plugin	Type of the Plugin.

Returns: The Document objects.

◆ set_CloseInputStreams()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::OrganizerBaseOptions::set_CloseInputStreams ( bool value )

Close input streams after operation completed.

◆ set_CloseOutputStreams()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Plugins::OrganizerBaseOptions::set_CloseOutputStreams ( bool value )

Close output streams after operation completed.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OrganizerBaseOptions()

Member Function Documentation

◆ AddInput()

◆ AddOutput()

◆ AddResult()

◆ CloseStream()

◆ CloseStreams()

◆ get_CloseInputStreams()

◆ get_CloseOutputStreams()

◆ get_Inputs()

◆ get_Outputs()

◆ GetInputStream() [1/2]

◆ GetInputStream() [2/2]

◆ GetInputStreams()

◆ GetOutputStream()

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

◆ OpenDocument()

◆ OpenDocuments()

◆ set_CloseInputStreams()

◆ set_CloseOutputStreams()