Using The UpdateContext Function In Power Apps

Using The UpdateContext Function In Power Apps

For any none trivial application you will need to manage variables used to store and manipulating data within your app.

In this blog post, we’ll focus on the UpdateContext function, which is used to create and update context variables in a Canvas App.

What is the UpdateContext Function?

The UpdateContext function is used to create or update context variables – which are defined as temporary variables that are scoped to a single screen, meaning they cannot be accessed from other screens within the app.

This makes them ideal for storing data that is only relevant to a specific part of your application or where you need a limited variable lifespan.

Syntax and Usage

To use the UpdateContext function, you pass a single record that specifies the name of the variable and the value you want to assign to it, this will yield one of 2 behaviours

• If the variable already exists, its value will be updated
• If it doesn’t, a new variable will be created.

Here is the basic syntax:

UpdateContext({ VariableName: Value })

For example, to create a context variable named ShowLoader and set its value to true, you would use the following formula:

UpdateContext({ ShowLoader : true })

This context variable can then be used to make your application dynamic and respond to user interactions. In our example we can use this to Toggle visibility of a loading message to the user.

When to Use UpdateContext

Its important to call out the differences between the Set and UpdateContext functions and this comes down to the scope of the variable you need.

Use the Set function for global variables that need to be accessible across the entire app. Use UpdateContext for variables that are only needed on a single screen and information does not need to be persisted beyond that page.

Best Practices

1. Memory Efficiency: Context variables are more memory-efficient because they are cleared when the user leaves the screen, Thus reducing the resources needed by the app and ensuring the app is only taking up the memory it needs.

2. Simplify Your App: Using context variables can make your app easier to understand and maintain by keeping the scope of variables limited to where they are needed, thus prompting the developer to create a clear separation of concerns within the application.

3. Avoid Overuse: Like anything too much of a good thing can be bad and that’s the case of context variables. If used in the wrong situation this can lead to a lot of repetition or added complexity to the app if implemented poorly. Actively review if Context or Global variable is

Practical Example

Let’s consider a practical example where you want to display the loading message when a button is clicked. You can use the UpdateContext function to manage the visibility of the dialog box.

1. Create a Button: Add a button control to your screen and set its OnSelect property to the following formula:
UpdateContext({ ShowLoader: true })

2. Create a Loader Message: Add a container control to represent the loader and set its Visible property to ShowLoader.

3. Hide the Message: Add a hide button on the loading screen (to simulate completion of the loading event) and set its OnSelect property to:
UpdateContext({ ShowLoader: false })

This setup ensures that the loader is only visible when the ShowLoader variable is true, and it can be closed by setting the variable to false.

Additional Details about Context Variables

Context variables can hold various types of information, including single values, records, tables, object references, and any result from a formula.

This flexibility allows you to use context variables for a wide range of purposes within your app.

There is no explicit declaration required of a context variable as UpdateContext handle declaration and assignation in a single operation.

If you remove all references to a context variable, it will cease to exist. To clear a variable, you can set its value to the result of the Blank function.

You can view your variables’ values, definitions, and uses with the Variables view under the File menu in the authoring environment. This feature helps you keep track of your variables and manage them effectively.

Trusted by Leading Brands

“We work with organisations across many sectors of different shapes and sizes from 10 to 100,000 employees.”

Contact Form

Contact our team today!