getDialogControl

Class: Simulink.dialog.Container
Namespace: Simulink.dialog

Search for a specific dialog control on the mask

Syntax

[control,phandle] = handle.getDialogControl(controlIdentifier)

Description

[control,phandle] = handle.getDialogControl(controlIdentifier), search for a specific child dialog control recursively on the mask dialog box.

Input Arguments

controlIdentifier — Name of dialog control

char

Name of the dialog control being searched on the mask dialog box specified as a character vector.

Data Types: char | string

Output Arguments

control — Handle to the dialog control

char

Target dialog control being searched on the mask dialog box.

phandle — Handle to the parent dialog control

char

Parent of the dialog control being searched mask dialog box.

Examples

Find a dialog control

• Find a dial dialog control on the mask dialog box. maskObj is the handle to the mask object. The getDialogControl method returns the handle to the dialog control (control) and handle to the parent dialog control (phandle).

  [hdlgctrl, phandle] = maskobj.getDialogControl('Parameter4')
  

  hdlgctrl = 
  
    Dial with properties:
  
                   Name: 'Parameter4'
                  Scale: 'linear'
                    Row: 'new'
      HorizontalStretch: 'on'
                Tooltip: ''
  
  
  phandle = 
  
    Tab with properties:
  
                Name: 'Container6'
              Prompt: 'Main Controls'
             Enabled: 'on'
             Visible: 'on'
        AlignPrompts: 'off'
      DialogControls: [1×3 Simulink.dialog.parameter.Control]

Version History

Introduced in R2014a