Event Grid

The Event Grid is provided for the tabular display of alarms and messages.

 

Attributes

Category: Colors

Name

Description

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

Filter

Defines which events are queried by the server

Sorting

Defines sorting rules for sorting the displayed data.

Columns

The columns to be displayed in the EventGrid

AllowDetailsPopup

Defines whether a dialog with detailed information is automatically displayed when interacting with an event entry.

Activated by default.

Can be disabled to implement a customized display of the detailed information.

SelectedEvent

Returns the selected event or zero if no event is selected.

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 tool tip for the control

 

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: Menu bar

Name

Description

MenuBarPosition

Defines the position of the menu bar.

ShowMenuBar

Defines whether the menu bar is displayed.

ButtonFontFamily

Defines the font of the button text.

ButtonFontSize

Defines the font size of the button text.

ButtonFontSizeUnit

Defines the unit of the button text font size.

ButtonFontStyle

Defines the font style of the button text.

ButtonFontWeight

Defines the font weight (normal, bold) of the button text.

ButtonHeight

Defines the height of the buttons.

ButtonHeightUnit

Defines the unit of button height.

Category: Grid

Name

Description

HeaderFontFamily

Defines the font of the text in the header bar.

HeaderFontSize

Defines the font size of the text in the header bar.

HeaderFontSizeUnit

Defines the font size unit of the text in the header bar.

HeaderFontStyle

Defines the font style of the text in the header bar.

HeaderFontWeight

Defines the font weight (normal, bold) of the text in the header bar.

GridFontFamily

Defines the font of the text in the table.

GridFontSize

Defines the font size of the text in the table.

GridFontSizeUnit

Defines the font size unit of the text in the table.

GridFontStyle

Defines the font style of the text in the table.

GridFontWeight

Defines the font weight (normal, bold) of the text in the table.

HeaderHeight

Defines the height of the header bar.

HeaderHeightUnit

Defines the height unit of the header bar.

RowHeight

Defines the height of the table rows.

RowHeightUnit

Defines the height unit of the table rows.

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

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 depressed 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 depressed over the control.

onMouseDownRight

The right mouse button was depressed 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.

configure

Determines whether the column configuration in the event grid is customizable.

viewDetails

Determines whether the display of event details can be enabled in the event grid.

 

Inheritance hierarchy

Control

    Event Grid

 

NuGet package: Beckhoff.TwinCAT.HMI.Controls

Note: NuGet packages are available from version 1.12.

Note: Available since version 1.10

 

See also

API reference for this control