Changes
Created page with "==Purpose== [[File:UI_BulkEditor.png|thumb|200px|Bulk Editor control]] The Bulk Editor is designed to display and edit the [[BaseProperty|properties]] of a multiple {{UBIK}} o..."
==Purpose==
[[File:UI_BulkEditor.png|thumb|200px|Bulk Editor control]]
The Bulk Editor is designed to display and edit the [[BaseProperty|properties]] of a multiple {{UBIK}} objects. Technically, it reads the [[MetaProperty]] definition of each [[Instance|instance]] of the context object (directly from the context object if it is of type [[MetaClass]], otherwise it gets the MetaClass of the context object and reads the definition from its instances.
==Basics==
===Appearance===
====Toolbar====
====Rows and columns====
The control reads the the current context object and displays a row for each instance of it and a column for each found property, its appearance depending on the respective data type of the [[MetaProperty]]. The following data types and thus different columns and editing controls are currently supported:
{| class="wikitable" | width = "50%"
|-
! Data type!! Example !! Comment
|- align="left"
| [[Bool]] || [[File:UI_BulkEditor_Bool.png|300px]] || True or false to be read/set via a Checkbox
|- align="left"
| [[ByteStream]]|| - ||Internal type, will not result in an editing control
|- align="left"
| [[DateTime]] || [[File:UI_BulkEditor_DateTime.png|300px]] || Date and time in a combined value; format according to regional settings; a double click opens a dialog to pick a date from a calendar
|- align="left"
| [[Double]] || - || [http://en.wikipedia.org/wiki/Double-precision_floating-point_format Double-precision floating-point format], optionally with [[Unit|unit of measurement]]
|- align="left"
| [[FileReference]]|| - || A path to a physical file in [http://en.wikipedia.org/wiki/Path_(computing)#MS-DOS.2FMicrosoft_Windows_style DOS/Windows]- or [http://en.wikipedia.org/wiki/Path_(computing)#Uniform_Naming_Convention UNC] notation; a double click opens a dialog to pick a file from the file system
|- align="left"
| [[GeoData]] || [[File:UI_BulkEditor_GEO.png|300px]] || Absolute geographic position combined of [http://en.wikipedia.org/wiki/Longitude Longitude], [http://en.wikipedia.org/wiki/Latitude Latitude] and [http://en.wikipedia.org/wiki/Altitude Altitude] in [http://en.wikipedia.org/wiki/World_Geodetic_System WGS84] format; a double click opens a dialog to enter the values separately
|- align="left"
| [[Guid]]|| [[File:UI_BulkEditor_GUID.png|300px]] || Pointer to another object, represented with the [http://en.wikipedia.org/wiki/Globally_unique_identifier GUID] of the target object
|- align="left"
| [[Reference]]|| [[File:UI_BulkEditor_Reference.png|300px]] || Pointer to another object via a reference; a double click opens a picker to select the target object
|- align="left"
| [[Int]]|| - || An [http://en.wikipedia.org/wiki/Integer_(computer_science) integer] number
|- align="left"
| [[String]]|| - || A [http://en.wikipedia.org/wiki/String_(computer_science) string] value
|- align="left"
| [[Undefined]]|| - ||Internal type, will not result in an editing control
|- align="left"
| [[XML]]|| - || Markup text in [http://en.wikipedia.org/wiki/Xml XML] format; currently displayed as raw string by this control
|}
====Selective lists====
If a certain property has a [[Selective list|selective list]] defined, the respective column will display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.
====Index values====
If a certain property has [[Index value|index values]] defined, the respective column will be colored <span style="background:LightSalmon;">LightSalmon</span> and become expandable. Expanding/collapsing can be done by either right clicking the column header or using the expand/collapse button in the Toolbar. When expanding, the editing column will multiply itself by the number of index values and present an own <span style="background:LightYellow;">LightYellow</span> column for each index value.
{{Hint|A multilanguage MetaProperty is actually a string property with index values defined for each system language!}}
====Captions====
* each column shows the string representation of the respective MetaProperty as its header text
* the first column of each row is always titled ''_RowObject'' and shows the string representation of the corresponding instance
====Tooltips====
There are two kinds of Tooltips used in this control:
* when hovering over the header of column, a Tooltip will show the type of the column
* when hovering over a cell which's text is deprecated, a Tooltip will show the full text
===Editing===
When editing a value, it will only be written back to the respective property when you leave the cell. At that very point in time, the Bulk Editor also runs an integrity check against the [[Rule|rules]] and tests if the value you've entered can be stored on the property. If this fails, the row and cell will show a red exclamation mark with a Tooltip telling which rule was violated. The exclamation mark on the cell disappears once you've entered a valid value for this property, the exclamation mark on the row only disappears if all properties of the respective {{UBIK}} object have a valid value.
{{Hint| While editing a value, you can use {{key press|ESC}} to undo your editing!}}
===Drag & Drop===
The Object Editor control is a source and a target for Drag&Drop operations:
* Any object can be dropped on a cell if the dragged object matches the data type of the respective property
* A single instance object can be dragged from the Bulk Edito by dragging the header of the row
* Objects stored in a cell can be dragged using the right mouse button
==Toolbar==
{| class="wikitable" | width = "50%"
|-
! Control !! Purpose
|- align="left"
| View Style || Indicates or changes the [[#View Style|View Style]] of the control; changing it will result in reloading of the control
|- align="left"
| Navigate to context object || Attempts to [[Navigation|navigate]] to the current context MetaClass.
|- align="left"
| Save || Saves the context object.
|}
==Context menu==
This control doesn't feature any context menu yet.
==View Styles==
The Object Editor has two different View Styles, each of them providing different views and functionality.
===List===
The control will display the properties in a list, sorted according to the property ''ORDERID''
===Layouted===
No functionality yet.
==Other functionality==
[[Category:UBIK Studio Controls]]
[[File:UI_BulkEditor.png|thumb|200px|Bulk Editor control]]
The Bulk Editor is designed to display and edit the [[BaseProperty|properties]] of a multiple {{UBIK}} objects. Technically, it reads the [[MetaProperty]] definition of each [[Instance|instance]] of the context object (directly from the context object if it is of type [[MetaClass]], otherwise it gets the MetaClass of the context object and reads the definition from its instances.
==Basics==
===Appearance===
====Toolbar====
====Rows and columns====
The control reads the the current context object and displays a row for each instance of it and a column for each found property, its appearance depending on the respective data type of the [[MetaProperty]]. The following data types and thus different columns and editing controls are currently supported:
{| class="wikitable" | width = "50%"
|-
! Data type!! Example !! Comment
|- align="left"
| [[Bool]] || [[File:UI_BulkEditor_Bool.png|300px]] || True or false to be read/set via a Checkbox
|- align="left"
| [[ByteStream]]|| - ||Internal type, will not result in an editing control
|- align="left"
| [[DateTime]] || [[File:UI_BulkEditor_DateTime.png|300px]] || Date and time in a combined value; format according to regional settings; a double click opens a dialog to pick a date from a calendar
|- align="left"
| [[Double]] || - || [http://en.wikipedia.org/wiki/Double-precision_floating-point_format Double-precision floating-point format], optionally with [[Unit|unit of measurement]]
|- align="left"
| [[FileReference]]|| - || A path to a physical file in [http://en.wikipedia.org/wiki/Path_(computing)#MS-DOS.2FMicrosoft_Windows_style DOS/Windows]- or [http://en.wikipedia.org/wiki/Path_(computing)#Uniform_Naming_Convention UNC] notation; a double click opens a dialog to pick a file from the file system
|- align="left"
| [[GeoData]] || [[File:UI_BulkEditor_GEO.png|300px]] || Absolute geographic position combined of [http://en.wikipedia.org/wiki/Longitude Longitude], [http://en.wikipedia.org/wiki/Latitude Latitude] and [http://en.wikipedia.org/wiki/Altitude Altitude] in [http://en.wikipedia.org/wiki/World_Geodetic_System WGS84] format; a double click opens a dialog to enter the values separately
|- align="left"
| [[Guid]]|| [[File:UI_BulkEditor_GUID.png|300px]] || Pointer to another object, represented with the [http://en.wikipedia.org/wiki/Globally_unique_identifier GUID] of the target object
|- align="left"
| [[Reference]]|| [[File:UI_BulkEditor_Reference.png|300px]] || Pointer to another object via a reference; a double click opens a picker to select the target object
|- align="left"
| [[Int]]|| - || An [http://en.wikipedia.org/wiki/Integer_(computer_science) integer] number
|- align="left"
| [[String]]|| - || A [http://en.wikipedia.org/wiki/String_(computer_science) string] value
|- align="left"
| [[Undefined]]|| - ||Internal type, will not result in an editing control
|- align="left"
| [[XML]]|| - || Markup text in [http://en.wikipedia.org/wiki/Xml XML] format; currently displayed as raw string by this control
|}
====Selective lists====
If a certain property has a [[Selective list|selective list]] defined, the respective column will display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.
====Index values====
If a certain property has [[Index value|index values]] defined, the respective column will be colored <span style="background:LightSalmon;">LightSalmon</span> and become expandable. Expanding/collapsing can be done by either right clicking the column header or using the expand/collapse button in the Toolbar. When expanding, the editing column will multiply itself by the number of index values and present an own <span style="background:LightYellow;">LightYellow</span> column for each index value.
{{Hint|A multilanguage MetaProperty is actually a string property with index values defined for each system language!}}
====Captions====
* each column shows the string representation of the respective MetaProperty as its header text
* the first column of each row is always titled ''_RowObject'' and shows the string representation of the corresponding instance
====Tooltips====
There are two kinds of Tooltips used in this control:
* when hovering over the header of column, a Tooltip will show the type of the column
* when hovering over a cell which's text is deprecated, a Tooltip will show the full text
===Editing===
When editing a value, it will only be written back to the respective property when you leave the cell. At that very point in time, the Bulk Editor also runs an integrity check against the [[Rule|rules]] and tests if the value you've entered can be stored on the property. If this fails, the row and cell will show a red exclamation mark with a Tooltip telling which rule was violated. The exclamation mark on the cell disappears once you've entered a valid value for this property, the exclamation mark on the row only disappears if all properties of the respective {{UBIK}} object have a valid value.
{{Hint| While editing a value, you can use {{key press|ESC}} to undo your editing!}}
===Drag & Drop===
The Object Editor control is a source and a target for Drag&Drop operations:
* Any object can be dropped on a cell if the dragged object matches the data type of the respective property
* A single instance object can be dragged from the Bulk Edito by dragging the header of the row
* Objects stored in a cell can be dragged using the right mouse button
==Toolbar==
{| class="wikitable" | width = "50%"
|-
! Control !! Purpose
|- align="left"
| View Style || Indicates or changes the [[#View Style|View Style]] of the control; changing it will result in reloading of the control
|- align="left"
| Navigate to context object || Attempts to [[Navigation|navigate]] to the current context MetaClass.
|- align="left"
| Save || Saves the context object.
|}
==Context menu==
This control doesn't feature any context menu yet.
==View Styles==
The Object Editor has two different View Styles, each of them providing different views and functionality.
===List===
The control will display the properties in a list, sorted according to the property ''ORDERID''
===Layouted===
No functionality yet.
==Other functionality==
[[Category:UBIK Studio Controls]]
