CX_WIDGET - Widget 
Formerly CXI_WINDOW_OBJECT
Class hierarchy
- CX_CLASS
- CX_CONTAINER
- CX_WIDGET
- CX_CONTAINER
Description:
CX_WIDGET represents a widget or window from an InstantView® code. Objects of this type are created by OpenWindow, and the Widget command can be used to search for a specific widget.
Code example:
Var(win)
OpenWindow(editWin,1) -> win
OpenWindow(editWin,1) -> win
| Function | MA* | Parameters | Return | Brief description |
|---|---|---|---|---|
| AliasName | * | Access function for the alias name | ||
| BuildWidgetIDs | Set WidgetIDs for this and all child widgets | |||
| Children 198178 | COLLECTION | all (direct) child objects | ||
| ClassID | * | Access function for the (form) class of a widget (CX_PERSON::name). | ||
| ClassName 198178 | * | Access function for the (form) class name of a widget (CX_PERSON::name). | ||
| ClearTooltip 194495 | Deletes the tooltip of the widget | |||
| ClearValidationState 194050 | Clears the validation state of a widget again. | |||
| CompileActionList | STRING | Compiles a text as if it were part of the source file belonging to the window in the ActionList. | ||
| CompileOverrideActionList | STRING | like CompileProcedure - but allows overdefinition of procedures | ||
| CopyToClipboard | INTEGER | Copy data from window object to clipboard (only for ListView, Tree) | ||
| SetTxnLineCount | INTEGER | controls transactions for CopyToClipboard | ||
| SetMaxMemoryUsage | INTEGER | controls transactions for CopyToClipboard | ||
| CopyFromClipboard | VECTOR, VECTOR | Import data from the clipboard into ListView (only for ListView) | ||
| DisplayHelp | Displays the help page for the widget, if one exists | |||
| EditSource | Edit source code | |||
| FillWindow | OBJECT | Fills widget with data | ||
| FillWindowAdditive | OBJECT | Fills widget with data | ||
| FindAssociatedPrompt 229900 | CX_WIDGET | Finds the description text prompt widget associated with this widget. | ||
| GetActionList 230295 | CX_MODULE | CX_ACTION_LIST | Returns the action list of the widget. | |
| GetBackgroundColor | COLOR | Returns the set background colour. | ||
| GetBoundFormatVector 208336 | VECTOR | Similar to GetFormatVector except that the access paths are issued as bound path literals. | ||
| GetChild | STRING | CX_WIDGET | Returns the child object with the specified identifier | |
| GetChildren | VECTOR | determine all child objects recursively | ||
| GetColor | COLOR | Returns the set font colour. | ||
| GetDateLimit | CX_SPAN_DATE | Get limit within which the entered date may move | ||
| GetDefModule | CX_MODULE | Module in which the widget was defined. | ||
| GetDescription 229889 | ML_STRING | The description text for the widget as used for screen readers by MorphIT. | ||
| GetHelpURL 215645 | STRING | Returns the full URL of the help page for this widget | ||
| GetImportContext 231135 | CX_IMPORT_CONTEXT | Returns the ImportContext of the widget. | ||
| GetModules | CX_MODULE | Module in which the widget is located | ||
| GetFormat | VECTOR | active format of the widget | ||
| GetFormatByName 183810 | STRING |
| format of the widget selected by name | |
| GetFormatName 183810 | STRING | Name of the active format of the widget | ||
| GetFormatNames 183810 | VECTOR | all available formats of the widget | ||
| GetFormatVector 206803 | VECTOR | Returns all formats set in the widget analogous to GetFormat , except that the access paths are published as objects of the type CX_PATH_LITERAL . | ||
| GetPageNumber | STRING | the number of pages for the document window object | ||
| GetParent | CX_WIDGET | the direct parent widget | ||
| GetScale | INTEGER | the current scaling for the document window object | ||
| GetSourceRange 230068 | CX_MODULE | CX_FILE_SOURCE_RANGE | Returns the source code range in which the widget was defined. | |
| GetSystemEventNames | VECTOR | Names of all system events | ||
| GetTopParent | CX_WIDGET | the parent window | ||
| GetTypeName | STRING | Type name of the window object (String, Button, ObjectList, ...) | ||
| GetWidgetID | STRING | Return WidgetID | ||
| GoToPage | INTEGER | INTEGER | positions the document in the document window object | |
| Height 203056 | * | INTEGER | Returns the current widget height (attachments included) in Minicells. | |
| Help | * | Read/set the widget's heplindex. Influences the help page opened by DisplayHelp . Values < 0 correspond to an unset help page. | ||
| ImportedFrom 230142 | STRING | Returns the full import path for import widgets. | ||
| IsDerived | INTEGER | Was window object inherited (unchanged)? | ||
| IsHidden | INTEGER | the window object is invisible (see Hide statement). | ||
| IsLocked | INTEGER | the window object is locked (see instruction Lock) | ||
| IsNonSelectable 195093 | INTEGER | get TRUE if the NON_SELECTABLE flag is set | ||
| IsOpen | INTEGER | is the window (or the parent window of a child object) open? | ||
| IsOverwritten | INTEGER | was an inherited window object overdefined? | ||
| IsWindowMaximized 192365 | INTEGER | is the window maximized? | ||
| IsWindowMinimized 184248 | INTEGER | is the window minimised? | ||
| MaximizeWindow 192365 | maximises the Window object | |||
| MinimizeWindow 184248 | minimises the Window object | |||
| Name | * | Read and change the widget name | ||
| NoOfDecimals | * | Read/write access to the number of decimal places displayed | ||
| OpenWidget | Opens a WebWidget in the browser | |||
| PushSocket 189117 | ANY, STRING | sends the passed data to the web widget connected in the browser. | ||
| ReadSourceCode 228791 | STRING | The source code of the widget/window | ||
| ReportMessages 225707 | INTEGER | COLLECTION | Returns all messages sent/received by the widget. | |
| RestoreWindow 184248 | retrieves a window from the minimised state | |||
| RetrieveData | ListView only: Fill Internal Cache | |||
| RewriteSourceCode 228838 | STRING, INTEGER | Overwrites the widget definition in the source code file | ||
| SelectedLanguage | INTEGER | If the widget is a MlOleBox, the current language of the MlOleBox is returned | ||
| SetApp | STRING | Sets the WebWidget path. | ||
| SetBackgroundColor | INTEGER | COLOR | Sets the background colour. | ||
| SetColor | INTEGER | COLOR | Sets the font colour. | ||
| SetContextMenu 208407 | CX_WIDGET | Sets the context menu of a widget at runtime. | ||
| SetGridMenu 208407 | CX_WIDGET | Sets the grid menu of a widget at runtime. | ||
| SetDateLimit | CX_SPAN_DATE | Set limit within which the entered date may move | ||
| SetScale | INTEGER | sets the current scaling for the document window object | ||
| SetShowPages | INTEGER | sets the number of pages displayed for the document window object | ||
obsolete | MULTIPLE_STRING | Please use PutValue instead | ||
| SetTooltip 194495 | MULTIPLE_STRING | sets the tooltip of the widget | ||
| SetUrl | STRING | Sets the URL to be opened in the WebWidget. | ||
| SetValidationState 194050 | LEVEL MULTIPLE_STRING | Adds a validation state to a widget that can be displayed to the user. (Currently only in MorphIT) | ||
| ShowLevel | STRING | Outputs the nesting depth of the widget as a string | ||
| Symbol | CX_BITMAP | Bitmap as symbol for the type of the window object | ||
| Width 203056 | * | INTEGER | Returns the current widget width (attachments included) in Minicells. Due to the conversion of Minicells -> Pixel -> Minicells this value can sometimes differ from the actual value by 1 Minicell. | |
obsolete | * | Please use GetMLText and PutValue instead | ||
| XMLExport | STRING | Widget in the XML form (local character set) | ||
| XML exportUTF8 | STRING | Widget in the XML form (UTF-8) | ||
| XML export2 | INTEGER, STRING | STRING | Widget in the XML form (UTF-8) | |
| XML export3 | INTEGER, STRING, VECTOR | STRING | Widget in the XML form (UTF-8) | |
| XPos 203056 | * | INTEGER | Returns the current widget position (attachments included) in Minicells. Due to the conversion of Minicells -> Pixel -> Minicells this value can sometimes differ from the actual value by 1 Minicell. | |
| YPos 203056 | * | INTEGER | Returns the current widget position (attachments included) in Minicells. | |
| SetDigitalTimerTrigger | CX_TIME, INTEGER | Sets time and message for DigitalTimer |
* MA = Member Access function,
grey background = inherited function
| Data field | Type | Reference class | I* | Brief description |
|---|---|---|---|---|
| font | ENUMSHORT | The current font of the widget as defined with MSFonts and can be changed with SetFont. | ||
| h | SHORT | Height - Is changed by resizing but not by attachments or manual resizing of the window and may differ from Height(). This value initially corresponds to the value specified in the source code. | ||
| ih | SHORT | Item height of an ObjectListView, corresponds to the value passed with the ITEM flag | ||
| iw | SHORT | Item width of an ObjectListView, corresponds to the value passed with the ITEM flag | ||
| modules | POINTER | CX_MODULE | Module to which this window or widget belongs | |
| tooltip text | MULTIPLE_STRING_PTR | Tooltip text of the widget | ||
| w | SHORT | Width - Is changed by resizing but not by attachments or manual resizing of the window and may differ from Width(). This value initially corresponds to the value specified in the source code. | ||
| x | SHORT | x-coordinate - Is changed by Move but not by attachments or manual moving of the window and may differ from XPos(). | ||
| y | SHORT | y-coordinate - Is changed by Move but not by attachments or manual moving of the window and may differ from YPos(). This value initially corresponds to the value specified in the source code. | ||
| searchID | SHORT | Type of the widget, for example, ID_PROMPT |
* I = Indexable data field,
grey background = inherited data field
| Module | Brief description |
|---|---|
| windows.mod | open windows |
;){kind=link}
;){kind=link}
;){kind=link}
;){kind=link}
;){kind=link}
;){kind=link}
;){kind=link}
;){kind=link}