API:er för Form Bridge för HTML5-formulär form-bridge-apis-for-html-forms

CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.

Du kan använda API:erna för Form Bridge för att öppna en kommunikationskanal mellan ett XFA-baserat HTML5-formulär och dina program. API:erna för Form Bridge innehåller en koppla API för att skapa anslutningen.

The koppla API accepterar en hanterare som ett argument. När en lyckad anslutning har skapats mellan XFA-baserade HTML5-formulär och Form Bridge anropas handtaget.

Du kan använda följande exempelkod för att skapa anslutningen.

// Example showing how to connect to FormBridge
window.addEventListener("FormBridgeInitialized",
                                function(event) {
                                    var fb = event.detail.formBridge;
                                    fb.connect(function() {
                                           //use form bridge functions
                         })
                            })
NOTE
Se till att du skapar en anslutning innan du inkluderar filen formRuntime.jsp.

Tillgängligt API för Form Bridge  available-form-bridge-api-nbsp

getBridgeVersion()

Returnerar versionsnumret för skriptbiblioteket

  • Indata: Ingen
  • Utdata: Versionsnummer för skriptbiblioteket
  • Fel: Ingen

isConnected() Kontrollerar om formulärtillståndet har initierats

  • Indata: Ingen

  • Utdata: True om XFA-formulärtillståndet har initierats

  • Fel: Ingen

connect(handler, context) Skapar en anslutning till FormBridge och kör funktionen när anslutningen har upprättats och formulärstatusen har initierats

  • Indata:

    • hanterare: Funktion som ska köras när Form Bridge är anslutet
    • kontext: Det objekt som kontexten (this) för *handler *-funktionen är inställd på.
  • Utdata: Ingen

  • Fel: Ingen

getDataXML(options) Returnerar aktuella formulärdata i XML-format

  • Indata:

    • alternativ: JavaScript-objekt som innehåller följande egenskaper:

      • Fel: Felhanterarfunktion
      • framgång: Hanterarfunktionen Slutfört. Den här funktionen skickar ett objekt som innehåller XML i data -egenskap.
      • kontext: Det objekt som kontexten (this) för framgång funktionen är inställd
      • validationChecker: Funktion som ska anropas för att kontrollera verifieringsfel som tagits emot från servern. Valideringsfunktionen skickar en array med felsträngar.
      • formState: JSON-tillståndet för XFA-formuläret som data-XML ska returneras för. Om inget anges returneras data-XML för det återgivna formuläret.
  • Utdata: Ingen

  • Fel: Ingen

