Datagrid

A data grid is a table. Data sets can be displayed in this table that have been defined via Engineering or dynamically via an array.

A description of the configuration can be found in chapter Configuration.

Attributes

Category: Colors

Name

Description

HeaderBackgroundColor

Definition of the background color of the header row

HeaderTextColor

Definition of the text color of the column headers

RowNumbersBackgroundColor

Definition of the background color of the column for row numbering

RowNumbersTextColor

Definition of the text color of the row numbering

TableBorderColor

Definition of the grid color

BackgroundColor

Definition of the background color

BorderColor

Definition of the border color of the control

Category: Layout

Name

Description

Left

Definition of the distance from the left side to the left side of the surrounding control

LeftUnit

Definition of the unit of the distance to the right side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Top

Definition of the distance from the top side to the top side of the surrounding control

TopUnit

Selection of the unit of the distance to the top side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Right

Definition of the distance from the right side to the right side of the surrounding control

RightUnit

Selection of the unit of the distance to the right side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Bottom

Definition of the distance from the bottom side to the bottom side of the surrounding control

BottomUnit

Selection of the unit of the distance to the bottom side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Width

Definition of the external width of the control

WidthUnit

Selection of the unit of the width:

  • Pixels for an absolute width
  • Percent for a relative width

Height

Definition of the external height of the control

HeightUnit

Selection of the unit of the height:

  • Pixels for an absolute height
  • Percent for a relative height

MaxWidth

Definition of the maximum width if the control size is defined as dynamic

MaxWidthUnit

Selection of the unit of the maximum width:

  • Pixels for an absolute value
  • Percent for a relative value

MinWidth

Definition of the minimum width if the control size is defined as dynamic

MinWidthUnit

Selection of the unit of the minimum width:

  • Pixels for an absolute value
  • Percent for a relative value

MaxHeight

Definition of the maximum height if the control size is defined as dynamic

MaxHeightUnit

Selection of the unit of the maximum height:

  • Pixels for an absolute value
  • Percent for a relative value

MinHeight

Definition of the minimum height if the control size is defined as dynamic

MinHeightUnit

Selection of the unit of the minimum height:

  • Pixels for an absolute value
  • Percent for a relative value

RenderedLeft

Calculated distance in pixels from the left side to the left side of the surrounding control

RenderedTop

Calculated distance in pixels from the top side to the top side of the surrounding control

RenderedRight

Calculated distance in pixels from the right side to the right side of the surrounding control

RenderedBottom

Calculated distance in pixels from the bottom side to the bottom side of the surrounding control

RenderedWidth

Calculated width of the control in pixels

RenderedHeight

Calculated height of the control in pixels

GridRowIndex

Definition of the row of a grid in which the control is to be displayed

GridColumnIndex

Definition of the column of a grid in which the control is to be displayed

Opacity

Definition of the transparency of the entire control

Visibility

Selection of the visibility of a control:

  • Visible: Control is visible
  • Hidden: Control is invisible, but is drawn – controls behind it cannot be operated
  • Collapsed: Control is invisible and is not drawn – controls behind it can be operated

ZIndex

Definition of the position on the Z-axis

Transform

Definition of a transformation of a control:

  • Translate: Translate in X-, Y-, Z-direction
  • Rotate: Rotate by an angle
  • Scale: Zoom by a factor
  • Skew: Sides shown skewed by an angle
  • Origin: Set the origin of the transformation relative to the position of the control
  • Perspective: Set the perspective of the transformations of all child elements

BoxShadow

Definition of a shadow

WidthMode

Selection of the method of calculating the width:

  • Value: The width is defined by the width entered.
  • Parent: The width is defined by the distance to the left and right side of the parent element. The "Width" attribute is ignored in all calculations!

HeightMode

Selection of the method of calculating the height:

  • Value: The height is defined by the height entered.
  • Parent: The height is defined by the distance to the top and bottom side of the parent element. The "Height" attribute is ignored in all calculations!

Category: Common

Name

Description

IsEnabled

Selection of whether a control should be activated

Id

Definition of the name of the control

Type

Type name of the control

ClassNames

Definition of control classes

IsAttached

If a control is logically assigned in the DOM.

Tooltip

Definition of the tooltip for the control

DataSymbol

Defines a symbol as data source.

Category: Border

Name

Description

BorderRadius

Definition of the radius of the four corners to round them off

BorderStyle

Selection of the border style of the four sides of the control

BorderWidth

Definition of the border width of the four sides of the control

Category: Background Image

Name

Description

BackgroundImage

Definition of an image that is located above the background color

BackgroundImageHeight

Definition of the height of the background image

BackgroundImageHeightUnit

Selection of the unit of the height of the background image:

  • Pixels for an absolute height
  • Percent for a relative height

BackgroundImageWidth

Definition of the width of the background image

BackgroundImageWidthUnit

Selection of the unit of the width of the background image:

  • Pixels for an absolute width
  • Percent for a relative width

BackgroundImagePadding

Definition of an additional distance between the border of the control and background image for the four sides

