Form Bridge-API's voor HTML5-formulieren

Met de API's van Form Bridge kunt u een communicatiekanaal openen tussen een op XFA gebaseerde HTML5-formulier en uw toepassingen. De API's van de Form Bridge beschikken over een API om de verbinding te maken.

De connect API keurt een manager als argument goed. Nadat een verbinding tot stand is gebracht tussen een op XFA gebaseerd HTML5-formulier en een Form Bridge, wordt de greep aangeroepen.

U kunt de volgende voorbeeldcode gebruiken om de verbinding tot stand te brengen.

// Example showing how to connect to FormBridge
window.addEventListener("FormBridgeInitialized",
                                function(event) {
                                    var fb = event.detail.formBridge;
                                    fb.connect(function() {
                                           //use form bridge functions
                         })
                            })

Beschikbare API voor Form Bridge 

getBridgeVersion()

Hiermee wordt het versienummer van de scriptbibliotheek geretourneerd

• Invoer: Geen
• Uitvoer: Versienummer van de scriptbibliotheek
• Fouten: Geen

isConnected() Controleert of de formulierstatus is geïnitialiseerd

• Invoer: Geen

• Uitvoer: ​​Trueif de XFA-formulierstatus is geïnitialiseerd

• Fouten: Geen

connect(handler, context) Maakt verbinding met FormBridge en voert de functie uit nadat de verbinding is gemaakt en de formulierstatus is geïnitialiseerd

• Invoer:

  • handler: Functie die moet worden uitgevoerd nadat Form Bridge is verbonden
  • context: Het voorwerp waaraan de context (dit) van de *handler *function wordt geplaatst.

• Uitvoer: Geen

• Fout: Geen

getDataXML(options) Hiermee worden de huidige formuliergegevens in XML-indeling geretourneerd

• Invoer:

  • opties: JavaScript-object met de volgende eigenschappen:

    • Fout: Error Handler Function
    • succes: Handlerfunctie voor succes. Deze functie wordt doorgegeven aan een object dat XML bevat in de eigenschap data.
    • context: Het object waarop de context (dit) van de ** opvolfunctie is ingesteld
    • validationChecker: Functie om validatiefouten te controleren die van de server zijn ontvangen. Validatiefunctie wordt doorgegeven aan een array met fouttekenreeksen.
    • formState: De JSON-status van het XFA-formulier waarvoor gegevens-XML moet worden geretourneerd. Als deze optie niet is opgegeven, worden de gegevens-XML geretourneerd voor het momenteel gegenereerde formulier.

• Uitvoer: Geen

• Fout: Geen

registerConfig(configName, config) Registreert gebruiker/poortspecifieke configuraties met FormBridge. Deze configuraties overschrijven de standaardconfiguraties. De gesteunde configuraties worden gespecificeerd in de config sectie.

