Form.h

#pragma once
// Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.

// C# preprocessor directive: #if !NETCORE


// C# preprocessor directive: #endif


#include <system/enum_helpers.h>
#include <system/array.h>
#include <cstdint>

#include "Aspose.PDF.Cpp/Facades/Facade.h"
#include "Aspose.PDF.Cpp/aspose_pdf_api_defs.h"

namespace Aspose
{
namespace Pdf
{
namespace Annotations
{
class WidgetAnnotation;
} // namespace Annotations
namespace Collections
{
template <typename, typename> class AsposeHashDictionary;
} // namespace Collections
enum class ContentDisposition;
class Document;
namespace Engine
{
namespace CommonData
{
class ITreeNode;
} // namespace CommonData
namespace Data
{
class IPdfArray;
class IPdfDictionary;
class IPdfNumber;
class IPdfObject;
class ITrailerable;
} // namespace Data
} // namespace Engine
namespace Facades
{
enum class FieldType;
class Form;
class FormEditor;
class FormFieldFacade;
enum class PropertyFlag;
enum class SubmitFormFlag;
} // namespace Facades
namespace Forms
{
class ChoiceField;
class Field;
class OptionCollection;
} // namespace Forms
class Operator;
class OperatorCollection;
enum class PdfFormat;
class SaveOptions;
namespace Tests
{
namespace OriginalKit
{
namespace New
{
class RegressionTests_v4_8;
} // namespace New
} // namespace OriginalKit
} // namespace Tests
} // namespace Pdf
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename, typename> class Dictionary;
template <typename> class ICollection;
template <typename> class List;
} // namespace Generic
} // namespace Collections
namespace IO
{
class Stream;
} // namespace IO
namespace Web
{
class HttpResponse;
} // namespace Web
namespace Xml
{
class XmlDocument;
class XmlNamespaceManager;
class XmlNode;
class XmlNodeList;
class XmlTextWriter;
} // namespace Xml
} // namespace System

namespace Aspose {

namespace Pdf {

namespace Facades {

class ASPOSE_PDF_SHARED_CLASS Form final : public Aspose::Pdf::Facades::SaveableFacade
{
    typedef Form ThisType;
    typedef Aspose::Pdf::Facades::SaveableFacade BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Pdf::Facades::FormEditor;
    friend class Aspose::Pdf::Tests::OriginalKit::New::RegressionTests_v4_8;
    
public:

    enum class ImportStatus
    {
        Success,
        FieldNotFound
    };
    
    
public:

    class ASPOSE_PDF_SHARED_CLASS FormImportResult : public System::Object
    {
        typedef FormImportResult ThisType;
        typedef System::Object BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
        
        friend class Aspose::Pdf::Facades::Form;
        
    public:
    
        ASPOSE_PDF_SHARED_API Form::ImportStatus get_Status() const;
        ASPOSE_PDF_SHARED_API System::String get_FieldName() const;
        
    protected:
    
        FormImportResult(System::String fieldName, Form::ImportStatus status);
        
        MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(FormImportResult, CODEPORTING_ARGS(System::String fieldName, Form::ImportStatus status));
        
    private:
    
        Form::ImportStatus _status;
        System::String _fieldName;
        
    };
    
    
public:

    ASPOSE_PDF_SHARED_API System::ArrayPtr<System::SharedPtr<Form::FormImportResult>> get_ImportResult();
    ASPOSE_PDF_SHARED_API System::String get_SrcFileName() const;
    ASPOSE_PDF_SHARED_API void set_SrcFileName(System::String value);
    ASPOSE_PDF_SHARED_API void set_ConvertTo(PdfFormat value);
    ASPOSE_PDF_SHARED_API System::String get_DestFileName() const;
    ASPOSE_PDF_SHARED_API void set_DestFileName(System::String value);
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> get_SrcStream() const;
    ASPOSE_PDF_SHARED_API void set_SrcStream(System::SharedPtr<System::IO::Stream> value);
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> get_DestStream() const;
    ASPOSE_PDF_SHARED_API void set_DestStream(System::SharedPtr<System::IO::Stream> value);
    ASPOSE_PDF_SHARED_API System::ArrayPtr<System::String> get_FieldNames();
    ASPOSE_PDF_SHARED_API System::ArrayPtr<System::String> get_FormSubmitButtonNames();
    ASPOSE_PDF_SHARED_API Aspose::Pdf::ContentDisposition get_ContentDisposition() const;
    ASPOSE_PDF_SHARED_API void set_ContentDisposition(Aspose::Pdf::ContentDisposition value);
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::Web::HttpResponse> get_Response() const;
    ASPOSE_PDF_SHARED_API void set_Response(System::SharedPtr<System::Web::HttpResponse> value);
    ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::SaveOptions> get_SaveOptions() const;
    ASPOSE_PDF_SHARED_API void set_SaveOptions(System::SharedPtr<Aspose::Pdf::SaveOptions> value);
    ASPOSE_PDF_SHARED_API System::String get_AttachmentName() const;
    ASPOSE_PDF_SHARED_API void set_AttachmentName(System::String value);
    
    ASPOSE_PDF_SHARED_API System::SharedPtr<FormFieldFacade> GetFieldFacade(System::String fieldName);
    
    ASPOSE_PDF_SHARED_API Form(System::SharedPtr<System::IO::Stream> srcStream, System::SharedPtr<System::IO::Stream> destStream);
    ASPOSE_PDF_SHARED_API Form();
    
    ASPOSE_PDF_SHARED_API bool FillField(System::String fieldName, System::String fieldValue);
    ASPOSE_PDF_SHARED_API bool FillField(System::String fieldName, int32_t index);
    ASPOSE_PDF_SHARED_API bool FillField(System::String fieldName, bool beChecked);
    ASPOSE_PDF_SHARED_API bool FillFields(System::ArrayPtr<System::String> fieldNames, System::ArrayPtr<System::String> fieldValues, System::SharedPtr<System::IO::Stream>& output);
    ASPOSE_PDF_SHARED_API System::String GetButtonOptionCurrentValue(System::String fieldName);
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::Dictionary<System::String, System::String>> GetButtonOptionValues(System::String fieldName);
    ASPOSE_PDF_SHARED_API System::String GetField(System::String fieldName);
    ASPOSE_PDF_SHARED_API System::String GetFullFieldName(System::String fieldName);
    ASPOSE_PDF_SHARED_API int32_t GetFieldLimit(System::String fieldName);
    ASPOSE_PDF_SHARED_API void Save();
    ASPOSE_PDF_SHARED_API void Save(System::String destFile) override;
    ASPOSE_PDF_SHARED_API void Save(System::SharedPtr<System::IO::Stream> destStream) override;
    ASPOSE_PDF_SHARED_API void Close() override;
    ASPOSE_PDF_SHARED_API void FlattenAllFields();
    ASPOSE_PDF_SHARED_API void FlattenField(System::String fieldName);
    ASPOSE_PDF_SHARED_API bool FillBarcodeField(System::String fieldName, System::String data);
    ASPOSE_PDF_SHARED_API void ImportFdf(System::SharedPtr<System::IO::Stream> inputFdfStream);
    ASPOSE_PDF_SHARED_API void ExportFdf(System::SharedPtr<System::IO::Stream> outputFdfStream);
    ASPOSE_PDF_SHARED_API void ImportXml(System::SharedPtr<System::IO::Stream> inputXmlStream);
    ASPOSE_PDF_SHARED_API void ExportXml(System::SharedPtr<System::IO::Stream> outputXmlStream);
    ASPOSE_PDF_SHARED_API void ExtractXfaData(System::SharedPtr<System::IO::Stream> outputXmlStream);
    ASPOSE_PDF_SHARED_API void SetXfaData(System::SharedPtr<System::IO::Stream> inputXmlStream);
    ASPOSE_PDF_SHARED_API void ImportXfdf(System::SharedPtr<System::IO::Stream> inputXfdfStream);
    ASPOSE_PDF_SHARED_API void ExportXfdf(System::SharedPtr<System::IO::Stream> outputXfdfStream);
    ASPOSE_PDF_SHARED_API void FillField(System::String fieldName, System::ArrayPtr<System::String> fieldValues);
    ASPOSE_PDF_SHARED_API void RenameField(System::String fieldName, System::String newFieldName);
    ASPOSE_PDF_SHARED_API System::String GetRichText(System::String fieldName);
    ASPOSE_PDF_SHARED_API SubmitFormFlag GetSubmitFlags(System::String fieldName);
    
