Jump to content

Control editor: Difference between revisions

From LabVIEW Wiki
Cleanup of the first part
Line 1: Line 1:
{{Underconstruction}}
{{Underconstruction}}


The control editor is a special kind of editor that looks and behaves like the [[Front Panel]] of a [[VI]] without a [[Block Diagram]]. It may only contain a single control and can be used to create [[Control|controls]], [[Type Definition|type definitions]] and [[Strict Type Definition|strict type definitions]]. One of its key features is control customization.
''Note'': This article uses the term "control" interchangeably with "indicator".


''Note'': In this article, the term "control" is used interchangeably with "indicator".
The '''Control editor''' provides the ability to create and modify [[Control|controls]], [[Type Definition|type definitions]] and [[Strict Type Definition|strict type definitions]]. It works like a [[Front Panel|front panel]] but it can only contain a single control and doesn't have a [[Block Diagram|block diagram]].
 
== Control customization ==
[[File:Control Editor - Examples of Visual Control Customizations.jpg|thumb|Examples of visual control customization on a front panel using a Push Button]]
 
Control customization is the act of changing the visual appearance and logical configuration of a control either on the front panel of a VI or in the control editor.
 
The visual appearance of controls located on a front panel can be manipulated in their shape, coloring, visibility of elements, font and state. Depending on the type of control (button, graph, list, ...) additional options may be available. It is, however, not possible to change the fundamental parts (icons, backgrounds, locations, ...) of a control, unless it is opened in the control editor.
 
The logical configuration (i.e. [[Array|array]] of [[String|strings]]) can be defined both on the front panel of a VI or in the control editor. The benefit of using the control editor is in the ability to store the control on disk for later re-use.
 
Depending on the desired coupling, the control can be stored as [[Control|control]] (zero coupling), [[Type Definition|type definition]] (logical coupling) or [[Strict Type Definition|strict type definition]] (logical and visual coupling).
 
<br clear=all>


== Ways to open the control editor ==
== Ways to open the control editor ==


There are several ways to open the control editor:
The control editor can be opened in multiple ways:


* From an existing [[Control]] or [[Control Template]] file.
* By opening an existing [[Control|control]] or [[Control Template|control template]] file.
* From the [[Getting Started Window]] via the ''File'' menu option ''New...'', by selecting ''Other Files >> Custom Control''.
* From the [[Getting Started Window]] via the ''File'' menu option ''New...'', by selecting ''Other Files >> Custom Control''.
* From the right-click menu of a control via ''Advanced >> Customize...''.
* From the right-click menu of a control via ''Advanced >> Customize...''.
* From the [[Front Panel]] of a [[VI]] via the ''Edit'' menu option ''Customize Control...''.
* From the [[Front Panel]] of a [[VI]] via the ''Edit'' menu option ''Customize Control...''.


== Purpose of the control editor ==
[[File:Control Editor - Examples of Visual Control Customizations.jpg|thumb|Examples of visual control customization on a front panel using a Push Button]]
The visual appearance of controls (their ''shape'', ''coloring'', ''visibility of elements'', ''font'' and ''state'') can be changed directly on the front panel of a VI. It is, however, not possible to change the fundamental parts (''icons'', ''images'', ''relative positions'', ...). This can only be done in the control editor.
Also, the control editor allows to store controls on disk for later re-use and to specify the type of control which changes how new instances of the control are related to each other:
* [[Control|control]] (no relation)
* [[Type Definition|type definition]] (share logical configuration)
* [[Strict Type Definition|strict type definition]] (share logical configuration and visual appearance)
<br clear=all>
== Invalid control error ==
== Invalid control error ==
[[File:Control Editor - Invalid Control.jpg|thumb|Invalid Control error in the control editor window (because it contains two controls)]]
[[File:Control Editor - Invalid Control.jpg|thumb|Invalid Control error in the control editor window (because it contains two controls)]]

Revision as of 17:29, 20 February 2020

Note: This article uses the term "control" interchangeably with "indicator".

The Control editor provides the ability to create and modify controls, type definitions and strict type definitions. It works like a front panel but it can only contain a single control and doesn't have a block diagram.

