Skip to end of metadata
Go to start of metadata

Description

A component that is added to manage multiple recipes. This is just one method of managing recipes and for more information on the other methods see the Using the Recipe Editor section.

Multiple Recipe Editor Table

 

Component Palette


 

Info

If you right-click on the table's body, the context menu will be shown.

  • Import from Clipboard: import table data from clipboard.
  • Export to Clipboard: export table data as currently contained in the table to clipboard.
  • Import from CSV File: import table data from a CSV file.
  • Export to CSV File: export table data as currently contained in the table to a CSV file.

 

Tip

You can drag and drop selected recipe names from the Recipe Selector List or the Power Table components to the Multiple Recipe Editor Table component. Then the selected recipe names will be added to the Recipe Name Filter property, and the Recipe State Filter and the Recipe Group Filter properties will be cleared.


 

Component Properties

Properties are provided that can be set to affect the operation and look of the component. They can be set through the Property Editor in the Designer or through scripting.

Example
event.source.parent.getComponent('Multiple Recipe Editor Table').showMasterRecipes = True

 Behavior
NameScriptingProperty TypeDescription
Require NoterequireNotebooleanIf true, a user must enter a note when any receipe values are changed.
Read OnlyreadOnlybooleanIf true, a user cannot edit recipe values.
Auto-Resize ModeautoResizeModebooleanThe table resizes its columns automatically.
Auto-Resize ModeautoResizeModeintThe table resizes its columns automatically.
Freeze First ColumnfreezeFirstColumnbooleanIf set to True, the first column will be frozen.
 Data
NameScriptingProperty TypeDescription
Item PathitemPathStringItem path of recipes to view.
Recipe Name FilterrecipeNameFilterStringRecipe name filter of comma separated values, including * and ? wildcard characters, to filter results by recipe name(s). No recipes will be returned, if this field is blank. Use an '*' to return all the recipes.
Recipe State FilterrecipeStateFilterStringRecipe state filter, including * and ? wildcard characters, to filter results by recipe state.
Recipe Group FilterrecipeGroupFilterStringRecipe group filter, including * and ? wildcard characters, to filter results by recipe group.
Recipe Value Name FilterrecipeValueNameFilterStringRecipe value name filter, including * and ? wildcard characters, to filter results by recipe value name.
Show Master RecipesshowMasterRecipesbooleanIf true, show master recipes.
 Appearance
NameScriptingProperty TypeDescription
Frozen Column WidthfrozenColumnWidthintFrozen column width in the table.
Selection ForegroundselectionForegroundColorForeground color of selected cells.
Wrap Header TextwrapHeaderTextbooleanIf set to True, the table header text will be wrapped at word boundaries (whitespace) if they are too long to fit within the allocated width.
Recipe Display FormatrecipeDisplayFormatStringFormat for the recipe display for recipe headers. You can use the reserved words: {RecipeName}, {State}, {Group}.
Selection BackgroundselectionBackgroundColorBackground color of selected cells.
Grid Line ColorgridColorColorGrid line color of the table.
Show Horizontal Grid LinesshowHorizontalLinesbooleanIf true, show horizontal grid lines.
Show Vertical Grid LinesshowVerticalLinesbooleanIf true, show vertical grid lines.
Show Table HeaderheaderVisiblebooleanIf true, show the table header.
Row HeightrowHeightintRow height in the table.
String Value Display Icon PathstringValueDisplayIconPathStringRelative path of an icon image appearing for string value display.
String Value Edit Icon PathstringValueEditIconPathString

Relative path of an icon image appearing for string value edit.

Slide FontslideFontFontFont to use for the slide.
Slide Foreground ColorslideForegroundColorForeground color of the slide.
Slide Background ColorslideBackgroundColorBackground color of the slide.
Slide TypeslideTypeintThe slide type.
Slide DirectionslideDirectionintThe slide direction.
Maximum Slide PositionmaximumSlidePositionfloatMaximum position to open the slide.
Minimum Slide PositionminimumSlidePositionfloatMinimum position to open the slide.
Initial Slide PositioninitialSlidePositionfloatInitial position to open the slide.
Show Slide GrippershowSlideGripperbooleanIf true, show the slide gripper.

 

Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component such as by clicking a mouse.

 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseEntered

This event fires when the mouse enters the space over the source component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseExited

This event fires when the mouse leaves the space over the source component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mousePressed

This event fires when a mouse button is pressed down on the source component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

 

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

PropertyDescription
.sourceThe component that fired this event.
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

PropertyDescription
.sourceThe component that fired this event.
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe name of the property that changed. NOTE: Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

 


 

Extension Functions

 getStringValueOptions
  • Description

Get the options for the string values of the recipe.

  • Parameters

itemPath - The item path.

recipeName - The recipe name.

valueName - The recipe value name.

  • Returns

List of string values.

  • Scope

Client

 onCopy
  • Description

Called when copying a recipe data from a column.

  • Parameters

itemPath - The copied item path.

recipeName - The copied recipe name.

recipeState - The recipe state.

recipeGroup - The recipe group.

recipeValues - The recipe values.

  • Returns

Nothing

  • Scope

Client

 onPaste
  • Description

Called when pasting recipe data to a column.

  • Parameters

columnName - The selected column name (recipe name).

itemPath - The copied item path.

recipeName - The copied recipe name.

recipeState - The recipe state name.

recipeGroup - The recipe group name.

recipeValues - The recipe values.

  • Returns

Nothing

  • Scope

Client


 

Custom Methods

Custom methods allow you to add your own component functions to a component that can be called through scripting. This is a useful and clean method of re-using script that is specific to the component (say you want to update a visual aspect of the component in the same way whether a user clicks on the component or a window property value changes). See Component Custom Methods in the Ignition Help Manual for more information.

 


 

Customizers

This component does not have any custom properties.


 

Component Functions

This component does not have functions associated with it. 

  • No labels