Options
Menu

Namespace Common

Index

Functions

Functions

ajaxAppVTL

  • ajaxAppVTL(vtlFile: string, settingsAjax: IxAjaxSettings, appContext: HTMLElement | UpObject): Promise<any, any, any>

  • Sends a request to the provided application resource .vm-file underneath internal/application/resource/APPGUID/.

    example

    JSON

    ajaxAppVTL("test.vm", {
   dataType: "json",
   success: function(dataJSON) {
      // e.g. dataJSON response is:
      // {"myobject":{"property1":"propertyValue1"}}
      alert(dataJSON.myobject.property1);
  }
}, ix.util.getHtml("<GUID>"));
    example

    Text

    ajaxAppVTL("test.vm", {
   dataType: "text",
   data: {
          fr_param1: Browser.getValue(ix.util.getHtml("<GUID_FROM_FIELD>"))
   },
   success: function(data) {
      Browser.setValue(ix.util.getHtml("<GUID_STATIC_TEXTFIELD>"), data);
   }
}, ix.util.getHtml("<GUID_FROM_ANY_FIELD>"));

    Parameters

    • vtlFile: string

      Path to the application .vm-file - .vmi are not reachable.

    • settingsAjax: IxAjaxSettings

      Ajax settings e.g. {dataType: 'json'}, http://api.jquery.com/jQuery.ajax/, additional intrexx properties: urlParameters

    • appContext: HTMLElement | UpObject

      The upFuncPart or any HTMLElement of the application page.

    Returns Promise<any, any, any>

ajaxVTL

  • ajaxVTL(vtlFile: string, settingsAjax: IxAjaxSettings, appContext: HTMLElement | UpObject): Promise<any, any, any>

  • Sends a request to the provided .vm-file.

    example

    JSON

    ajaxVTL("internal/system/vm/custom/test.vm", {
    dataType: "json",
    urlParameters: {
        "rq_Name1": "value1",
        "rq_Name2": "value2"
    },
    success: function(dataJSON){
        // e.g. dataJSON response is:
        // {"myobject":{"property1":"propertyValue1"}}
        alert(dataJSON.myobject.property1);
    }
});

    Parameters

    • vtlFile: string

      Path to the .vm-file - .vmi are not reachable.

    • settingsAjax: IxAjaxSettings

      Ajax settings e.g. {dataType: 'json'}, http://api.jquery.com/jQuery.ajax/, additional intrexx properties: urlParameters

    • appContext: HTMLElement | UpObject

      The upFuncPart or any HTMLElement of the application page.

    Returns Promise<any, any, any>

getDateObject

  • getDateObject(ctrl: UpObject): Date

  • Creates an JavaScript Date from a html control.

    example
    getDateObject(ix.util.getHtml("A84E5E7F9EA9ED1A829DB98DBF5459F59961FA3B"));

    Parameters

    • ctrl: UpObject

      Reference to a html input control of types "date", "time" or "date & time".

    Returns Date

getNumberObject

  • getNumberObject(ctrl: UpObject): number

  • Creates an JavaScript Number from a html control.

    example
    getNumberObject(ix.util.getHtml("5F7S5E7F9EA9ED1A829DB98DBF5459F59961FA3B"));

    Parameters

    • ctrl: UpObject

      Reference to a html input control of types "integer", "double" or "currency".

    Returns number

inking

  • inking(control: UpObject, op: string, comp: string, color: string, colored: string): void

  • Colors rows and cells in a viewtablecontrol depending on a number value.

    example
    inking("viewcontrolD54BA2DD", ">", 10, "#008000", "row");

    Parameters

    • control: UpObject

      Name of control, whose value should be checked (name from expert page of the column).

    • op: string

      Operator

    • comp: string

      Value to compare with.

    • color: string

      Value of color (hexadecimal or name)

    • colored: string

      Possible values: "row": whole row (tr), "cell": whole cell (td), "span": text of cell (span).

    Returns void

inkingDate

  • inkingDate(control: UpObject, op: string, type: string, color: string, colored: string): void

  • Colorizes date or datetime values in a viewtablecontrol depending on today.

    see

    inking

    Parameters

    • control: UpObject

      Id of control, whose value should be checked, without prefix "ID_".

    • op: string

      Operator

    • type: string

      Compare either against today as "date" or today as "datetime". Default: ""

    • color: string

      Value of color (hexadecimal or name)

    • colored: string

      Possible values: "row": whole row (tr), "cell": whole cell (td), "span": text of cell (span).

    Returns void

inkingString

  • inkingString(control: UpObject, op: string, comp: string, color: string, colored: string): void

  • Colorizes strings in a viewtablecontrol depending on a number value.

    see

    inking

    Parameters

    • control: UpObject

      Name of control, whose value should be checked (name from expert page of the column).

    • op: string

      Operator

    • comp: string

      Value to compare with.

    • color: string

      Value of color (hexadecimal or name)

    • colored: string

      Possible values: "row": whole row (tr), "cell": whole cell (td), "span": text of cell (span).

    Returns void

triggerUserWorkflowEvent

  • triggerUserWorkflowEvent(eventGuid: string, urlParameters: object, ajaxParameters: object): Promise<[]>

  • Triggers an User Workflow Event, which is always a POST-Request.

    example

    Trigger event with guid <EVENTGUID>.
    Define a generic event handler with the class de.uplanet.lucy.server.workflow.eventhandler.UserWorkflowEventHandler before.

    triggerUserWorkflowEvent("<EVENTGUID>", {"param1":"value1","param2":"value2"}, {"async": true});
    example
    $.when(triggerUserWorkflowEvent("<EVENTGUID>", {"param1":"value1", "param2":"value2"}, {"async": true}))
    .done(function() {
       alert("done");
    })
    .fail(function() {
       alert("failed :(");
    });

    Parameters

    • eventGuid: string

      The parameter eventGuid of the generic event handler.

    • urlParameters: object

      An object containing name value pairs, which will be part of the Query-String.

    • ajaxParameters: object

      An object containing synchronous mode.

    Returns Promise<[]>