    ASPOSE_PDF_SHARED_API Form(System::String srcFileName);
    ASPOSE_PDF_SHARED_API Form(System::SharedPtr<System::IO::Stream> srcStream);
    ASPOSE_PDF_SHARED_API Form(System::String srcFileName, System::String destFileName);
    ASPOSE_PDF_SHARED_API Form(System::String srcFileName, System::SharedPtr<System::IO::Stream> destStream);
    ASPOSE_PDF_SHARED_API Form(System::SharedPtr<System::IO::Stream> srcStream, System::String destFileName);
    
    ASPOSE_PDF_SHARED_API FieldType GetFieldType(System::String fieldName);
    ASPOSE_PDF_SHARED_API bool IsRequiredField(System::String fieldName);
    ASPOSE_PDF_SHARED_API PropertyFlag GetFieldFlag(System::String fieldName);
    ASPOSE_PDF_SHARED_API void FillImageField(System::String fieldName, System::String imageFileName);
    ASPOSE_PDF_SHARED_API void FillImageField(System::String fieldName, System::SharedPtr<System::IO::Stream> imageStream);
    
    ASPOSE_PDF_SHARED_API Form(System::SharedPtr<Aspose::Pdf::Document> document);
    ASPOSE_PDF_SHARED_API Form(System::SharedPtr<Aspose::Pdf::Document> document, System::String destFileName);
    ASPOSE_PDF_SHARED_API Form(System::SharedPtr<Aspose::Pdf::Document> document, System::SharedPtr<System::IO::Stream> destStream);
    
    ASPOSE_PDF_SHARED_API void ImportXml(System::SharedPtr<System::IO::Stream> inputXmlStream, bool IgnoreFormTemplateChanges);
    ASPOSE_PDF_SHARED_API bool FillField(System::String fieldName, System::String value, bool fitFontSize);
    
    ASPOSE_PDF_SHARED_API Form(System::SharedPtr<System::IO::Stream> inputStream, System::SharedPtr<System::Web::HttpResponse> response);
    ASPOSE_PDF_SHARED_API Form(System::String inputFile, System::SharedPtr<System::Web::HttpResponse> response);
    
protected:

    ASPOSE_PDF_SHARED_API void BindPdf(System::SharedPtr<System::IO::Stream> srcStream, System::String password) override;
    ASPOSE_PDF_SHARED_API void BindPdf(System::String srcFile, System::String password) override;
    static bool IsImageField(System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> annotation);
    static FieldType getFieldType(System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> annotation);
    System::SharedPtr<System::Xml::XmlNode> GetFieldTemplate(System::String fieldName);
    
private:

    System::SharedPtr<System::IO::Stream> sourceStream;
    System::SharedPtr<System::IO::Stream> destStream;
    bool _closeStream;
    bool _formChanged;
    System::String sourceFileName;
    System::String destFileName;
    PdfFormat _convertTo;
    bool _executeConvert;
    Aspose::Pdf::ContentDisposition _contentDisposition;
    System::SharedPtr<Aspose::Pdf::SaveOptions> _saveOptions;
    System::String _attachmentName;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Form::FormImportResult>>> _importResult;
    System::SharedPtr<System::Web::HttpResponse> _outputResponse;
    