• Invoer:

  • configName: Naam van de configuratie om met voeten te treden

    • widgetConfig: Hiermee kan de gebruiker de standaardwidgets in het formulier overschrijven met aangepaste widgets. De configuratie wordt als volgt overschreven:

      formBridge.registerConfig("widgetConfig":{/*configuration*/})

    • pagingConfig: Staat de gebruiker toe om het standaardgedrag met voeten te treden van het teruggeven slechts de eerste pagina. De configuratie wordt als volgt overschreven:

      window.formBridge.registerConfig("pagingConfig":{pagingDisabled: <true | false>, shrinkPageDisabled: <true | false> }).

    • LoggingConfig: Staat de gebruiker toe om het niveau van het registreren met voeten te treden, het registreren voor een categorie onbruikbaar te maken, of om de logboekconsole te tonen of naar server te verzenden. De configuratie kan als volgt worden overschreven:

    formBridge.registerConfig{
      "LoggerConfig" : {
    {
    "on":`<true *| *false>`,
    "category":`<array of categories>`,
    "level":`<level of categories>`, "
    type":`<"console"/"server"/"both">`
        }
      }
    

    • SubmitServiceProxyConfig: Sta de gebruikers toe om voorlegging te registreren en de volmachtsdiensten te registreren.

      window.formBridge.registerConfig("submitServiceProxyConfig",
      {
      "submitServiceProxy" : "`<submitServiceProxy>`",
      "logServiceProxy": "`<logServiceProxy>`",
      "submitUrl" : "`<submitUrl>`"
      });
      

  • config: Waarde van de configuratie

• Uitvoer: Object met oorspronkelijke waarde van de configuratie in ** gegevenseigenschap.

• Fout: Geen

hideFields(fieldArray) Hiermee worden de velden verborgen waarvan de SOM-expressies worden opgegeven in de fieldArray. Hiermee wordt de aanwezigheidseigenschap van de opgegeven velden ingesteld op onzichtbaar

• Invoer:

  • fieldArray: Array van SOM-expressies voor de te verbergen velden

• Uitvoer: Geen

• Fout: Geen

showFields(fieldArray) Hiermee worden de velden weergegeven waarvan de SOM-expressies worden opgegeven in de fieldArray. Hiermee wordt de aanwezigheidseigenschap van de opgegeven velden ingesteld op visible

• Invoer:

  • fieldArray: Array van SOM-expressies voor de velden die moeten worden weergegeven

• Uitvoer: Geen

• Fout: Geen

hideSubmitButtons() Hiermee worden alle verzendknoppen in het formulier verborgen

• Invoer: Geen
• Uitvoer: Geen
• Fout: Hiermee wordt een uitzondering gegenereerd als de formulierstatus niet is geïnitialiseerd

getFormState() Retourneert de JSON die de formulierstatus vertegenwoordigt

• Invoer: Geen

• Uitvoer: Object met JSON die de huidige formulierstatus in ** gegevenseigenschap vertegenwoordigt.

• Fout: Geen

restoreFormState(options) Hiermee wordt de formulierstatus hersteld vanaf de opgegeven JSON-status in het object options. De status wordt toegepast en succes- of fouthandlers worden aangeroepen nadat de bewerking is voltooid

• Invoer:

  • Opties: JavaScript-object met de volgende eigenschappen:

    • Fout: Error Handler Function
    • succes: Handlerfunctie voor succes
    • context: Het object waarop de context (dit) van de ** opvolfunctie is ingesteld
    • formState: JSON-status van het formulier. Het formulier wordt teruggezet naar de JSON-status.

• Uitvoer: Geen

• Fout: Geen

setFocus (som) Hiermee wordt de focus ingesteld op het veld dat is opgegeven in de SOM-expressie

• Invoer: bepaalde expressie van het veld waarop de focus moet worden ingesteld
• Uitvoer: Geen
• Fout: genereert een uitzondering in geval van onjuiste SOM-expressie

setFieldValue (som, value) Hiermee wordt de waarde van de velden voor de opgegeven SOM-expressies ingesteld

• Invoer:

  • som: Array met enkele expressies van het veld. The som expression to set value of the fields.
  • value: Array met waarden die overeenkomen met SOM-expressies die in een ​​willekeurige array zijn opgegeven. Als het gegevenstype van de waarde niet hetzelfde is als het fieldType, wordt de waarde niet gewijzigd.

• Uitvoer: Geen

• Fout: genereert een uitzondering in het geval van een onjuiste SOM-expressie

getFieldValue (som) Retourneert de waarde van de velden voor de opgegeven SOM-expressies

• Input: Array met enkele expressies van velden waarvan de waarde moet worden opgehaald

• Uitvoer: Object dat het resultaat bevat als Array in ​​gegevenseigenschap.

• Fout: Geen

Voorbeeld van getFieldValue()-API

var a =  formBridge.getFieldValue(“xfa.form.form1.Subform1.TextField”);
if(a.errors) {
    var err;
     while((err = a.getNextMessage()) != null)
               alert(a.message)
} else {
   alert(a.data[0])
}

getFieldProperties(som, property) Hiermee wordt de lijst met waarden voor de opgegeven eigenschap opgehaald van de velden die in SOM-expressies zijn opgegeven

• Invoer:

  • som: Array met SOM-expressies voor de velden
  • eigenschap: Naam van de eigenschap waarvan de waarde is vereist

• Output: Object dat het resultaat bevat als Array in *data *property

• Fout: Geen

setFieldProperties(som, property, values) Hiermee wordt de waarde van de opgegeven eigenschap ingesteld voor alle velden die in de SOM-expressies zijn opgegeven

• Invoer:

  • som: Array met enkele expressies van velden waarvan de waarde moet worden ingesteld
  • eigenschap: Eigenschap waarvan de waarde moet worden ingesteld
  • value: Array met waarden van de opgegeven eigenschap voor velden die zijn opgegeven in SOM-expressies

• Uitvoer: Geen

• Fout: Geen

Voorbeeld van gebruik van Form Bridge-API

// Example 1: FormBridge.restoreFormState
  function loadFormState() {
    var suc = function(obj) {
             //success
            }
    var err = function(obj) {
           while(var t = obj.getNextMessage()) {
         $("#errorDiv").append("<div>"+t.message+"</div>");
           }
           }
        var _formState = // load form state from storage
    formBridge.restoreFormState({success:suc,error:err,formState:_formState}); // not passing a context means that this will be formBridge itself. Validation errors will be checked.
  }

//--------------------------------------------------------------------------------------------------

//Example 2: FormBridge.submitForm
  function SubmitForm() {
    var suc = function(obj) {
             var data = obj.data;
         // submit the data to a url;
            }
    var err = function(obj) {
           while(var t = obj.getNextMessage()) {
         $("#errorDiv").append("<div>"+t.message+"</div>");
           }
           }
    formBridge.submitForm({success:suc,error:err}); // not passing a context means that this will be formBridge itself. Validation errors will be checked.
  }

Business.Adobe.com-bronnen

Content Insights Auto Form Fill Cms Cloud Embedded Charts Theme Editor Customer Experience Management