Component Palette Icon:
The Template Repeater repeats instances of templates any number of times. It can arrange them vertically, horizontally, or in a "flow" layout, which can either be top-to-bottom or left-to-right. If there are too many to fit, a scrollbar will be shown. This makes it easy to quickly create screens that represent many similar pieces of equipment. It also can be used to create screens that are dynamic, and automatically configure themselves based on configuration stored in a database or tag structure. When first dropped on a window, the template repeater will look like any other empty container. To select the template to repeat, configure the repeater's Template Path property. There are two ways to set how many times the template should repeat:
- Count - The template will be repeated X times, where X is the value of "Repeat Count". The repeat count starts at zero and increments X amount of times. Each value for X will be inserted into the custom property of the template that will be repeated. Template repeater inserts the value of X into the custom property on the template with the same name as the template repeater's "Index Parameter Name." For example, if the template has a custom property of "index" and the template repeater's Index Parameter Name is also "index," then the template will be repeated X many time with the value of X being inserted into the template's custom property called "index."
- Dataset - The template will be repeated once for each row in the "Template Parameters" dataset. The template's custom properties with the same names as the dataset's column names will assume the values of each row of the dataset.
|Background Color||The background color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.||Color||.background||Appearance|
The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Field Border, and Line Border.
As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Alignment for "Flow" layout style. Options are:
|Flow Direction||When the layout style is flow, this property controls if the components in the container flow horizontally or vertically.||int||.flowDirection||Appearance|
|Horizontal Gap||The gap size to use for horizontal gaps.||int||.horizontalGap||Appearance|
|Index Parameter Name||A name of an integer parameter on the template that will be set to an index number.||String||.indexParamName||Behavior|
Controls how the repeated template instances are laid out inside the repeater. Options are listed below:
|Marquee Mode||Turn the repeater into a scrolling marquee.||boolean||.marqueeMode||Behavior|
|Name||The name of this component.||String||.name||Common|
|Quality||The data quality code for any Tag bindings on this component.||QualityCode||.quality||Data|
"Count" will repeat the template a number of times, assigning each template an index number.
"Dataset" will repeat the template once per row in the template parameter's dataset.
|Repeat Count||The template will be repeated this many times, if the repeat behavior is set to "Count."||int||.repeatCount||Behavior|
|Scroll Delay||The time (in milliseconds) to wait between performing each step in a scroll.||int||.scrollDelay||Behavior|
|Stay Delay||The time (in milliseconds) to wait between scrolls.||int||.stayDelay||Behavior|
|Template Parameters||This dataset will be used to control the number of templates and the parameters set on the templates if the repeat behavior is set to "Dataset."||Dataset||.templateParams||Behavior|
|Template Path||The path to the template that this container will repeat.||String||.templatePath||Behavior|
|Vertical Gap||The gap size to use for vertical gaps.||int||.verticalGap||Appearance|
|Visible||If disabled, the component will be hidden.||boolean||.visible||Common|
|Data Quality||The data quality code for any Tag bindings on this component.||int||.dataQuality||Deprecated|
See the Vision - Template Repeater Scripting Functions page for the full list of scripting functions available for this component.
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page.