formcycle 8.5.1 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle NumberFormatApiDo

    Die API zum Ausführen von Aktionen auf NumberFormat-Elementen, wie z.B. das Ändern des Werts oder der Optionen.

    Die API ist über $.xutil.numberFormat.do verfügbar.

    Um etwa den Wert eines Elements zu ändern, kann $.xutil.numberFormat.do.setValue(...) verwendet werden.

    // Setzt den Wert auf 12.34
    $.xutil.numberFormat.do.setValue(".tf1", 12.34);
    interface NumberFormatApiDo {
        changeOptions: (
            reference: any,
            options: Partial<NumberFormatOptions>,
        ) => void;
        setFormattedValue: (
            reference: any,
            newValue: undefined | string | number,
        ) => void;
        setValue: (reference: any, newValue: undefined | string | number) => void;
    }
    Index

    Eigenschaften

    changeOptions: (reference: any, options: Partial<NumberFormatOptions>) => void

    Aktualisiert die Optionen aller angegebenen NumberFormat-Elemente.

    Typendeklaration

      • (reference: any, options: Partial<NumberFormatOptions>): void
      • Parameter

        • reference: any

          Die zu aktualisierenden NumberFormat-Elemente.

        • options: Partial<NumberFormatOptions>

          Die zu aktualisierenden Optionen.

        Rückgabewert void

    // Ändert die Anzahl der Dezimalstellen auf 3
    $.xutil.numberFormat.do.changeOptions(".tf1", { decimalPlaces: 3 });

    Wenn ein Element keine NumberFormat-Instanz hat.

    setFormattedValue: (
        reference: any,
        newValue: undefined | string | number,
    ) => void

    Setzt den Wert aller angegebenen NumberFormat-Elemente auf den angegebenen Wert. Der Wert kann eine Zahl (1234.56) oder eine formatierte Zeichenkette ("1234.56") sein. Wenn eine formatierte Zeichenkette angegeben wird, wird sie entsprechend den aktuellen Formatierungsoptionen geparst.

    Typendeklaration

      • (reference: any, newValue: undefined | string | number): void
      • Parameter

        • reference: any

          Die Elemente, für die der Wert festgelegt werden soll.

        • newValue: undefined | string | number

          Der zu setzende Wert. Verwenden Sie eine leere Zeichenkette oder undefined, um den Wert zu löschen.

        Rückgabewert void

    // Setzt den Wert auf 2000 (wenn das Dezimaltrennzeichen '.' ist)
    $.xutil.numberFormat.do.setFormattedValue(".tf1", "2.000");

    // Leert den Wert
    $.xutil.numberFormat.do.setFormattedValue(".tf1", undefined);

    Wenn ein Element keine NumberFormat-Instanz hat.

    setValue: (reference: any, newValue: undefined | string | number) => void

    Setzt den Wert aller angegebenen NumberFormat-Elemente auf den angegebenen Wert. Der Wert kann eine Zahl (1234.56) oder eine numerische Zeichenkette ("1234.56") sein, aber keine formatierte Zeichenkette (1234·56).

    Typendeklaration

      • (reference: any, newValue: undefined | string | number): void
      • Parameter

        • reference: any

          Das Element, für das der Wert festgelegt werden soll.

        • newValue: undefined | string | number

          Der zu setzende Wert. Verwenden Sie eine leere Zeichenkette oder undefined, um den Wert zu löschen.

        Rückgabewert void

    // Setzt den Wert auf 12,34
    $.xutil.numberFormat.do.setValue(".tf1", 12.34);

    // Leert den Wert
    $.xutil.numberFormat.do.setValue(".tf1", undefined);

    Wenn ein Element keine NumberFormat-Instanz hat.