registerConfig(configName, config) Registrerar användare/portalspecifika konfigurationer med FormBridge. Dessa konfigurationer åsidosätter standardkonfigurationerna. De konfigurationer som stöds anges i avsnittet config.

  • Indata:

    • configName: Namn på konfigurationen som ska åsidosättas

      • widgetConfig: Låter användaren åsidosätta standardwidgetarna i formuläret med anpassade widgetar. Konfigurationen åsidosätts enligt följande:

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

      • pagingConfig: Låter användaren åsidosätta standardbeteendet för återgivning av endast den första sidan. Konfigurationen åsidosätts enligt följande:

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

      • LoggingConfig: Låter användaren åsidosätta loggningsnivån, inaktivera loggning för en kategori eller visa loggkonsolen eller skicka till servern. Konfigurationen kan åsidosättas på följande sätt:

      code language-css
      formBridge.registerConfig{
        "LoggerConfig" : {
      {
      "on":`<true *| *false>`,
      "category":`<array of categories>`,
      "level":`<level of categories>`, "
      type":`<"console"/"server"/"both">`
          }
        }
      
      • SubmitServiceProxyConfig: Tillåt användarna att registrera insändning och inloggningstjänster för proxy.

        code language-css
        window.formBridge.registerConfig("submitServiceProxyConfig",
        {
        "submitServiceProxy" : "`<submitServiceProxy>`",
        "logServiceProxy": "`<logServiceProxy>`",
        "submitUrl" : "`<submitUrl>`"
        });
        
    • config: Konfigurationens värde

  • Utdata: Objekt som innehåller det ursprungliga värdet för konfigurationen i data -egenskap.

  • Fel: Ingen

hideFields(fieldArray) Döljer de fält vars som innehåller vissa uttryck i fieldArray. Anger egenskapen presence för de angivna fälten till osynlig

  • Indata:

    • fieldArray: Array med vissa uttryck för de fält som ska döljas
  • Utdata: Ingen

  • Fel: Ingen

showFields(fieldArray) Visar de fält vars som innehåller vissa uttryck i fieldArray. Anger egenskapen presence för de angivna fälten till visible

  • Indata:

    • fieldArray: Array med vissa uttryck för de fält som ska visas
  • Utdata: Ingen

  • Fel: Ingen

hideSubmitButtons() Döljer alla skicka-knappar i formuläret

  • Indata: Ingen
  • Utdata: Ingen
  • Fel: Utlöser ett undantag om formulärtillståndet inte har initierats

getFormState() Returnerar den JSON som representerar formulärstatusen

  • Indata: Ingen

  • Utdata: Objekt som innehåller JSON som representerar det aktuella formulärläget i data -egenskap.

  • Fel: Ingen

restoreFormState(options) Återställer formulärläget från det angivna JSON-läget i options-objektet. Läget används och hanterare för lyckade eller fel anropas när åtgärden har slutförts

  • Indata:

    • Alternativ: JavaScript-objekt som innehåller följande egenskaper:

      • Fel: Felhanterarfunktion
      • framgång: Hanterarfunktionen Slutfört
      • kontext: Det objekt som kontexten (this) för framgång funktionen är inställd
      • formState: Formulärets JSON-tillstånd. Formuläret återställs till JSON-läget.
  • Utdata: Ingen

  • Fel: Ingen

setFocus (som) Anger fokus på fältet som anges i SOM-uttrycket

  • Indata: Ett uttryck för fältet som fokus ska ställas in på
  • Utdata: Ingen
  • Fel: Utlöser ett undantag om ett felaktigt SOM-uttryck används

setFieldValue (som, värde) Anger värdet för fälten för de angivna som-uttrycken

  • Indata:

    • som: Array som innehåller vissa uttryck för fältet. Det uttryck som anger fältets värde.
    • värde: Array som innehåller värden som motsvarar "SOM"-uttryck som finns i en som array. Om värdeets datatyp inte är densamma som fieldType ändras inte värdet.
  • Utdata: Ingen

  • Fel: Utlöser ett undantag om ett felaktigt SOM-uttryck används

getFieldValue (som) Returnerar värdet för fälten för angivna som-uttryck

  • Indata: Array som innehåller vissa uttryck av fält vars värde måste hämtas

  • Utdata: Objekt som innehåller resultatet som en array i data -egenskap.

  • Fel: Ingen

Exempel på getFieldValue() API example-of-nbsp-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, egenskap) Hämta listan med värden för den angivna egenskapen i de fält som anges i Vissa-uttryck

  • Indata:

    • som: Array som innehåller vissa uttryck för fälten
    • property: Namn på egenskapen vars värde krävs
  • Utdata: Objekt som innehåller resultatet som array i *data *property

  • Fel: Ingen

setFieldProperties(som, egenskap, värden) Anger värdet för den angivna egenskapen för alla fält som anges i som-uttrycken

  • Indata:

    • som: Array som innehåller vissa uttryck för de fält vars värde måste anges
    • property: Egenskap vars värde måste anges
    • värde: Array som innehåller värden för den angivna egenskapen för fält som anges i som-uttryck
  • Utdata: Ingen

  • Fel: Ingen

Exempel på användning av API:t för Form Bridge sample-usage-of-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.
  }
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da