Create Block Masks

Create customized appearance, create user–defined interface, encapsulate logic, and hide data for subsystems and custom blocks

Simulink^® enables you to create block masks. A mask is a custom user interface for a block.

By masking a block you encapsulate the block diagram to have its own parameter dialog box with its own block description, parameter prompts, and help texts.

You can mask an independent custom block that you can reuse as unique blocks like those defined in Simulink.

To know about creating a block mask, see Create a Simple Mask.

Classes

expand all

Mask Parameters and Constraints

`Simulink.Mask`	Control masks programmatically
`Simulink.Mask.Constraints`	Create mask parameter constraint
`Simulink.Mask.PortConstraints`	Create mask port constraints programmatically (Since R2022a)
`Simulink.Mask.ParameterCondition`	Create mask parameter conditions (Since R2022a)
`Simulink.Mask.PortConstraintRule`	Create instance of `Simulink.Mask.PortConstraintRule` to define rules of port constraint (Since R2022a)
`Simulink.Mask.PortIdentifier`	Create port identifiers to identify ports of block in mask object (Since R2022a)
`Simulink.Mask.CrossPortConstraints`	Creates cross-port constraint among ports of the same masked block (Since R2023a)
`Simulink.Mask.SharedConstraintFile`	Constraints that needs to be saved in an XML file (Since R2023a)
`Simulink.MaskParameter`	Control mask parameters programmatically
`Simulink.Mask.EnumerationBase`	Derive an enumeration class to hold numeric values of any datatype (Since R2021a)
`Simulink.Mask.EnumerationTypeOptions`	Parse information from enumeration file derived from `Simulink.IntEnumType` and `Simulink.Mask.EnumerationBase` (Since R2021a)

Dialog Control Elements

`Simulink.dialog.Control`	Create instance of dialog control
`Simulink.dialog.Button`	Create instance of button dialog control
`Simulink.dialog.Hyperlink`	Create instance of hyperlink dialog control
`Simulink.dialog.Image`	Manage image dialog control
`Simulink.dialog.Text`	Manage text dialog control
`Simulink.dialog.ListboxControl`	Control list box programmatically (Since R2019a)
`Simulink.dialog.parameter.Control`	Create a parameter dialog control
`Simulink.dialog.parameter.CustomTable`	Create custom tables programmatically
`Simulink.dialog.TreeControl`	Control Tree control programmatically
`Simulink.dialog.LookupTableControl`	Control mask lookup tables programmatically (Since R2021b)
`Simulink.dialog.LookupTableControl.Table`	Control table data for mask lookup table (Since R2021b)
`Simulink.dialog.LookupTableControl.Breakpoints`	Control breakpoint data set for mask lookup table (Since R2021b)
`Simulink.dialog.Container`	Create instance of container dialog control
`Simulink.dialog.Group`	Create instance of group dialog control
`Simulink.dialog.Panel`	Create instance of panel dialog control
`Simulink.dialog.Tab`	Create instance of tab dialog control
`Simulink.dialog.TabContainer`	Create instance of tab container dialog control

Topics

Introduction to Masking

Masking Fundamentals
Learn the basics about masking and when to mask blocks.
Create a Simple Mask
You can mask a block interactively by using the Mask Editor or mask it programmatically.
Manage Existing Masks
View or edit an existing block mask.

Mask Editor User Interface

Mask Editor Overview
Create and customize masks using the Mask Editor interface.
Specify Data Types Using DataTypeStr Parameter
Add data type constraint for an Edit mask parameter.
Design a Mask Dialog Box
Try this example to create a mask dialog box and understand the use of some Mask Editor features.
Handling Large Number of Mask Parameters
Add large number of mask parameters in a Table programmatically.
Customize Tables for Masked Blocks
Add custom tables to mask dialog box.
Control Custom Table Programmatically
Use a programmatic interface to control custom tables.
Control Masks Programmatically
Simulink® defines a set of parameters that help in setting and editing masks.

