Class Helper

Helper provides several auxiliary functions for Intrexx.

Deprecated

IMPORTANT: Please do not use these functions anymore since they will be removed in a future release. Use the corresponding functions given in the respective sections instead.

Replacement

Please refer to IxUtil as a replacement.

Hierarchy

  • Helper

Methods

containsQsParam deleteCookie deleteParamFromQs deleteParamFromUrl doCharStuffing getBaseUrl getCookieValueByParam getFupId getQsValueByParam getQsValues getUrlValueByParam getUrlValues hexDecodeString hexEncodeString htmlEncode isCookieEnabled mergeQueryStrings setCookie setQsValueByParam setUrlValueByParam trim undoCharStuffing

Methods

containsQsParam

  • Searches for a parameter in a querystring.

    Parameters

    • param: string
    • queryString: string

    Returns boolean

    Deprecated

    Please use ix.util.containsParam instead!

deleteCookie

  • Remove a cookie parameter.

    Parameters

    • param: string

    Returns boolean

    Deprecated

    Please use ix.cookie.deleteCookie instead!

deleteParamFromQs

  • Removes parameter from a querystring.

    Parameters

    • param: string
    • Optional queryString: string

      Default: window.location

    Returns string | boolean

    url

    Deprecated

    Please use ix.util.deleteParamFromQs instead!

deleteParamFromUrl

  • Removes parameter from an url.

    Parameters

    • param: string
    • url: string

    Returns string

    url

    Deprecated

    Please use ix.util.deleteParamFromUrl instead!

doCharStuffing

  • Transforms an Array to a string.
    || is the separator where | as escaped with |0.

    Parameters

    • list: any[]

    Returns string

    Deprecated

    Please use ix.util.doCharStuffing instead!

getBaseUrl

  • Get base url.

    Parameters

    • Optional path: string

      path e.g. folder/file.vm

    Returns string

    Deprecated

    Please use ix.util.getBaseUrl instead!

getCookieValueByParam

  • Retrieve value of a cookie parameter.

    Parameters

    • param: string
    • Optional fallback: string

    Returns string | boolean

    Deprecated

    Please use ix.cookie.getValue instead!

getFupId

  • Get the GUID or ID of functional part, where given element is part of, otherwise empty string.

    Parameters

    • element: UpObject | HTMLElement

    Returns undefined | null | string

    Deprecated

    Please use ix.util.getFuncPart instead!

getQsValueByParam

  • Get value of a url querystring parameter.

    Parameters

    • param: string
    • Optional queryString: string

      Default: window.location

    Returns undefined | string

    Deprecated

    Please use ix.util.getQsValue instead!

getQsValues

  • Get Object with url querystring parameters or false if none found.

    Parameters

    • queryString: string

    Returns false | StringMap

    Deprecated

    Please use ix.util.getQsValues instead!

getUrlValueByParam

  • Get value of a url querystring parameter or false if none found.

    Parameters

    • param: string
    • Optional url: string

      Default: window.location

    Returns undefined | string

    Deprecated

    Please use ix.util.getQsValue instead!

getUrlValues

  • Get Object with url querystring parameters or false if none found.

    Parameters

    • url: string

    Returns false | StringMap

    Deprecated

    Please use ix.util.getQsValues instead!

hexDecodeString

  • Decodes a hexadecimal to UTF-8-String.

    Parameters

    • Optional value: string

    Returns string

    Deprecated

    Please use ix.text.hexDecode instead!

hexEncodeString

  • Encodes an UTF-8-String to hexadicmal.

    Parameters

    • Optional value: string

    Returns string

    Deprecated

    Please use ix.text.hexEncode instead!

htmlEncode

  • Encodes particular html characters.

    Parameters

    • html: string
    • Optional insertNbsp: boolean

      Shall " " (space) with   be replaced. Default: false

    • Optional insertBr: boolean

      Shall \n with <br> be replaced. Default: false

    Returns string

    Deprecated

    Please use ix.util.htmlEncode instead!

isCookieEnabled

  • Check, if cookies are enabled.

    Returns boolean

    Deprecated

    Please use navigator.cookieEnabled instead (see Navigator - Web API)!

mergeQueryStrings

  • Merges two query-strings.

    Parameters

    • Optional string1: string

      Default: ""

    • Optional string2: string

      Default: ""

    Returns string

    Deprecated

    Please use ix.util.mergeQueryStrings instead!

setCookie

  • Changes or adds a cookie parameter.

    Parameters

    • param: string

      New cookie parameter or parameter to change.

    • Optional value: string
    • Optional expires: boolean

      Shall expire 365 days from now.

    • Optional timeOut: number

      Time in ms to be added to current year. Overrides expires.

    Returns boolean

    Deprecated

    Please use ix.cookie.setValue instead!

setQsValueByParam

  • Changes value of a url querystring parameter. Adds parameter, if not exists already.

    Parameters

    • param: string
    • Optional value: string

      Default: ""

    • Optional queryString: string

    Returns string

    url

    Deprecated

    Please use ix.util.setQsValue instead!

setUrlValueByParam

  • Changes value of a url querystring parameter.
    Adds parameter, if not exists.

    Parameters

    • param: string
    • Optional value: string

      Default: ""

    • Optional url: string

      Default: window.location

    Returns string

    url

    Deprecated

    Please use ix.util.setQsValue instead!

trim

  • Trim left and right whitespaces from a string.

    Parameters

    • value: string

    Returns string

    Deprecated

    Please use String.prototype.trim() instead!

undoCharStuffing

  • Splits a string to an Array.
    || is used as separator, while |0 is unescaped to |.

    Parameters

    • input: string

    Returns string[]

    Deprecated

    Please use ix.util.undoCharStuffing instead!

Settings

Member Visibility

Theme

On This Page