Aspose::Pdf::Facades::AutoFiller Class Referencefinal

Represents a class to receive data from database or other datasource, fills them into the designed fields of the template pdf and at last generates new pdf file or stream. It has two template file input modes:input as a stream or a pdf file. It has four types of output modes:one merged stream, one merged file, many small streams, many small files. It can recieve literal data contained in a System.Data.DataTable. More...

Inherits Aspose::Pdf::Facades::ISaveableFacade.

Public Member Functions

ASPOSE_PDF_SHARED_API void set_UnFlattenFields (System::ArrayPtr< System::String > value)
 Sets the fields which will not be flattened. If this property is not set, all the fields will be flattened. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Streamget_OutputStream () const
 Gets the OutputStream. One of four output modes. Its classical use case is Response.OutputStream. Please refer to the online demo. More...
 
ASPOSE_PDF_SHARED_API void set_OutputStream (System::SharedPtr< System::IO::Stream > value)
 Sets the OutputStream. One of four output modes. Its classical use case is Response.OutputStream. Please refer to the online demo. More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< System::SharedPtr< System::IO::Stream > > get_OutputStreams () const
 Gets the many Output Streams. One of four output modes. More...
 
ASPOSE_PDF_SHARED_API void set_OutputStreams (System::ArrayPtr< System::SharedPtr< System::IO::Stream >> value)
 Sets the many Output Streams. One of four output modes. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Streamget_InputStream () const
 Gets the input template stream. One of two input modes. More...
 
ASPOSE_PDF_SHARED_API void set_InputStream (System::SharedPtr< System::IO::Stream > value)
 Sets the input template stream. One of two input modes. More...
 
ASPOSE_PDF_SHARED_API System::String get_InputFileName () const
 Gets the input template file. One of two input modes. More...
 
ASPOSE_PDF_SHARED_API void set_InputFileName (System::String value)
 Sets the input template file. One of two input modes. More...
 
ASPOSE_PDF_SHARED_API System::String get_OutputFileName () const
 Gets the one big merged output file. One of the four output modes. More...
 
ASPOSE_PDF_SHARED_API void set_OutputFileName (System::String value)
 Sets the one big merged output file. One of the four output modes. More...
 
ASPOSE_PDF_SHARED_API System::String get_GeneratingPath () const
 Gets the Generating Path of the small pdf files if many small pdf files to be generated. It works with another property BasicFileNameBasicFileName. One of the four output modes. More...
 
ASPOSE_PDF_SHARED_API void set_GeneratingPath (System::String value)
 Sets the Generating Path of the small pdf files if many small pdf files to be generated. It works with another property BasicFileNameBasicFileName. One of the four output modes. More...
 
ASPOSE_PDF_SHARED_API System::String get_BasicFileName () const
 Gets the basic file name if many small files will be generated. The generated file will be like "BasicFileName0","BasicFileName1",... It works with another property GeneratingPathGeneratingPath. More...
 
ASPOSE_PDF_SHARED_API void set_BasicFileName (System::String value)
 Sets the basic file name if many small files will be generated. The generated file will be like "BasicFileName0","BasicFileName1",... It works with another property GeneratingPathGeneratingPath. More...
 
ASPOSE_PDF_SHARED_API void Save ()
 Saves all the pdfs. More...
 
ASPOSE_PDF_SHARED_API void Save (System::String destFile) override
 Saves all the pdfs. More...
 
ASPOSE_PDF_SHARED_API void Save (System::SharedPtr< System::IO::Stream > destStream) override
 Saves all the pdfs. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile) override
 Binds a Pdf file. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream) override
 Binds a Pdf file. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< Document > srcDoc) override
 Binds a Pdf document. More...
 
ASPOSE_PDF_SHARED_API void Close () override
 Closes the object and output streams. More...
 
ASPOSE_PDF_SHARED_API void Dispose () override
 Closes the object and output streams. More...
 
ASPOSE_PDF_SHARED_API AutoFiller ()
 
- 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...
 

Protected Attributes

bool UseConcatenationAnyway
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a class to receive data from database or other datasource, fills them into the designed fields of the template pdf and at last generates new pdf file or stream. It has two template file input modes:input as a stream or a pdf file. It has four types of output modes:one merged stream, one merged file, many small streams, many small files. It can recieve literal data contained in a System.Data.DataTable.

Constructor & Destructor Documentation

◆ AutoFiller()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::AutoFiller::AutoFiller ( )

Member Function Documentation

◆ BindPdf() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::BindPdf ( System::String  srcFile)
overridevirtual

Binds a Pdf file.

Parameters
srcFilePdf file name.

Implements Aspose::Pdf::Facades::IFacade.

◆ BindPdf() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::BindPdf ( System::SharedPtr< System::IO::Stream srcStream)
overridevirtual