Masking Features

Validating Mask Parameters Using Constraints
Add validation to mask parameters using constraints.
Custom Constraint for Mask Parameter
A mask can contain parameters that accept user input values.
Share Parameter Constraints Across Multiple Block Masks
This example shows how to create a parameter constraint and share it across masks of different blocks in the same model or different models.
Validate Input and Output Port Signals Using Port Constraints
You can validate compile-time signal attributes on the input and output ports of a masked block by using port constraints.
Validate Port Signals Among Ports of the Same Masked Block
This example shows how to create cross port constraints to validate compile-time signal attributes among ports of the same masked block.
Mask Callback Code
Add and execute mask callback code.
Initialize Mask
Use MATLAB^® code to initialize a block mask.
Promote Block Parameters on a Mask
Blocks and subsystems can have multiple parameters associated with them.
Pass Values to Blocks Under the Mask
Specify input values using the mask dialog box.
Mask Linked Blocks
Add custom interface to linked blocks.
Approaches to Control Active Variant Choice of a Variant Block Using Mask or Model Workspace
This example shows different approaches to control the active choice of inline variant and Variant Subsystem blocks from a mask or a model workspace.
Define Measurement Units for Masked Blocks
Set measurement units for output and input ports of a masked block.
Add Images in Masks
Add images as mask icons and save them in the SLX file.
Create Hierarchical List in Mask Dialog
Create a hierarchical list of data on a mask.
Tune Mask Enumeration Parameters - Popup and Radio Button
Reference external enumeration file to assign numerical values to popup parameter.
Visualize and Plot N-Dimensional Data Using Mask Lookup Table Control
Use a lookup table to evaluate a sampled representation of a function using simple lookup operations.
Preserve Tunability of Parameters That Are Modified or Created in Mask Initialization
A desirable feature of code generated from a model is the ability to tune variables to different values.

Graphical Icon Editor

Graphical Icon Editor Overview
Create and edit mask icon of a block in a graphical environment.
Create and Edit Block Mask Icon
Create block mask icon using Graphical Icon Editor and Mask Drawing commands.
Add Dynamic Behavior to Masked Icons
Using Graphical Icon Editor, you can add dynamic behavior to masked block icons:

Mask Callbacks

Organize Mask Initialization and Callbacks in a MATLAB File
You can organize mask initialization and mask callback code in a separate MATLAB® class file.
Dynamic Mask Dialog Box
You can create dialogs for masked blocks whose appearance changes in response to user input.
Dynamic Masked Subsystem
Create masked library blocks that can modify their structural contents.
Debug Masks That Use MATLAB Code
Troubleshoot errors in the mask initialization code.

System Mask

Introduction to System Mask
Learn about masking a model.
Control Masks Programmatically
Simulink® defines a set of parameters that help in setting and editing masks.
Create and Reference a Masked Model
Mask a model interactively.
Create and Display System Mask Programmatically
You can apply a system mask to a model or a subsystem block diagram.

Example Models

Masking Example Models
View Simulink models that demonstrate masking capabilities.

Related Information

Featured Examples

Promote Block Parameters on a Mask

Blocks and subsystems can have multiple parameters associated with them. Block masks allow you to expose one or more of these parameters while hiding others from view. You can promote any underlying parameter of a block either to a block mask or to a subsystem mask. For any subsystem, you have a single view of all the nested blocks, the block parameters, and internal parameters. You can click on any node to access any promotable parameter within the nested blocks. By promoting parameters from the block dialog box to the mask you can:

Open Script

Tune Mask Enumeration Parameters - Popup and Radio Button

Reference external enumeration file to assign numerical values to popup parameter.

Open Script

Organize Mask Initialization and Callbacks in a MATLAB File

You can organize mask initialization and mask callback code in a separate MATLAB® class file. By using a separate MATLAB file you can:

Open Model