Skip to content

[WTF-2679] Update docs for removed deprecation on file/image properties #11328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mlaponder wants to merge 2 commits into
base: development
Choose a base branch
from
Open

[WTF-2679] Update docs for removed deprecation on file/image properties #11328

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f65148c
Remove deprecation for file/image property without allowUpload
mlaponder Jun 9, 2026
081720f
Add introduced alert for allowUpload
mlaponder Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions ...sdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-property-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ This defines the prop `key` in the client component props which are supplied to

#### AllowUpload (Optional) {#allow-upload}

This optional attribute applies only to [file](#file) and [image](#image) properties and determines whether users can upload and edit files. When set to the default value of `false`, properties use the legacy read-only behavior. Setting it to `true` unlocks upload and edit capabilities by passing `EditableFileValue<FileValue>` and `EditableImageValue<ImageValue>` types, as props to a client component.
{{% alert color="info" %}}
Introduced in Mendix 11.8. Support for native widgets was introduced in Mendix 11.11.

@weirdwater weirdwater Jul 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link to the release note pages?

  • [11.8](/releasenotes/studio-pro/11.8/)
  • [11.11](/releasenotes/studio-pro/11.11/)

{{% /alert %}}

{{% alert color="warning" %}} Legacy DynamicValue types for file and image properties are deprecated and will be removed at Mendix 12. Use allowUpload="true" to migrate to the new editable types before Mendix 12. {{% /alert %}}
This optional attribute applies only to [file](#file) and [image](#image) properties and determines whether users can upload and edit files. When set to the default value of `false`, properties use read-only behavior. Setting it to `true` unlocks upload and edit capabilities by passing `EditableFileValue<FileValue>` and `EditableImageValue<ImageValue>` types, as props to a client component.

Be aware of behavioral differences between the legacy read-only mode (`false`) and the new editable mode (`true`).
Be aware of behavioral differences between the read-only mode (`false`) and the editable mode (`true`).

#### Type (Required)

Expand Down Expand Up @@ -269,9 +271,7 @@ Then the Studio Pro UI for the component appears like this:

Image allows a user to configure an image from an object that is a specialization of **System.Image**. It is passed as an [`EditableImageValue<ImageValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-image-value) prop to a client component. For more information about supported image formats, see the [Images Reference Guide](/refguide/images/).

The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the legacy [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.

{{% alert color="warning" %}} Legacy DynamicValue types for file and image properties are deprecated and will be removed at Mendix 12. Use allowUpload="true" to migrate to the new editable types before Mendix 12. {{% /alert %}}
The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.

#### XML Attributes

Expand Down Expand Up @@ -708,9 +708,7 @@ Then the Studio Pro UI for the property appears like this:

The file property type allows a user to configure and edit a file from and to an object that is a specialization of **System.File**. It is passed as a [`EditableFileValue<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-file-value) prop to a client component.

The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the legacy [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.

{{% alert color="warning" %}} Legacy DynamicValue types for file and image properties are deprecated and will be removed at Mendix 12. Use allowUpload="true" to migrate to the new editable types before Mendix 12. {{% /alert %}}
The user can use the optional attribute [`allowUpload`](#allow-upload) with default value `false` to use the [`Dynamic<FileValue>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#filevalue) prop. Beware of behavioral differences based on the `allowUpload` attribute.

@weirdwater weirdwater Jul 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to add the introduced infobox here (and for image) as well?


#### XML Attributes

Expand Down
Loading