Binds a Pdf file.

Parameters
srcStreamPdf file stream.

Implements Aspose::Pdf::Facades::IFacade.

◆ BindPdf() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::BindPdf ( System::SharedPtr< Document srcDoc)
overridevirtual

Binds a Pdf document.

Parameters
srcDocPdf document.

Implements Aspose::Pdf::Facades::IFacade.

◆ Close()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::Close ( )
overridevirtual

Closes the object and output streams.

Implements Aspose::Pdf::Facades::IFacade.

◆ Dispose()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::Dispose ( )
overridevirtual

Closes the object and output streams.

Reimplemented from System::IDisposable.

◆ get_BasicFileName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::AutoFiller::get_BasicFileName ( ) const

Gets the basic file name if many small files will be generated. The generated file will be like "BasicFileName0","BasicFileName1",... It works with another property GeneratingPathGeneratingPath.

◆ get_GeneratingPath()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::AutoFiller::get_GeneratingPath ( ) const

Gets the Generating Path of the small pdf files if many small pdf files to be generated. It works with another property BasicFileNameBasicFileName. One of the four output modes.

◆ get_InputFileName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::AutoFiller::get_InputFileName ( ) const

Gets the input template file. One of two input modes.

Deprecated:
Use BindPdf(inputFile) method for facade initialization.

◆ get_InputStream()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Facades::AutoFiller::get_InputStream ( ) const

Gets the input template stream. One of two input modes.

Deprecated:
Use BindPdf(inputStream) method for facade initialization.

◆ get_OutputFileName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::AutoFiller::get_OutputFileName ( ) const

Gets the one big merged output file. One of the four output modes.

Deprecated:
Use Save(outputFile) method for getting facade results.

◆ get_OutputStream()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Facades::AutoFiller::get_OutputStream ( ) const

Gets the OutputStream. One of four output modes. Its classical use case is Response.OutputStream. Please refer to the online demo.

Deprecated:
Use Save(outputStream) method for getting facade results.

◆ get_OutputStreams()

ASPOSE_PDF_SHARED_API System::ArrayPtr<System::SharedPtr<System::IO::Stream> > Aspose::Pdf::Facades::AutoFiller::get_OutputStreams ( ) const

Gets the many Output Streams. One of four output modes.

◆ Save() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::Save ( )

Saves all the pdfs.

Deprecated:
Use Save(destination) method for saving facade results.

◆ Save() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::Save ( System::String  destFile)
overridevirtual

Saves all the pdfs.

Parameters
destFileOutput file name.

Implements Aspose::Pdf::Facades::ISaveableFacade.

◆ Save() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::Save ( System::SharedPtr< System::IO::Stream destStream)
overridevirtual

Saves all the pdfs.

Parameters
destStreamOutput stream.

Implements Aspose::Pdf::Facades::ISaveableFacade.

◆ set_BasicFileName()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_BasicFileName ( System::String  value)

Sets the basic file name if many small files will be generated. The generated file will be like "BasicFileName0","BasicFileName1",... It works with another property GeneratingPathGeneratingPath.

◆ set_GeneratingPath()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_GeneratingPath ( System::String  value)

Sets the Generating Path of the small pdf files if many small pdf files to be generated. It works with another property BasicFileNameBasicFileName. One of the four output modes.

◆ set_InputFileName()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_InputFileName ( System::String  value)

Sets the input template file. One of two input modes.

Deprecated:
Use BindPdf(inputFile) method for facade initialization.

◆ set_InputStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_InputStream ( System::SharedPtr< System::IO::Stream value)

Sets the input template stream. One of two input modes.

Deprecated:
Use BindPdf(inputStream) method for facade initialization.

◆ set_OutputFileName()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_OutputFileName ( System::String  value)

Sets the one big merged output file. One of the four output modes.

Deprecated:
Use Save(outputFile) method for getting facade results.

◆ set_OutputStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_OutputStream ( System::SharedPtr< System::IO::Stream value)

Sets the OutputStream. One of four output modes. Its classical use case is Response.OutputStream. Please refer to the online demo.

Deprecated:
Use Save(outputStream) method for getting facade results.

◆ set_OutputStreams()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_OutputStreams ( System::ArrayPtr< System::SharedPtr< System::IO::Stream >>  value)

Sets the many Output Streams. One of four output modes.

◆ set_UnFlattenFields()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::AutoFiller::set_UnFlattenFields ( System::ArrayPtr< System::String value)

Sets the fields which will not be flattened. If this property is not set, all the fields will be flattened.

Member Data Documentation

◆ UseConcatenationAnyway

bool Aspose::Pdf::Facades::AutoFiller::UseConcatenationAnyway
protected