BackgroundImageVerticalAlignment

Definition of the vertical alignment of the background image within the control

BackgroundImageHorizontalAlignment

Definition of the horizontal alignment of the background image within the control

Category: Data

Name

Description

SrcColumn

Definition of column options - the assignment of options to rows is based on the order in the Column Definitions dialog

SrcData

Definition of the data to be displayed in the DataGrid

SelectedColumnIndex

Definition of the selected column using the column index

SelectedRowIndex

Definition of the selected row using the row index

Sorting

Defines sorting rules for sorting the displayed data.

Filter

Defines filter rules that are applied to read access to the DataSymbol when using DataSymbol.

Category: Grid

Name

Description

RowHeight

Definition of the row height

RowHeightUnit

Definition of the unit of the row height:

  • Pixels for an absolute height
  • Percent for a relative height

TableBorderWidth

Definition of the line width of the grid

TableBorderWidthUnit

Selecting the unit of the line width:

  • Pixels for an absolute width
  • Percent for a relative width

TableBorderStyle

Selecting the style of the grid lines

CellContentPadding

Definition of the distance of the text to the edge of the cell

GridFontFamily

Definition of the font using the name of the font family or the keyword

GridFontSize

Definition of the font size of the table contents

GridFontSizeUnit

Definition of the font size unit:

  • Pixels for an absolute size
  • Percent for a relative size

GridFontStyle

Selecting the font style of the table contents:

  • Normal
  • Italic: italic
  • Oblique: slanted

GridFontWeight

Selecting the font weight of the table contents:

  • Normal
  • Bold: bold

SrcDataHasChanged

Indicates whether the user has changed the data.

SelectedRowValue

The value of the selected row.

SelectedCellValue

The value of the selected cell.

Category: Header

Name

Description

 

 

Category: Row Numbers

Name

Description

ShowRowNumbers

Selecting whether the row numbering is to be displayed

RowNumbersResizable

Selecting whether the width of the columns can be changed at runtime using the separators in the column header row

RowNumbersWidth

Definition of the width of the row numbering column

RowNumbersWidthUnit

Selecting the unit of column width:

  • Pixels for an absolute width
  • Percent for a relative width

RowNumbersCellPadding

Definition of the distance of the numbering to the edge of the cell

 

 

RowNumbersFontFamily

Definition of the font using the name of the font family or the keyword

RowNumbersFontSize

Definition of the font size of the row numbering

RowNumbersFontSizeUnit

Definition of the font size unit:

  • Pixels for an absolute size
  • Percent for a relative size

RowNumbersFontStyle

Definition of the font style of the row numbering:

  • Normal
  • Italic
  • Oblique

RowNumbersFontWeight

Definition of the font weight of the row numbering:

  • Normal
  • Bold

RowNumbersHorizontalAlignment

Definition of horizontal alignment of row numbering

RowNumbersVerticalAlignment

Definition of vertical alignment of row numbering

RowNumbersStartNumber

Start value of the series numbering.

Category: Table Border

Name

Description

 

 

Events

Category: Framework

Name

Description

onAttached

The control was added to the display.

onDetached

The control was removed from the display.

onInitialized

The control was initialized.

onDestroyed

The control was destroyed.

onMoved

The control was moved in relation to the browser window.

onResized

The size of the control was changed.

Category: Operator

Name

Description

onDataChanged

The data has been changed.

onSelectedItemChanged

Another entry is now selected.

onPressed

A mouse click was executed or a touch screen was briefly touched.

onMouseClick

The left mouse button was clicked over the control and released.

onMouseDoubleClick

The left mouse button was clicked twice over the control and released.

onMouseRightClick

The right mouse button was clicked over the control and released.

onMouseDown

A mouse button was pressed down over the control.

onMouseEnter

The mouse pointer was moved over the control.

onMouseLeave

The mouse pointer has left the control.

onMouseUp

A mouse button was released over the control.

onMouseDownLeft

The left mouse button was pressed down over the control.

onMouseDownRight

The right mouse button was pressed down over the control.

onMouseMove

The mouse was moved over the control.

onMouseOver

The mouse pointer was moved over the control or one of its children.

onMouseOut

The mouse pointer has left the control or one of its child controls.

onMouseUpLeft

The left mouse button was released over the control.

onMouseUpRight

The right mouse button was released over the control.

onMouseWheel

The mouse wheel was moved over the control.

onTouchStart

A finger/stylus was placed against a touch screen.

onTouchMove

A finger/stylus was moved on a touch screen.

onTouchEnd

A finger/stylus was lifted off a touch screen.

onTouchCancel

An interaction with a touch screen was aborted.

Access rights

Name

Description

observe

Determines whether the control is generally observable.

operate

Determines whether the control is generally operable.

Inheritance hierarchy

Control

    Datagrid

NuGet package: Beckhoff.TwinCAT.HMI.Controls

Datagrid 1:

NuGet packages are available from version 1.12.

Datagrid 2:

Available from 1.8

See also

API reference for this control