MDrivenDesignerTaggedValueHints
No edit summary
No edit summary
(46 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Intention of this info is to be downloaded by MDrivenDesigner at startup to guide what tagged value can be used where.
The intention of this information is to be downloaded by MDrivenDesigner at startup to guide what tagged value can be used where.


'''All valid Tagged values must be added here'''
'''All valid Tagged values must be added here.'''
  #TargetType.<Modernity.>Function
  #TargetType.<Modernity.>Function
We deliberately skip the ones that has Designer properties already
We deliberately skip the ones that have Designer properties already.
{| class="wikitable"
{| class="wikitable"
!#TargetType.TaggedValue
!#TargetType.TaggedValue
!CommaSeparatedExampleValues
!CommaSeparatedExampleValues
!ShortDescription
!Short Description
|-
|-
|#Column.DataIsImageUrl
|#Column.DataIsImageUrl
|True,False
|True,False
|When set on a ViewModelColumn the data string is treated as an Image URL by Turnkey
|When set on a ViewModelColumn, the data string is treated as an Image URL by Turnkey
|-
|-
|#Column.DataIsLink
|#Column.DataIsLink
|True,False
|True,False
|When set on viewmodelColumn the string data within is treated as a hyperlink
|When set on viewmodelColumn, the string data within is treated as a hyperlink
|-
|-
|#Column.BlobDownloadLink
|#Column.BlobDownloadLink
|True,False
|True,False
|When set on a ViewModelColumn the Blob content can be downloaded by a hyperlink rather than rendered
|When set on a ViewModelColumn, the Blob content can be downloaded by a hyperlink rather than rendered
|-
|-
|#Nesting.Editable
|#Nesting.Editable
|True,False
|True,False
|Nesting that represent grid will render web grid cells as possibly editable (depending on read only expression)
|Nesting that represents the grid will render web grid cells as possibly editable (depending on read-only expression)
|-
|-
|#Column.MaxFetch
|#Column.MaxFetch
Line 31: Line 31:
|#Attribute.ExternalBlobStorage
|#Attribute.ExternalBlobStorage
|True,False
|True,False
|Large files can be kept out of the granular model database.This is a turnkey functionality only - and the the files will be stored (with simplest outofthebox solution) on disk App_Data/BlobStorage
|Large files can be kept out of the granular model database. This is a turnkey functionality only - and the files will be stored (with the simplest out-of-the-box solution) on disk App_Data/BlobStorage
|-
|-
|#Column.StringFormat
|#Column.StringFormat
|<identifier>
|<identifier>
|WPF Only: TaggedValue StringFormat on ViewModel column has precedence for finding a binding Stringformat - normally the stringFormat is taken from <StyleRef>.StringFormat , but if this TV has value - <value>.StringFormat is used
|WPF Only: TaggedValue StringFormat on ViewModel column has precedence for finding a binding Stringformat - normally the stringFormat is taken from <StyleRef>.StringFormat, but if this TV has value - <value>.StringFormat is used. See [[Text_formatting]]
|-
|-
|#Span.MVC
|#Span.MVC
|True,False
|True,False
|The Turnkey WebApplication uses MVC for index and login pages - it defaults to angularjs for all other pages. To get MVC on other pages you must set tagged value MVC=true on ViewModel.
|The Turnkey WebApplication uses MVC for index and login pages - it defaults to angular js for all other pages. To get MVC on other pages you must set the tagged value MVC=true on ViewModel.
|-
|-
|#Column.Angular_Ext_Component
|#Column.Angular_Ext_Component
|<Angular component name>
|<Angular component name>
|Set UIOverride on ViewModelColum - assign this tagged value - turnkey will now look for component definition in EXT_Components folder
|Set UIOverride on ViewModelColum - assign this tagged value - turnkey will now look for a component definition in EXT_Components folder
|-
|-
|#Span.DoNotSearchOnEnter
|#Span.DoNotSearchOnEnter
|Existence
|Existence
|UI's in wecpof will search on enter is it has seek expressions - you can turn this off by defining this TV on the ViewModel level
|UI's in WECPOF will search on enter as it has seek expressions - you can turn this off by defining this TV on the ViewModel level
|-
|-
|#Span.Bootstrap.ClassPrefix
|#Span.Bootstrap.ClassPrefix
Line 67: Line 67:
|#Nesting.MultiSelect
|#Nesting.MultiSelect
|True,False
|True,False
|Allows multi select - you can then expect vSelected_<NameOfNesting> to be maintained
|Allows multi-select - you can then expect vSelected_<NameOfNesting> to be maintained
|-
|-
|#Column.DataIsHtml
|#Column.DataIsHtml
|True,False
|True,False
|When True static fields are treats the data as markup and displays potential html in the browser
|When True static fields treat the data as markup and display potential HTML in the browser
|-
|-
|#Span.Eco.RestAllowed
|#Span.Eco.RestAllowed
|True,False
|True,False
|Enables a viewModel to be accessed with REST api
|Enables a ViewModel to be accessed with REST API (default False)
|-
|#Span.Eco.UIAllowed
|True,False
|Disables a ViewModel to be accessed within the UI (default True)
|-
|#Span.Eco.AutoSave
|True,False
|Enables a viewModel to automatically save all changes without showing the Save/Cancel buttons.
|-
|-
|#Column.XmlAttribute
|#Column.XmlAttribute
|True,False
|True,False
|When using ViewModelAsXml, viewmodel column will be rendered as an XML Attribute
|When using ViewModelAsXml, ViewModel column will be rendered as an XML Attribute
|-
|-
|#Column.XmlChildnode
|#Column.XmlChildnode
|True,False
|True,False
|When using ViewModelAsXml, viewmodel single link column will be rendered as an XML element tree node
|When using ViewModelAsXml, ViewModel single link column will be rendered as an XML element tree node
|-
|-
|#Column.NodeName
|#Column.NodeName
|<name of node>
|<name of node>
|Used to override the XML och JSON node name usually given by the viewmodel column. Used for example to input a - (dash) as a part of the name of an attribute.
|Used to override the XML och JSON node name usually given by the ViewModel column. Used for example to input a - (dash) as a part of the name of an attribute.
|-
|-
|#Column.MaxFileSizeInBytes
|#Column.MaxFileSizeInBytes
Line 99: Line 107:
|#Span.HideSidebar
|#Span.HideSidebar
|True,False
|True,False
|Hide the sidebar on the page
|Hide the sidebar on the page - Note: Use the new HideSidebar checkbox on ViewModel
|-
|#Span.HideMenubar
|True,False
|Hides Menubar for page - Note: Use the new HideMenubar checkbox on ViewModel
|-
|-
|#Span.FixColSize
|#Span.FixColSize
Line 111: Line 123:
|#Column.HideHeading
|#Column.HideHeading
|True,False
|True,False
|Hide heading of the groupbox
|Hide the heading of the groupbox
|-
|-
|#Column.OpenInNewTab
|#Column.OpenInNewTab
Line 123: Line 135:
|#Column.Switch
|#Column.Switch
|True,False
|True,False
|Change checkbox appearance to the switch control.
|Change the checkbox appearance to the switch control.
|-
|-
|#Nesting.CellSelect
|#Nesting.CellSelect
|True,False
|True,False
|In WPF this controls if the grid should get CellSelect from start rather than row select
|In WPF, this controls if the grid should get CellSelect from start rather than row select
|-
|-
|#Column.Placeholder
|#Column.Placeholder
|Placeholder text
|Placeholder text
|Add placeholder text for text and number fields.
|Add placeholder text for text and number fields.
|-
|#Column.autofocus
|True,False
|Focuses the control when it appears on the screen. Might conflict with other focus events.
|-
|#Column.autocomplete
|True, False
|Hint for form autofill feature (disabled by default for every input field)
|-
|-
|#Nesting.FrozenColumns
|#Nesting.FrozenColumns
Line 143: Line 163:
|#Column.XmlParentValue
|#Column.XmlParentValue
|True,False
|True,False
|Makes the attribute's value appear as the parent element's value instead of an element. Note! If used on more that one attribute on the same viewmodel class, the result is undefined.
|Makes the attribute's value appear as the parent element's value instead of an element. Note: if used on more than one attribute on the same ViewModel class, the result is undefined.
|-
|-
|#Column.Resizable
|#Column.Resizable
|True,False
|True,False
|Make the textarea element resizable
|Make the text area element resizable
|-
|-
|#Column.Eco.ImageWidth
|#Column.Eco.ImageWidth
Line 159: Line 179:
|#Column.FormatAttr
|#Column.FormatAttr
|
|
|Sets the angular format attribute that controls text rendering
|Sets the angular format attribute that controls text rendering. Use StringFormatAngular instead
|-
|#Column.StringFormatAngular
|
|Sets the angular format attribute that controls text rendering. Replaces the FormatAttr to resemble WPF and Razor. See [[Text_formatting]]
|-
|#Column.StringFormatRazor
|
|Sets the Razor format attribute that controls text rendering. Replaces the FormatAttr to resemble WPF and Angular. See [[Text_formatting]]
|-
|#Column.Texttype
|password,email,tel,url,search
|For inputs intended as type text, this type can be overridden with something else
|-
|#Attribute.Eco.BlobType
|SVG,XamlSymbol,Image,Blob,RichText
|Set on attributes of classes to influence how a binary array or Text field should be interpreted
|-
|#Column.Eco.BlobType
|SVG,XamlSymbol,Image,Blob,RichText
|Set on Column to influence how a binary array or Text field should be interpreted
|-
|#Nesting.Striped
|True,False
|Adds the striped style to your table
|-
|#Span.ModalSize
|narrow,large,veryLarge
|Choose the size of the modal window which will contain your ViewModel
|-
|#Nesting.IsSeekerResultGrid
|True,False
|Seeker page logic uses this to show buttons in the grid
|-
|#Attribute.Realtime
|True,False
|If changed it will be invalidated in all clients upon saving asap - ie by an active push from the server
|-
|#Column.Icon
|
|Set the icon to your action from the default [https://material.io/resources/icons/?style=baseline Material Design icons pack]
|-
|#Column.IconPosition
|before,after
|Choose the position of the icon inside your action button. By default, the icon is placed before the button text.
|-
|#Column.IconButton
|True,False
|Displays just the icon instead of the button text.
|-
|#Column.IconInInput
|True,False
|Enable this Tagged value to put the icon inside the input control instead of the label.
|-
|#Nesting.ClientSortable
|True,False
|Makes all columns in the table sortable by clicking on the header. Can be overridden on each column. Defaults to True for tables that are not seeker results.
|-
|#Column.ClientSortable
|True,False
|Makes the column sortable by clicking on the header. Default is inherited from the table. Default is False in Seekers
|-
|#Column.SeekerSortable
|True,False
|Makes the column sortable by clicking on the header in a Seeker.
|-
|#Nesting.Eco.SeekerDefaultOrderColumnName
|
|Name of the attribute in the OrderExpression ViewModel class to use when a result is found by using this search expression
|-
|#Nesting.Eco.HiliteGridColumn
|
|Viewmodel name of the SearchResultGrid result and the Name of the attribute in that ViewModel in the format <ViewModelName>.<AttributeName>. This column will be highlighted (coloured) when the result is found by using this search expression
|-
|#Span.XmlRootTag
|
|Influence root tag used in [[OCLOperators ViewModelAsXml|ViewModelAsXML]]
|-
|#Span.SkipWhenBacking
|True,False
|When pressing back into this view we skip and move to the view before - (Implemented in WPF) - Good if you have a switchboard view that automatically navigates somewhere
|-
|#Nesting.ShowOldContextMenu
|True,False
|If this option is enabled - the old context menu will appear instead of the new one.
|-
|#Column.TaJsonTreatListAsDynamicProperties
|True,False
|When this is true, we read the nesting in the ViewModel object and look for Name and Value properties - we then use the result as properties on the resulting json object
|-
|#Column.TaJsonTreatListAsValues
|True,False
|When this is true, we generate a json array of the first column in the ViewModel nesting. This gives a json array of values rather than of objects.
|-
|#Column.SkipStyleLogic
|True,False
|To be used when _Style column is not to be interpreted as a style name in Xaml or CSS-class in HTML - instead, it is just data picked up by some other style's binding - or HTML style info
|-
|#Attribute.AllowMVCAccess
|ok,notok,okwhenauthenticated
|The GetImage of MVC - this is the default "ok" for byte[] and default not ok for strings
|-
|#Nesting.IncludeCurrentAndSelectedVariables
|True,False
|Default True, which includes vCurrent and vSelected as data in a streaming [[ViewModel|ViewModel]]. Used when easy access to current and selected row are not wanted when databinding.
|-
|#Column.DesignTimeColor
|Red,Green,Blue,#1278FF
|This sets a background color of the ViewModel column in the ViewModel tree - it is a design time help
|-
|#Column.RawJSon
|True,False
|When using AsTajson you may want to inject snippets of already formatted json into the tree
|-
|#Span.Savebar
|True,False
|Shows a "savebar" at the top of the screen when unsaved changes exists. Also shows Undo/Redo buttons. Will also hide the left sidebar.
|}
|}
[[Category:MDriven Designer]]
[[Category:Tagged Values]]

Revision as of 16:23, 25 March 2023

The intention of this information is to be downloaded by MDrivenDesigner at startup to guide what tagged value can be used where.

All valid Tagged values must be added here.

#TargetType.<Modernity.>Function

We deliberately skip the ones that have Designer properties already.

#TargetType.TaggedValue CommaSeparatedExampleValues Short Description
#Column.DataIsImageUrl True,False When set on a ViewModelColumn, the data string is treated as an Image URL by Turnkey
#Column.DataIsLink True,False When set on viewmodelColumn, the string data within is treated as a hyperlink
#Column.BlobDownloadLink True,False When set on a ViewModelColumn, the Blob content can be downloaded by a hyperlink rather than rendered
#Nesting.Editable True,False Nesting that represents the grid will render web grid cells as possibly editable (depending on read-only expression)
#Column.MaxFetch <int> Declare "MaxFetch=<int>" on the ViewModelColumn action that initiates the search to change from the default (100)
#Attribute.ExternalBlobStorage True,False Large files can be kept out of the granular model database. This is a turnkey functionality only - and the files will be stored (with the simplest out-of-the-box solution) on disk App_Data/BlobStorage
#Column.StringFormat <identifier> WPF Only: TaggedValue StringFormat on ViewModel column has precedence for finding a binding Stringformat - normally the stringFormat is taken from <StyleRef>.StringFormat, but if this TV has value - <value>.StringFormat is used. See Text_formatting
#Span.MVC True,False The Turnkey WebApplication uses MVC for index and login pages - it defaults to angular js for all other pages. To get MVC on other pages you must set the tagged value MVC=true on ViewModel.
#Column.Angular_Ext_Component <Angular component name> Set UIOverride on ViewModelColum - assign this tagged value - turnkey will now look for a component definition in EXT_Components folder
#Span.DoNotSearchOnEnter Existence UI's in WECPOF will search on enter as it has seek expressions - you can turn this off by defining this TV on the ViewModel level
#Span.Bootstrap.ClassPrefix col-xs- Alter the default Bootstrap column prefix from col-sm- to something else
#Span.Bootstrap.StaticSections Existence The view parts above the topmost splitter and below the bottom-most splitters will be static in the browser. The middle section scrolls.
#Method.Eco.ExternalLateBound Existence If TV is set the ExternalLateBound logic is searched for implementation of this method
#Span.CSSGrid True,False If this is true then MVC and angular views will Render with CSSGrid instead of with Bootstrap
#Nesting.MultiSelect True,False Allows multi-select - you can then expect vSelected_<NameOfNesting> to be maintained
#Column.DataIsHtml True,False When True static fields treat the data as markup and display potential HTML in the browser
#Span.Eco.RestAllowed True,False Enables a ViewModel to be accessed with REST API (default False)
#Span.Eco.UIAllowed True,False Disables a ViewModel to be accessed within the UI (default True)
#Span.Eco.AutoSave True,False Enables a viewModel to automatically save all changes without showing the Save/Cancel buttons.
#Column.XmlAttribute True,False When using ViewModelAsXml, ViewModel column will be rendered as an XML Attribute
#Column.XmlChildnode True,False When using ViewModelAsXml, ViewModel single link column will be rendered as an XML element tree node
#Column.NodeName <name of node> Used to override the XML och JSON node name usually given by the ViewModel column. Used for example to input a - (dash) as a part of the name of an attribute.
#Column.MaxFileSizeInBytes 10000000 Limits Blobs and Images to a maximum size of the file (primarily web).
#Column.AcceptFiles image/*,.pdf Rendered in HTML on the <input> file tag as the "accept" attribute. For more info, search for the "accept" attribute.
#Span.HideSidebar True,False Hide the sidebar on the page - Note: Use the new HideSidebar checkbox on ViewModel
#Span.HideMenubar True,False Hides Menubar for page - Note: Use the new HideMenubar checkbox on ViewModel
#Span.FixColSize True,False Set equal columns size on the page
#Column.FixColSize True,False Set equal columns size inside the groupboxes
#Column.HideHeading True,False Hide the heading of the groupbox
#Column.OpenInNewTab True,False Open the link in the new browser tab
#Nesting.Eco.WECPOFDoubleClickAction None,DefaultAction,ModalOkPrecedence Implemented for WPF but should follow in Turnkey. Controls what should happen on Grid double click.
#Column.Switch True,False Change the checkbox appearance to the switch control.
#Nesting.CellSelect True,False In WPF, this controls if the grid should get CellSelect from start rather than row select
#Column.Placeholder Placeholder text Add placeholder text for text and number fields.
#Column.autofocus True,False Focuses the control when it appears on the screen. Might conflict with other focus events.
#Column.autocomplete True, False Hint for form autofill feature (disabled by default for every input field)
#Nesting.FrozenColumns 1,2 In WPF DataGrid can freeze leftmost columns from scrolling (aka fixedcolumns)
#Attribute.CheckIdNameConflict True,False Avoids warning about naming conflicts between a table and the automatically named ID columns when generating a SQL database
#Column.XmlParentValue True,False Makes the attribute's value appear as the parent element's value instead of an element. Note: if used on more than one attribute on the same ViewModel class, the result is undefined.
#Column.Resizable True,False Make the text area element resizable
#Column.Eco.ImageWidth 20,30,40 Controls WPF Images in Grids default is 20
#Column.Eco.ImageHeight 20,30,40 Controls WPF Images in Grids default is 20
#Column.FormatAttr Sets the angular format attribute that controls text rendering. Use StringFormatAngular instead
#Column.StringFormatAngular Sets the angular format attribute that controls text rendering. Replaces the FormatAttr to resemble WPF and Razor. See Text_formatting
#Column.StringFormatRazor Sets the Razor format attribute that controls text rendering. Replaces the FormatAttr to resemble WPF and Angular. See Text_formatting
#Column.Texttype password,email,tel,url,search For inputs intended as type text, this type can be overridden with something else
#Attribute.Eco.BlobType SVG,XamlSymbol,Image,Blob,RichText Set on attributes of classes to influence how a binary array or Text field should be interpreted
#Column.Eco.BlobType SVG,XamlSymbol,Image,Blob,RichText Set on Column to influence how a binary array or Text field should be interpreted
#Nesting.Striped True,False Adds the striped style to your table
#Span.ModalSize narrow,large,veryLarge Choose the size of the modal window which will contain your ViewModel
#Nesting.IsSeekerResultGrid True,False Seeker page logic uses this to show buttons in the grid
#Attribute.Realtime True,False If changed it will be invalidated in all clients upon saving asap - ie by an active push from the server
#Column.Icon Set the icon to your action from the default Material Design icons pack
#Column.IconPosition before,after Choose the position of the icon inside your action button. By default, the icon is placed before the button text.
#Column.IconButton True,False Displays just the icon instead of the button text.
#Column.IconInInput True,False Enable this Tagged value to put the icon inside the input control instead of the label.
#Nesting.ClientSortable True,False Makes all columns in the table sortable by clicking on the header. Can be overridden on each column. Defaults to True for tables that are not seeker results.
#Column.ClientSortable True,False Makes the column sortable by clicking on the header. Default is inherited from the table. Default is False in Seekers
#Column.SeekerSortable True,False Makes the column sortable by clicking on the header in a Seeker.
#Nesting.Eco.SeekerDefaultOrderColumnName Name of the attribute in the OrderExpression ViewModel class to use when a result is found by using this search expression
#Nesting.Eco.HiliteGridColumn Viewmodel name of the SearchResultGrid result and the Name of the attribute in that ViewModel in the format <ViewModelName>.<AttributeName>. This column will be highlighted (coloured) when the result is found by using this search expression
#Span.XmlRootTag Influence root tag used in ViewModelAsXML
#Span.SkipWhenBacking True,False When pressing back into this view we skip and move to the view before - (Implemented in WPF) - Good if you have a switchboard view that automatically navigates somewhere
#Nesting.ShowOldContextMenu True,False If this option is enabled - the old context menu will appear instead of the new one.
#Column.TaJsonTreatListAsDynamicProperties True,False When this is true, we read the nesting in the ViewModel object and look for Name and Value properties - we then use the result as properties on the resulting json object
#Column.TaJsonTreatListAsValues True,False When this is true, we generate a json array of the first column in the ViewModel nesting. This gives a json array of values rather than of objects.
#Column.SkipStyleLogic True,False To be used when _Style column is not to be interpreted as a style name in Xaml or CSS-class in HTML - instead, it is just data picked up by some other style's binding - or HTML style info
#Attribute.AllowMVCAccess ok,notok,okwhenauthenticated The GetImage of MVC - this is the default "ok" for byte[] and default not ok for strings
#Nesting.IncludeCurrentAndSelectedVariables True,False Default True, which includes vCurrent and vSelected as data in a streaming ViewModel. Used when easy access to current and selected row are not wanted when databinding.
#Column.DesignTimeColor Red,Green,Blue,#1278FF This sets a background color of the ViewModel column in the ViewModel tree - it is a design time help
#Column.RawJSon True,False When using AsTajson you may want to inject snippets of already formatted json into the tree
#Span.Savebar True,False Shows a "savebar" at the top of the screen when unsaved changes exists. Also shows Undo/Redo buttons. Will also hide the left sidebar.
This page was edited 47 days ago on 02/10/2024. What links here