Edit on Github

Static commands

Static commands are a very powerful way to manipulate with the viewmodel on the client-side. In contract to commands, static command doesn't need to send the viewmodel to the server, and in many cases it doesn't even talk to the server.

Static command can call methods on the server. In such case, only the method arguments are sent to the server, and the return value of the method can be used to update some viewmodel properties.

Assign values to properties

You can use static commands to perform simple operations on the viewmodel without making any communication with the server.

It is useful in many simple scenarios, like assigning values into properties.

<dot:Button Text="Something" 
            Click="{staticCommand: SomeProperty = 'Hello ' + Name + '!'}" />

You can put multiple statements in the static command bindings and separate them by the ; operator. If you call a method which can be translated into JavaScript, the entire expression will run locally in the browser.

See the supported expressions page for more information.

Call server methods

Static commands can call methods which are not translated into JavaScript.

The method can be:

Asynchronous methods (returning Task) are supported, but you need to call .Result in the static command binding to access the result.

Static methods

First, you have to declare a static method. It can be in the viewmodel or in any other class.

The method must be static and can accept any number of arguments which are JSON-serializable.

The method must be marked with the AllowStaticCommand attribute. DotVVM needs the methods to be explicitly allowed for static commands; otherwise, anyone would be able to call any static method (e.g. File.Delete) with any arguments.

Optionally, the method can return a result.

[AllowStaticCommand]
public static string MyMethod(string name)
{
    // ...
    return result;
}

Be careful. There is no way for DotVVM to determine whether the arguments passed to the command weren't tampered with. Always validate that the values are correct and that the user has appropriate permissions to perform the operation.

The binding expression in the page looks like this:

<dot:Button Text="Something" Click="{staticCommand: MyClass.MyMethod(SomeArg)}" />

Also, you may want to use the method result to update some viewmodel property.

<dot:Button Text="Something" Click="{staticCommand: SomeProperty = MyClass.MyMethod(SomeArg)}" />

If the MyClass is not in the same namespace as the viewmodel, use the @import directive.

Static command service methods

Since the static methods cannot use dependency injection, we recommend using static command services instead of static methods.

JavaScript methods

If you import a view module using the JS directive, you can call exported methods using the _js.Invoke method:

<dot:Button Text="Call JS method" Click="{staticCommand: SomeProperty = _js.Invoke<string>("myMethod", SomeArg, ...)}" />

REST API methods

See REST API bindings for more information.

See also