Simulink.Mask.set

Set properties of an existing mask

Syntax

maskObj.set(Name,Value)

Description

maskObj.set(Name,Value) sets mask properties that you specify using name–value pairs as arguments.

To get the mask object for the mask on a block named BlockName, use this command.

maskObj = Simulink.Mask.get("BlockName")

Examples

Set properties of an existing masked block

Get mask as an object using a masked block’s path.

maskObj = Simulink.Mask.get('setparameter/Subsystem');

Modify the mask so that its mask icon is transparent and its documentation summarizes what it does.

maskObj.set('IconOpaque','off','Type','Random number generator',...
'Description','This block generates random numbers.');

Input Arguments

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: maskObj.set('IconOpaque','off','Type','Random number generator',... 'Description','This block generates random numbers.');

Type — Mask type of block

character vector | string

Mask type of the associated block is specified as a character vector or string.

Data Types: char | string

Description — Description of block

character vector | string

Description of the block, specified as a character vector or string.

Data Types: char | string

Help — Help text for the masked block

character vector | string

Help text for the masked block, specified as a character vector or string.

Data Types: char | string

Initialization — Initialization commands

character vector | string

Initialization commands for the masked block, specified as a character vector or string.

Data Types: char | string

SelfModifiable — Option to allow block to modify its contents

off (default) | on

Option to allow the block to modify its contents, specified as a logical.

Data Types: logical

Display — MATLAB^® code for block icon

character vector | string

MATLAB code for the block icon, specified as a character vector or string.

Data Types: char | string

IconFrame — Visibility of block frame

off (default) | on

Visibility of the block frame, specified as a logical value.

Data Types: logical

IconOpaque — Option to make the icon opaque

opaque (default) | transparent

Option to make the icon opaque, specified as a logical.

• Opaque: Make the icon opaque.

• Transparent: Make the icon transparent.

Data Types: string | char

RunInitForIconRedraw — Option to run initialization before executing drawing commands

auto (default) | on | off

Option to run mask initialization commands before executing the mask icon commands, specified as enumerated data type.

Data Types: enum

IconRotate — Option to rotate icon with block

none (default) | port

Option to rotate icon along with block, specified as enumerated data type.

Data Types: enum

PortRotate — Port rotation type

default (default) | physical

Port rotation type, specified as enumerated data type. Set this property to default to reorder ports after a clockwise rotation to maintain a left-to-right port numbering order for ports along the top and bottom of the block and a top-to-bottom port numbering order for ports along the left and right sides of the block. Set this property to physical to rotate ports with the block without reordering them after a clockwise rotation.

Data Types: enum

IconUnits — Units for drawing commands

autoscale (default) | pixels | normalized

Units for drawing commands, specified as enumerated type. autoscale scales the icon to fit the block frame. normalized draws the icon within a block frame whose bottom-left corner is (0,0) and whose top-right corner is (1,1). Only X and Y values from 0 through 1 appear. When the block is resized, the icon is also resized. pixels draws the icon with X and Y values expressed in pixels. The icon is not automatically resized when the block is resized.

Data Types: enum

SaveCallbackFileWithModel — Option to save callback file along with the model

off (default) | on

Use this option to save the callback file along with the model, if you have mask initialization code and callback code in a separate MAT file, specified as a logical value.

Data Types: logical

Callbackfile — Name of callback file

empty (default) | character vector | string

Name of the callback file containing the mask initialization code and callback code, specified as a character vector or string.

Data Types: char | string

Parameters — Mask parameter properties

Simulink.MaskParameterobject

Mask parameter properties, specified as a Simulink.MaskParameter object.

Data Types: object

PortIdentifiers — Port identifier properties

Simulink.Mask.PortIdentifiers object

Port identifier properties, specified as a Simulink.Mask.PortIdentifiers object.

Data Types: object

ParameterConstraints — Parameter constraints properties

Simulink.Mask.Constraints object

Option to add or remove parameter constraint rule, specified as a Simulink.Mask.Constraints object.

Data Types: object

CrossParameterConstraints — Constraints between parameters

Simulink.Mask.CrossParameterConstraints object

Constraints between parameters, specified as Simulink.Mask.CrossParameterConstraints object.

Data Types: object

PortConstraints — Port constraints properties

Simulink.Mask.PortConstraint object

Option to add or remove port constraints, specified as a Simulink.Mask.PortConstraint object.

Data Types: object

CrossPortConstraints — Cross port constraints properties

Simulink.Mask.CrossPortConstraint object

Option to add or remove constraints on ports of the masked block, specified as a Simulink.Mask.CrossPortConstraint object.

Data Types: object

Version History

Introduced in R2014a