Service: Layout
Functions
| Result | Name / Params | Comment | ||
|---|---|---|---|---|
| LayoutDoc | layout.GetOne | Returns a LayoutDoc object | ||
| id | string | The unique ID of the layout | ||
Objects
LayoutDoc
| Property | Type | Description |
|---|---|---|
| Id | string | (Unique) Unique ID of the LayoutDoc |
| Name | string | Any name; might be a language resource id |
| Layout | LayoutLayout | The base layout structure |
LayoutLayout
| Property | Type | Description |
|---|---|---|
| CaptionTitle | string | Text for the title bar |
| CaptionIcon | string | Icon resource ID |
| CaptionColor | string | Color ID string for caption background |
| HasCaption | bool | Show the title bar |
| TreatAsUnit | bool | Treat layout and LayoutItems as unit |
| Item | LayoutItem | Inner LayoutItem; can only be of type: LayoutItemPane, LayoutItemSplit, LayoutItemBars or LayoutItemTabs |
LayoutItem
Template for all layout items.
This object is extended by the object type pointed to by property ‘ItemType’.
| Property | Type | Description |
|---|---|---|
| ItemType tag | string | The type of item, e.g. ‘split’, ’tabs’, … See LayoutItemType. |
LayoutItemSplit
This object extends LayoutItem.
| Property | Type | Description |
|---|---|---|
| Orientation | int | See Orientation. |
| HasSplitter | bool | Show splitter between items |
| SplitterWidth | int | Width of the splitter |
| CanSize | bool | The splitter is movable. |
| Size | int | Size of one of the LayoutItems; see the SizeMode property |
| SizeMode | string | See SizeMode. |
| MinSize1 | LayoutSize | Minimum size for Item1 |
| MinSize2 | LayoutSize | Minimum size for Item2 |
| MaxSize1 | LayoutSize | Maximum size for Item1 |
| MaxSize2 | LayoutSize | Maximum size for Item2 |
| Item1 | LayoutItem | Inner LayoutItem 1; can only be of type: LayoutItemPane or LayoutItemSplit |
| Item2 | LayoutItem | Inner LayoutItem 2; can only be of type: LayoutItemPane or LayoutItemSplit |
LayoutItemBars
This object extends LayoutItem.
| Property | Type | Description |
|---|---|---|
| ActiveItem | int | Index of initially activated (maximized) bar in Bars. The index starts with 1. When ActiveItem is set OpeningRatios is not valid. |
| OpeningRatios | float[] | Opening ratios of the different bars in Bars. The elements in OpeningRatios are ordered in the same way as the elements in Bars. So the first ratio belongs to the first bar. The second ratio to the second bar etc. The ratios are only valid if ActiveItem is not set. |
| Bars | LayoutItem[] | Items of all bars |
LayoutItemTabs
This object extends LayoutItem.
| Property | Type | Description |
|---|---|---|
| ActiveItem | int | Index of initially activated tab in Tabs |
| Tabs | LayoutItem[] | Items of all tabs |
LayoutItemPane
This object extends LayoutItem.
| Property | Type | Description |
|---|---|---|
| PaneId | string | Address of this pane |
| CanClose | bool | Can close this pane |
| CanDrag | bool | Can drag this pane |
| CanDrop | bool | Can drop on this pane |
| CanSplit | bool | Can split this pane |
| AutoHide | bool | Automatically hide this pane if content is empty |
| IsWorkArea | bool | This Pane should be used as the working area. |
| MinWidth | int | Minimum width in pixels |
| MinHeight | int | Minimum height in pixels |
| MaxWidth | int | Maximum width in pixels |
| MaxHeight | int | Maximum height in pixels |
| Popups | LayoutPopup[] | Defined LayoutPopups |
| Content | LayoutContent | The content of the pane; only valid when Layout is empty |
| Layout | LayoutLayout | Inner layout structure; only valid when Content is empty |
LayoutPopup
| Property | Type | Description |
|---|---|---|
| CaptionTitle | string | Text for the title bar |
| CaptionIcon | string | Icon resource ID |
| CaptionColor | string | Color ID string for caption background |
| HasCaption | bool | Show the title bar |
| HasFrame | bool | Has a frame |
| CanMove | bool | Can move this popup |
| CanSize | bool | Can re-size this popup |
| CanMaximize | bool | Can maximize this popup |
| IsFix | bool | The popup stays when content is changed. |
| IsMaximized | bool | The popup is shown maximized by default. |
| Position | int | Relative position of popup in containing layout item; See Position. |
| XOffset | LayoutSize | X position |
| YOffset | LayoutSize | Y position |
| Width | LayoutSize | Popup width |
| Height | LayoutSize | Popup height |
| MinWidth | LayoutSize | Minimum popup width |
| MinHeight | LayoutSize | Minimum popup height |
| MaxWidth | LayoutSize | Maximum popup width |
| MaxHeight | LayoutSize | Maximum popup height |
| Pane | LayoutItem | Content pane |
LayoutSize
| Property | Type | Description |
|---|---|---|
| Value | int | Size depending on Unit; If it’s set to Percentage the value is multiplied by 10 to avoid floating point values. |
| Unit | int | See LayoutSizeUnit. |
LayoutContent
Template for all layout contents.
This object is extended by the object type pointed to by property ‘Type’.
| Property | Type | Description |
|---|---|---|
| Type tag | string | The type of content, e.g. ‘graphic’, ’text’, … Different content types See LayoutContentType. |
| CaptionTitle | string | Text for the title bar |
| CaptionIcon | string | Icon resource ID |
| CaptionColor | string | Color ID string for caption background |
| HasCaption | bool | Show the title bar |
| CanClose | bool | Can close this content |
| CanDrag | bool | Can drag this content |
| IsOverlay | string | The content should be activated on an event-related basis. See IsOverlay. |
| MinWidth | int | Minimum width in pixels |
| MinHeight | int | Minimum height in pixels |
| MaxWidth | int | Maximum width in pixels |
| MaxHeight | int | Maximum height in pixels |
LayoutContentLayout
This object extends LayoutContent.
| Property | Type | Description |
|---|---|---|
| Id | string | The ID of the layout |
LayoutContentGraphic
This object extends LayoutContent.
| Property | Type | Description |
|---|---|---|
| File | string | File string with params |
LayoutContentText
This object extends LayoutContent.
| Property | Type | Description |
|---|---|---|
| File | string | File string with params |
LayoutContentAttachments
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentDocument
This object extends LayoutContent.
| Property | Type | Description |
|---|---|---|
| File | string | File string with params |
LayoutContentWebsite
This object extends LayoutContent.
| Property | Type | Description |
|---|---|---|
| URL | string | URL of the website |
LayoutContentWindow
This object type is not fully supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|---|---|
| Window | string | Window type; See ContentWindow. |
| Params | string | Params for certain window types |
LayoutContentBookmarks
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentCalendar
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentCommunication
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentEmpty
No content
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentEventArchive
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentGadget
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentGisViewer
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentHistory
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentResultViewer
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentSysLog
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentTracing
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentVideo
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
LayoutContentView3D
This content type is not supported, yet.
This object extends LayoutContent.
| Property | Type | Description |
|---|
Enums
LayoutItemType
The type of item, e.g. ‘split’, ’tabs’, …
| Name | Value | Description |
|---|---|---|
| Pane | pane | See LayoutItemPane. |
| Split | split | See LayoutItemSplit. |
| Tabs | tabs | See LayoutItemTabs. |
| Bars | bars | See LayoutItemBars. |
Orientation
| Name | Value | Description |
|---|---|---|
| Vertical | 1 | Split orientation is vertically. |
| Horizontal | 2 | Split orientation is horizontally. |
SizeMode
| Name | Value | Description |
|---|---|---|
| Pixel1 | pixel1 | Size defines the size of Item1 in pixels. |
| Pixel2 | pixel2 | Size defines the size of Item2 in pixels. |
| Percentage1 | percentage1 | Size defines the relative size of Item1 in respect to the complete layout size. |
LayoutSizeUnit
| Name | Value | Description |
|---|---|---|
| Pixel | 1 | Size value is in pixels. |
| Percentage | 2 | Size value is relative to the complete layout size. |
Position
| Name | Value | Description |
|---|---|---|
| TopLeft | 0 | |
| TopCenter | 1 | |
| TopRight | 2 | |
| MidLeft | 3 | |
| Center | 4 | |
| MidRight | 5 | |
| BottomLeft | 6 | |
| BottomCenter | 7 | |
| BottomRight | 8 | |
| Default | 65535 |
LayoutContentType
The type of content, e.g. ‘graphic’, ’text’, … Different content types
| Name | Value | Description |
|---|---|---|
| Empty | empty | See LayoutContentEmpty. No content |
| Layout | layout | See LayoutContentLayout. |
| Graphic | graphic | See LayoutContentGraphic. |
| Text | text | See LayoutContentText. |
| Attachments | attachments | See LayoutContentAttachments. |
| Document | document | See LayoutContentDocument. |
| Website | website | See LayoutContentWebsite. |
| Window | window | See LayoutContentWindow. This object type is not fully supported, yet. |
| Gadget | gadget | See LayoutContentGadget. This content type is not supported, yet. |
| EventArchive | eventarchive | See LayoutContentEventArchive. This content type is not supported, yet. |
| SysLog | syslog | See LayoutContentSysLog. This content type is not supported, yet. |
| Video | video | See LayoutContentVideo. This content type is not supported, yet. |
| History | history | See LayoutContentHistory. This content type is not supported, yet. |
| GisViewer | gisviewer | See LayoutContentGisViewer. This content type is not supported, yet. |
| Tracing | tracing | See LayoutContentTracing. This content type is not supported, yet. |
| Communication | communication | See LayoutContentCommunication. This content type is not supported, yet. |
| Bookmarks | bookmarks | See LayoutContentBookmarks. This content type is not supported, yet. |
| Calendar | calendar | See LayoutContentCalendar. This content type is not supported, yet. |
| View3D | view3d | See LayoutContentView3D. This content type is not supported, yet. |
| ResultViewer | resultviewer | See LayoutContentResultViewer. This content type is not supported, yet. |
IsOverlay
| Name | Value | Description |
|---|---|---|
| Yes | yes | Activate on an event-related basis |
| No | no | Don’t activate on an event-related basis |
| Auto | auto | Use automatic decision |
ContentWindow
| Name | Value | Description |
|---|---|---|
| None | none | No window type set |
| Analyzer | analyzer | A database analyse window |
| ArchiveEvents | archiveEvents | An event archive window |
| ArchiveMedia | archiveMedia | A media archive window |
| AutomaticDataSupply | automaticDataSupply | A Automatic Data Supply dialog |
| ChatBot | chatBot | A chat bot window |
| DataPackage | datapackage | A data package window |
| DbCategories | dbCategories | A category list view |
| DbCops | dbCops | A control operation list view |
| DbDatapointPattern | dbDatapointPattern | A datapoint pattern list view |
| DbDatapoints | dbDatapoint | A datapoint list view |
| DbDeviceType | dbDeviceType | A device type list view |
| DbEventHandling | dbEventHandling | An event handling list view |
| DbExtensions | dbExtensions | An Extension list view |
| DbLocations | dbLocations | A location list view |
| DbPanes | dbPanes | A pane list view |
| DbPersons | dbPersons | A person list view |
| DbPrinter | dbPrinter | A printer profiles list view |
| DbProfiles | dbProfiles | A profiles list view |
| DbScheduledCommands | dbScheduledCommands | A scheduled commands list view |
| DbSegment | dbSegment | A segment list view |
| DbStations | dbStations | A station list view |
| DbTimer | dbTimer | A timer list view |
| DbUsers | dbUsers | A user list view |
| DevMon | devmon | An extension monitor view |
| DeviceControlPanel | deviceControlPanel | Deprecated |
| EdGraphic | edGraphic | A graphic editor |
| EdLayouts | edLayouts | A layout editor |
| EdScript | edScript | A script editor (not supported) |
| EdText | edText | A text editor |
| Files | files | A file structure window |
| HistoryDepr | historyDepr | Deprecated |
| LogExtensions | logExtensions | A Extension log |
| LogStates | logStates | A state log |
| LogSystem | logSystem | A system log |
| NetMon | netMon | A network monitor window |
| PanelAudio | panelAudio | Deprecated |
| PanelCommand | panelCommand | Deprecated |
| PanelIntercom | panelIntercom | Deprecated |
| PanelMain | panelMain | Deprecated |
| PanelNotification | panelNotification | Deprecated |
| PanelPhone | panelPhone | Deprecated |
| PanelVideo | panelVideo | Deprecated |
| Report | report | A reports view |
| RouteCards | routeCards | A route cards view |
| SymbolFilter | symbolFilter | A Symbolfilter view |
| WpfUI | wpfUi | A view to WinGuard WPF UI parts in. Should not be used in release mode. |
Last modified September 25, 2026