« Zurück zu Produkt

Dokumentation

Feedback senden!

Button

Ein Button der bei Betätigung eine Aktion ausführt.

Beispiel

Parameter

Parameter Beschreibung
caption Sichtbare Beschriftung des Buttons
confirm (optional) (default: "") Beinhaltet dieser Parameter keinen leeren String, so wird bei Betätigung des Buttons der Text in einem Ja/Nein-Dialog angezeigt. Die onClick-Aktion wird nur ausgeführt, falls der Dialog mit "Ja" bestätigt wird. Ist der Parameter leer, so wird die Aktion direkt ausgeführt. (ab IP-Symcon 5.0)
download (optional) (default: "") Ist dieser Parameter nicht leer und beinhaltet die Ausgabe des onClick-Skriptes eine Data-URL, so wird die Rückgabe als Textdatei mit dem Namen das download-Parameters heruntergeladen. (ab IP-Symcon 7.0)
enabled (optional) (default: true) Bei true kann der Button verwendet werden, ansonsten wird er deaktiviert dargestellt (ab IP-Symcon 5.2)
label Name und sichtbare Beschriftung des Buttons (veraltet, nicht änderbar)
link (optional) Ist dieser Parameter true, dann wird die Ausgabe des onClick-Skriptes als Link geöffnet. Ist er false, so wird die Ausgabe als Dialog im Konfigurationsformular angezeigt. Ist der Parameter nicht gesetzt, dann wird auf Basis der Ausgabe entschieden, ob diese als Link geöffnet oder im Dialog angezeigt wird (siehe Infobox). (ab IP-Symcon 5.1)
name (optional) Name des Buttons
onClick Skript, welches bei einem Klick auf den Button ausgeführt wird. Sofern das Skript aus mehreren Zeilen besteht, können die einzelnen Zeilen auch als Array übergeben werden (Arrays werden ab Version 6.0 unterstützt). Es sind keine PHP-Tags erforderlich. Es stehen einige weitere Variablen zur Verfügung, welche im Infofeld weiter unten erörtert werden.
type Button
visible (optional) (default: true) Bei true ist der Button sichtbar, ansonsten ist er unsichtbar (ab IP-Symcon 5.2)
width (optional) Feste Breite des Buttons in Pixel oder % als String, z.B. "40%" oder "250px". Ist der Wert nicht gesetzt oder "", wird die Breite automatisch auf Basis der Beschriftung gewählt (ab IP-Symcon 5.2)
Warning

Die Variable $id steht in allen Bereichen zur Verfügung. Zusätzlich werden für alle Formularfelder Variablen erstellt, sofern ein Name vergeben wurde. Die Variable ist dann entsprechend als $Name nutzbar.

Warning

Steht in dem Parameter onClick ein "echo" in Kombination mit 'http'/'https' wird der Browser geöffnet und die URL aufgerufen. Ist ein "echo" in Kombination mit einem 'mailto:' vorhanden wird das Standard-Mailprogramm mit allen gesetzten Parametern geöffnet (Verfügbar ab IP-Symcon 4.1)

Beispiel

//Das Beispiel gibt die InstanzID zurück.
    { "type": "Button", "caption": "An", "onClick": "echo $id;" }

    //Sonderbeispiel:
    //Das Beispiel öffnet bei "Klick" den Browser mit der angegebenen Adresse: 'https://www.symcon.de'
    {
        "type": "Button",
        "caption": "Symcon",
        "onClick": "echo 'https://www.symcon.de';"
    }

    //Das Beispiel fragt, ob der Wert einer Variablen tatsächlich auf 0 gesetzt werden soll
    {
        "type": "Button",
        "caption": "Reset",
        "onClick": "SetValue(12345, 0);",
        "confirm": "Dies setzt die Variable zurück auf 0. Dabei können wichtige Daten verloren gehen. Sind Sie sicher?"
    }

    //Das Beispiel führt ein mehrzeiliges Skript aus
    {
        "type": "Button",
        "caption": "Reset",
        "onClick": [
            "SetValue(12345, 0);",
            "echo 'Wert wurde zurückgesetzt';"
        ]
    }
Haben Sie noch Fragen?