    bool IsIncrementalUpdates();
    void CloseSource();
    void CloseDest();
    System::String RemoveLines(System::String s);
    System::SharedPtr<System::Xml::XmlNode> GetXfaNode(System::SharedPtr<System::Xml::XmlDocument> xml);
    void CollectValues(System::String parent, System::SharedPtr<System::Xml::XmlNodeList> nodes, System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> values);
    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> GetValues(System::SharedPtr<System::Xml::XmlDocument> xml);
    void CollectXfaValues(System::String parent, System::SharedPtr<System::Xml::XmlNodeList> nodes, System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> values);
    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> GetXfaValues(System::SharedPtr<System::Xml::XmlNode> xfa);
    void ReadFieldsFromTeamplate(System::SharedPtr<System::Xml::XmlNode> node, System::SharedPtr<System::Xml::XmlTextWriter> writer, System::String path);
    void ReadFieldsFromTeamplate(System::SharedPtr<System::Xml::XmlTextWriter> writer);
    bool IsDataPacketEmpty(System::SharedPtr<Aspose::Pdf::Document> doc);
    void UpdateStaticFormAfterXfaReplace();
    void collectFields(System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>> fields, System::String prefix, System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::SharedPtr<Aspose::Pdf::Forms::Field>>> destination);
    int32_t findPage(System::SharedPtr<Aspose::Pdf::Forms::Field> field);
    System::ArrayPtr<System::String> getOptionsAsStrings(System::SharedPtr<Aspose::Pdf::Forms::OptionCollection> options);
    System::ArrayPtr<System::ArrayPtr<System::String>> getOptionsAsArrays(System::SharedPtr<Aspose::Pdf::Forms::OptionCollection> options);
    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> getOptionsForChoiceField(System::SharedPtr<Aspose::Pdf::Forms::ChoiceField> field);
    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> getOptionsForField(System::SharedPtr<Aspose::Pdf::Forms::Field> field);
    bool isSingleCheckbox(System::SharedPtr<Aspose::Pdf::Forms::Field> field);
    System::String getFieldValue(System::SharedPtr<Aspose::Pdf::Forms::Field> field);
    void ExportFieldsToFdf(System::SharedPtr<Aspose::Pdf::Engine::Data::ITrailerable> trailerable, System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>> source, System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfArray> dest);
    bool hasChildFields(System::SharedPtr<System::Xml::XmlNode> node);
    void ExportXfaTemplateToFdf(System::SharedPtr<Aspose::Pdf::Engine::Data::ITrailerable> trailerable, System::SharedPtr<System::Xml::XmlNodeList> source, System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfArray> dest, System::String fullName);
    void ExportXfaToFdf(System::SharedPtr<Aspose::Pdf::Engine::Data::ITrailerable> trailerable, System::SharedPtr<System::Xml::XmlNodeList> source, System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfArray> dest);
    void ExportToXmlXfa(System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>> source, System::SharedPtr<System::Xml::XmlTextWriter> dest);
    void ExportFieldsToXml(System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>> source, System::SharedPtr<System::Xml::XmlTextWriter> dest);
    bool IsXfaFieldMultiline(System::String path);
    void ImportXmlFromXfa(System::SharedPtr<System::Xml::XmlNodeList> source, System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>> dest, System::String xfaPath);
    System::SharedPtr<Aspose::Pdf::Forms::Field> findField(System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>> fields, System::String fieldName);
    void setFieldValue(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> source, System::SharedPtr<Aspose::Pdf::Forms::Field> dest, System::String xfaPath);
    void ImportFieldsFromFdf(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfArray> source, System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>> dest, System::String xfaPath);
    System::SharedPtr<System::Xml::XmlNamespaceManager> GetTemplateNamespace();
    System::SharedPtr<System::Xml::XmlNamespaceManager> GetDatasetNamespace();
    System::SharedPtr<System::Collections::Generic::List<int32_t>> CreateTail(System::SharedPtr<System::Collections::Generic::List<int32_t>> path);
    System::SharedPtr<System::Xml::XmlNode> GetFieldTemplate(System::String fieldName, bool fullName);
    System::SharedPtr<System::Xml::XmlNode> GetFieldData(System::String fieldName);
    System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Search(System::SharedPtr<Aspose::Pdf::Engine::CommonData::ITreeNode> root, int32_t index);
    System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> GetStructParentElement(int32_t index);
    System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfNumber> GetElementMcid(int32_t structParentIndex);
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> GetOperatorsByMcid(System::SharedPtr<OperatorCollection> operators, int32_t mcid, System::String tag);
    
};

} // namespace Facades
} // namespace Pdf
} // namespace Aspose