Simulink Reference Previous page   Next Page

Common Block Parameters

This table lists the parameters common to all Simulink blocks, including block callback parameters (see Using Callback Routines). Examples of commands that change these parameters follow this table (see Examples of Setting Block Parameters).

Common Block Parameters 
Parameter
Description
Values
AncestorBlock

Name of the library block that the block is linked to (for blocks with a disabled link).

string
AttributesFormat
String

String format specified for block annotations in the Block Properties dialog box.

string
BackgroundColor

Block background color.

RGB value array string
BlockDescription

Block description shown in the Block Properties dialog box.

string
BlockType

Block type (read only).

string
ClipboardFcn

Function called when block is copied to the clipboard (Ctrl+C)

string
CloseFcn

Function called when close_system is run on block.

string
CompiledPort
ComplexSignals

Complexity of port signals after updating diagram.


CompiledPortData
Types

Data types of port signals after updating diagram.


CompilePort
Dimensions

Dimensions of port signals after updating diagram.


CompiledPortFrame
Data

Frame mode of port signals after updating diagram.


CompiledPortWidths

Structure of port widths after updating diagram.


CompiledSampleTime

Block sample time after updating diagram.


CopyFcn

Function called when block is copied.

string
DataTypeOverride_
Compiled

For internal use.


DeleteFcn

Function called when block is deleted.

MATLAB expression
DestroyFcn

Function called when block is destroyed.

MATLAB expression
Description

Description of block. Set by the Description field in the General pane of the Block Properties dialog box.

text and tokens
Diagnostics

text and tokens
DialogParameters

Names/attributes of parameters in block's parameter dialog box.

structure
DropShadow

Display drop shadow.

{'off'} | 'on'
ExtModeUpload
Option

{'none'} | 'log' | 'monitor'
ExtModeLogging
Supported

{'off'} | 'on'
ExtModeLogging
Trig

{'off'} | 'on'
FontAngle

Font angle.

'normal' | 'italic' | 'oblique' | {'auto'}
FontName

Font.

string
FontSize

Font size. A value of -1 specifies that this block inherits the font size specified by the DefaultBlockFontSize model parameter.

real {'-1'}
FontWeight

Font weight.

'light' | 'normal' | 'demi' | 'bold' | {'auto'}
ForegroundColor

Foreground color of block's icon.

string {'black'}
Handle

Block handle.

real
HiliteAncestors

{'none'} | 'error' | 'redWhite' | 'blueWhite' | 'greenWhite' | 'orangeWhite' | 'blackWhite' | 'find' | 'debug' | 'unique' | 'different' | 'lineTrace' | 'fade' | 'default' | 'user1' | 'user2' | 'user3' | 'user4' | 'user5'
InitFcn

Initialization function for a masked block.

MATLAB expression
InputPorts

Array of input port locations.

[h1,v1; h2,v2; ...]
InputSignalNames

Names of input signals.

cell array
IOSignalStrings

list
IOType

{'none'} | 'viewer' | 'siggen'
LineHandles

Handles of lines connected to block.

struct
LinkStatus

Link status of block.

{'none'} | 'resolved' | 'unresolved' | 'implicit' | 'inactive' | 'restore' | 'propagate'
LoadFcn

Function called when block is loaded.

MATLAB expression
MinMaxOverflow
Logging_Compiled

For internal use.


ModelCloseFcn

Function called when model is closed.

MATLAB expression
ModelParamTable
Info

For internal use.


MoveFcn

Function called when block is moved.

MATLAB expression
Name

Block name.

string
NameChangeFcn

Function called when block name is changed.

MATLAB expression
NamePlacement

Position of block name.

{'normal'} | 'alternate'
ObjectParameters

Names/attributes of block's parameters.

structure
OpenFcn

Function called when this block's Block Parameters dialog box is opened.

MATLAB expression
Orientation

Where block faces.

{'right'} | 'left' | 'up' | 'down'
OutputPorts

Array of output port locations.

[h1,v1; h2,v2; ...]
OutputSignalNames

Names of output signals.

matrix
Parent

Name of the system that owns the block.

string {'untitled'}
ParentCloseFcn

Function called when parent subsystem is closed.

MATLAB expression
PortConnectivity

Information about port types, position of ports, source blocks, source ports, destination blocks, and destination ports.

matrix
PortHandles

Handles of all ports.

matrix
Ports

Numbers of each kind of port.


Position

Position of block in model window.

vector [left top right bottom]
not enclosed in quotation marks

PostOutputsFcn

Function called after the block's output function is called.

MATLAB expression
PostSaveFcn

Function called after the block is saved.

MATLAB expression
PreOutputsFcn

Function called before block's preoutputs function is called.

MATLAB expression
PreSaveFcn

Function called before the block is saved.

MATLAB expression
Priority

Specifies the block's order of execution relative to other blocks in the same model. Set by the Priority field on the General pane of the Block Properties dialog box.

string {''}
ReferenceBlock

Name of the library block that this block is linked to.

string {''}
RequirementsInfo

For internal use.


RTWData

User specified data, used by Real-Time Workshop.


SampleTime

Value of the sample time parameter.


Selected

Status of whether or not block is selected.

{'on'} | 'off'
ShowName

Display block name.

{'on'} | 'off'
StartFcn

Function called at the start of a simulation.

MATLAB expression
StatePerturbation
Jacobian

See Simulink Control documentation for details.


StopFcn

Function called at the termination of a simulation.

MATLAB expression
Tag

Text that appears in the block label that Simulink generates. Set by the Tag field on the General pane of the Block Properties dialog box.

string {''}
Type

Simulink object type (read only).

'block'
UndoDeleteFcn

Function called when block deletion is undone.

MATLAB expression
UserData

User-specified data that can have any MATLAB data type.

{'[]'}
UserDataPersistent

Status of whether or not UserData will be saved in the model file.

'on' | {'off'}

Examples of Setting Block Parameters

These examples illustrate how to change common block parameters.

This command changes the orientation of the Gain block in the mymodel system so it faces the opposite direction (right to left).

This command associates an OpenFcn callback with the Gain block in the mymodel system.

This command sets the Position parameter of the Gain block in the mymodel system. The block is 75 pixels wide by 25 pixels high. The position vector is not enclosed in quotation marks.


Previous page  Model Parameters Block-Specific Parameters Next page

© 1994-2005 The MathWorks, Inc.