WebPages Element Property Tags

The following table contains the element properties, which will automatically be published in Cognex Designer as tags when the element is added to a WebPage. These properties can be set via bindings and WebPage Elements Event Handler Scripts, or monitored in Data Change Scripts (WebHMI), and can be accessed in the Tag Browser.

Element Property Tag Type
CheckBox Checked $WebPages.[PageName].CheckBox.Checked Boolean
DataTable Content $WebPages.[PageName].DataTable.Content TableData
DateTime Entry Format $WebPages.[PageName].DateTimeEntry.Format String
Value $WebPages.[PageName].DateTimeEntry.Value String
Display Image Rotation $WebPages.[PageName].Display.ImageRotation Integer
Zoom Level $WebPages.[PageName].Display.ZoomLevel Double
Zoom Type $WebPages.[PageName].Display.ZoomType Integer
ListBox Content $WebPages.[PageName].ListBox.Content TableData
Selected Index $WebPages.[PageName].ListBox.SelectedIndex Integer
Selected Value $WebPages.[PageName].ListBox.SelectedValue String
Numeric Entry Value $WebPages.[PageName].NumericEntry Double
Radio Button Checked $WebPages.[PageName].RadioButton.Checked Boolean
Selection Box Content $WebPages.[PageName].SelectionBox.Content TableData
Selected Index $WebPages.[PageName].SelectionBox.SelectedIndex Integer
Selected Value $WebPages.[PageName].SelectionBox.SelectedValue String
Slider Value $WebPages.[PageName].Slider.Value Integer
TextBox Text $WebPages.[PageName].TextBox.Text String
Note:
  • All of the elements (Web Page User Input Controls, Graphics) properties can be accessed via the $HMI.SetControlProperty() and $HMI.GetControlProperty() functions. Cognex recommends only using these functions when an element does not have an Cognex Designer published property tag.
  • The properties of the elements are the same as those exposed in the Web Page Editor, minus the white space between the names (i.e. Border Color > BorderColor).
  • When an element with a published property tag is placed on a Panel or in a Group, the path name of the element changes to include the name of the Panel or Group. For example, WebPages.WebPageName.PanelName.CheckboxName.Checked. If the element is ungrouped or removed from the Panel, the path name will be changed; for example, WebPages.WebPageName.GroupName.SelectionBoxName.Content becomes WebPages.WebPageName.SelectionBoxName.Content.
  • A DateTime column in a database query is not supported.

    You cannot use the DateTime tag in WebHMI, for example, displaying a table in WebHMI with a DateTime column.