Ways to open the control editor

The control editor can be opened in multiple ways:

  • By opening an existing control or control template file.
  • From the Getting Started Window via the File menu option New..., by selecting Other Files >> Custom Control.
  • From the right-click menu of a control via Advanced >> Customize....
  • From the Front Panel of a VI via the Edit menu option Customize Control....

Purpose of the control editor

Examples of visual control customization on a front panel using a Push Button

The visual appearance of controls (their shape, coloring, visibility of elements, font and state) can be changed directly on the front panel of a VI. It is, however, not possible to change the fundamental parts (icons, images, relative positions, ...). This can only be done in the control editor.

Also, the control editor allows to store controls on disk for later re-use and to specify the type of control which changes how new instances of the control are related to each other:


Invalid control error

Invalid Control error in the control editor window (because it contains two controls)

An Invalid Control button appears at the menu bar when the control is invalid, for example when more than one control is on the front panel. Clicking the button opens the Error list dialog with further error details.


Editor modes

The control editor has two editor modes: Edit Mode and Customize Mode.

Ways to switch between Edit Mode and Customize Mode

There are multiple ways to switch between Edit Mode and Customize Mode:

  • Clicking the Change to Customize Mode and Change to Edit Mode button, respectively.
  • Using the Operate menu option Change to Customize Mode and Change to Edit Mode, respectively.
  • Using the Window menu option Show Parts Window (forces the editor into Customize Mode, even if the window contains more than one control).
  • The key-combination Ctrl+M is a shortcut to toggle between modes.

Edit Mode

Edit Mode is enabled by default when opening the control editor. In this mode controls can be customized the same way as on the front panel.

Customize Mode

Individual parts of a control (Push Button)
Individual parts of a control (Push Button) spread apart in the control editor

In Customize Mode individual parts of a control become disconnected and can be changed and moved. It is, however, not possible to add or remove parts (except pictures). Depending on the type (button, graph, list, ...) and style (Classic, Modern, System, Silver, NXG) of a control, the amount and type of parts can vary. It is therefore important to select the right type and style of control to ensure that the final control works as expected.

In Customize Mode each part is displayed inside a white rectangle that surrounds the part. Because parts need to be placed on top of each other to achieve the desired visual effect, the Control Parts window is used to select individual parts. Right-click menu options and the Import Picture to Clipboard... command can then be used to change or move the currently selected part.

When switching back to Edit Mode, all parts keep their current (relative) location, size and visual representation.


Control Parts window

This is the Control Parts window

The Control Parts window is part of the Control Editor and appears when selecting the Window menu option Show Parts Window. It contains a picture ring control with individual parts of the control and allows changing the position and dimension of the currently selected part.


Right click menu options

Option Description
Copy to Clipboard Copies the value of the currently selected part to the clipboard.
Import Picture from Clipboard Only available if the clipboard contains a picture. Adds a picture from the clipboard as background for text items or as substitute for picture items. The item is resized to fit the imported picture.
Import from Clipboard at Same Size This is the same as Import Picture from Clipboard but the picture is scaled to fit the size of the item.
Import from File... Opens a file prompt to select a picture file. Adds the selected picture as background for text items or as substitute for picture items. The item is resized to fit the imported picture.
Import from File at Same Size... This is the same as Import from File... but the picture is scaled to fit the size of the item.
Revert Reverts the item to its last saved state.
Original Size Restores the last saved size of the item.

Depending on the type of part, additional menu options are available:

Picture Item

Option Description
Picture Item Opens a preview of picture items. The current picture item changes to the selected item.
Independent Sizes When enabled, the size of each picture is independent from each other. This option is disabled by default.

Label

Option Description
Size To Text When enabled, the size of the item automatically adjusts to fit the entire text.
Vertical Arrangement Allows to change the direction of the text (None, Stacked, Clockwise, Counterclockwise). The default setting is "None".
Lock Label Locks the label in place, so that moving the label moves the entire control. This option is disabled by default.

Text Item

Option Description
Text Item Opens a preview of text items.

Import Picture to Clipboard...

Opens a file dialog to select a picture that is imported to clipboard.

See also

External links

References