K2BWebPanelDesignerSettings

Introduction

K2BWebPanelDesigner settings are the main way of altering how the tool works for a particular KB.

Also, some methods to apply global changes that affect all web panels generated using K2BWebPanelDesigner are included as actions on this object.

Location

This object can be found in the "Preferences" section of the Knowledge Base Navigator, under the "K2B Object Designer" category.


Web Panel Designer Settings Location

Properties

Category	Name	Value
General	Set Object Theme	Determines if K2BWebPanelDesigner should set the theme on generated web panels.
General	Descriptions Layout	Contains the value that should be used as a default in the property "Descriptions Layout" in Attributes node nodes.
Standard Web Form	Theme	Theme that should be used in web panels generated using K2BWebPanelDesigner. Will be applied to object if property "SetObjectTheme" is set to true.
Standard Web Form	Layout Object	Contains the layout object used when generating the web form in web panels. See K2BWebPanelDesigner HTML Editor Layout Object.
UX	Default UX Configuration	Determines the default interface that will be generated. Currently, the possible options are: K2BFlat (using RWD, Smooth User Experience, and K2BFlat theme). This is the preferred option. K2BModern (non-RWD, K2BModern theme, Evolution 2-like experience). This option is provided to guarantee backwards compatibility.
Responsive Web Form	Responsive Theme	Theme that should be used in web panels generated using K2BWebPanelDesigner when using the "Responsive" web form generator. Will be applied to object if property "SetObjectTheme" is set to true.
Responsive Web Form	Responsive Layout Object	Contains the layout object used when generating the web form in web panels when using the "Responsive" web form generator. See K2BWebPanelDesigner Abstract Layout Editor Layout Object.
Grid	Page	Contains the value that should be used as a default in the property "Page" in Grid node nodes.
	Add User Subroutines To Paging Events	Determines if paging events user subroutines should be generated. These subroutines are documented in the Grid node page.
	Save Grid State	Contains the value that should be used as a default in the property "Save Grid State" in Grid node nodes.
	On Change Order	Determines which action should be taken when the final user changes the order by which the data in a grid is displayed. Possible values are: GoToFirstPage: The grid will be moved to the first page. StayOnCurrentPage: The grid will stay on the page it's currently on.
	Generate Grid Settings	Determines if grids should contain a grid settings control.
	Grid Settings Label	The string that should be used in the title of the grid settings control (used only if Generate Grid Settings is set to true). See this page for more information.
	Grid Settings Save Label	The string that should be used in the save button of the grid settings control (used only if Generate Grid Settings is set to true). See this page for more information.
	Available Conditional Classes	Contains a comma-separated list of theme class names that may be used in Conditional Theme Classes properties.
	Allow Runtime Column Selection	Determines if the grids are generated with Runtime column selection or not by default.
	Page Options	Determines the default available options for the Rows Per Page field in grids generated with Web Panel Designer. See this page for more information.
	Show Actions Only If Available	Determines if actions contained in grids should only be visible when avilable by default. This behaviour can be overriden in each action. See Show Action Only If Available option for more information.
	Use Pagination Bar	Determines if a Pagination Bar should be generated when generating grids using the RWD generator.
	No Results Label	The string that should be used when generating a grid for the case when no elements are found.
Grid\Caption	Ordered By	The string that should be used as the word "Ordered By" when generating Grids. Useful when translating the KB.
	Search	The string that should be used as the word "Search" when generating Grids. Useful when translating the KB.
	Page Caption	The string that should be used as the word "Page" when generating Grids. Useful when translating the KB.
	Page Of Caption	The string that should be used as the word "Page Of" when generating Grids. Useful when translating the KB.
	Filters	The string that should be used as the word "Filters" when generating Grids. Useful when translating the KB.
Grid\Filters	Generate Date Filters	Determines if date filters should be added when adding a grid from a transaction. If set to true, filters ("from" and "to") will be generated for each date attribute present in the transaction as a default. See Add Grid From Transaction action
	Generate Date Time Filters	Determines if datetime filters should be added when adding a grid from a transaction. If set to true, filters ("from" and "to") will be generated for each datetime attribute present in the transaction as a default. See Add Grid From Transaction action
	Label Date From	The string that should be used as the word "From" when generating default date or datetime filters in Grids. Useful when translating the KB.
	Label Date To	The string that should be used as the word "To" when generating default date or datetime filters in Grids. Useful when translating the KB.
	Search Button Layout	Determines the position of the "Search" button relative to the filters when generating Filters in a Grid node. Possible values: Right: Positions the button on the right side of the filters Bottom: Positions the button below the filters
	String Search	Determines the default condition that should be used when a filter based on a string attribute is added. The default value is "<attName> like &<varName>". Using this value, if a filter named "UserCity" based on an attribute called "CityName" is created, then the default condition will be "CityName like &UserCity". As an example of this property's usage, the developer may wish that all filters act using a "contains" logic. To achieve this, the developer may change this property's value to '<attName> like "%"+&<varName>+"%" '.
	Filter Description Layout	Contains the value that should be used as a default in the property "Filter Description Layout" in Filters nodes.
	Search Button Image	Contains the image that should be used to generate the "Search" button in Filters nodes.
	Search Button Class	Contains the theme class that should be used when generating the "Search" button in Filters nodes.
Grid \ Filters \ MultipleFilters \ MultipleCombo	Summary Max Visible Items	Contains the default value for the "Summary Max Visible Items" property in Filter variable nodes in K2BWebPanelDesigner instances.
	Allow Search In List	Contains the default value for the "Allow Search In List" property in Filter variable nodes in K2BWebPanelDesigner instances.
	Search In List Invite Message	Contains the default value for the "Search In List Invite Message" property in Filter variable nodes in K2BWebPanelDesigner instances.
	Generate Clear Selection Action	Contains the default value for the "Generate Clear Selection Action" property in Filter variable nodes in K2BWebPanelDesigner instances.
	Clear Selection Action Caption	Contains the caption for "Clear Selection" attributes in Multiple Combo filters.
	Clear Selection Action Image	Contains the image for "Clear Selection" attributes in Multiple Combo filters.
	Expand Label Caption	Contains the "expand" symbol for Multiple Combo filters.
Grid \ Filters \ MultipleFilters \ TagsCollection	Filter Invite Message	Invite message shown in the filter by default when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Tags Columns	Amount of columns used for the tag collection when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Add Tag Action Caption	Caption for the "Add" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Add Tag Action Image	Image for the "Add" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Add Tag Action Tooltip	Tooltip for the "Add" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Add Tag Action Alternate Text	Alternate Text for the "Add" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Add Tag Action Class	Class for the "Add" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Remove Tag Action Caption	Caption for the "Remove Tag" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Remove Tag Action Image	Image for the "Remove Tag" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Remove Tag Action Class	Class for the "Remove Tag" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Remove Tag Action Tooltip	Tooltip for the "Remove Tag" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
	Remove Tag Action Alternate Text	Alternate Text for the "Remove Tag" action when generating "TagsCollection" multiple filters in Web Panel Designer. See Multiple filters.
Grid \ Filters \ Advanced Filters	Advanced Filters Title	Title that should be shown when generating an Advanced Filters section.
	Advanced Filters Empty State Text	Text that will be shown when generating an Advanced Filters section, if no filters are selected.
	Add Filter Action Caption	Caption for the "Add filter" action in Advanced Filters sections.
	Add Filter Action Image	Image for the "Add filter" action in Advanced Filters sections.
	Add Filter Action Tooltip	Tooltip for the "Add filter" action in Advanced Filters sections.
	Add Filter Action Alternate Text	Alternate Text for the "Add filter" action in Advanced Filters sections.
	Remove Filter Action Caption	Caption for the "Remove filter" action in Advanced Filters sections.
	Remove Filter Action Image	Image for the "Remove filter" action in Advanced Filters sections.
	Remove Filter Action Tooltip	Tooltip for the "Remove filter" action in Advanced Filters sections.
	Remove Filter Action Alternate Text	Alternate Text for the "Remove filter" action in Advanced Filters sections.
Grid\Tooltip	First Page Tooltip	The string that should be used as the word "First" when generating the paging buttons on Grids. This text will be shown as a tooltip on the "First" button. Useful when translating the KB.
	Previous Page Tooltip	The string that should be used as the word "Previous" when generating the paging buttons on Grids. This text will be shown as a tooltip on the "Previous" button. Useful when translating the KB.
	Next Page Tooltip	The string that should be used as the word "Next" when generating the paging buttons on Grids. This text will be shown as a tooltip on the "Next" button. Useful when translating the KB.
	Last Page Tooltip	The string that should be used as the word "Last" when generating the paging buttons on Grids. This text will be shown as a tooltip on the "Last" button. Useful when translating the KB.
Grid\Orders	Show Order By When Only Simple Orders	Determines if the order by combo should be generated when a grid contains Simple Order nodes and no CompoundOrder nodes.
Grid\Orders	Generate Column Header Sorting In Server	Determines if the sorting feature associated with the click event on a grid's column will be executed in the client or the server. If executed in the client, it will only process the current page, while if executing in the server all rows will be processed, regardless of the page being shown.
Actions	Error More Than One Row Selected	The string that should be displayed when executing a action with row selection if more than one row was selected and the action is set to be a single item action. See Row selection in actions. Useful when translating the KB.
	Execute Combo Action On Click	Indicates if the actions contained in a combo action should be executed when the user selects them in the combo box. If set to false, a separate button outside the combobox will be included to trigger the selected action's execution.
	Error None Rows Selected	The string that should be displayed when executing a action with row selection if no rows were selected. See Row selection in actions. Useful when translating the KB.
	Confirm Message	The message that should be displayed to request confirmation to the user when an action which requires confirmation is executed. Useful when translating the KB. See Confirm property in actions
	Confirm OK	The string that should be displayed in the "OK" button when requesting confirmation to the user before an action which requires confirmation is executed. Useful when translating the KB. See Confirm property in actions
	Confirm Cancel	The string that should be displayed in the "Cancel" button when requesting confirmation to the user before an action which requires confirmation is executed. Useful when translating the KB. See Confirm property in actions
Actions\Combo	Please Select Item Message	The string that should be displayed when the user tries to execute combo actions without choosing one. Useful when translating the KB.
	Combo Selector Width	The width that should be set to the combo when generating a Combobox Action.
	Combo Selector Caption	The string that should be displayed inside the combo box in combo actions prompting the user to select an action. Useful when translating the KB.
	Combo Selector Image Tooltip	The string that should be used as the "Execute" button's tooltip. Useful when translating the KB.
	Combo Selector Image	The image that should be used as the "Execute" button's image.
	Combo Selector Image Width	The width of the "Execute" button.
Layout\Grid Layout	Filters Container	Name of the div containing the Filters in grids.
	Grid Columns Container	Name of the div containing the Columns in grids.
	Order By Container	Name of the div containing the Orders control in grids.
	Paging Caption Container	Name of the div containing the paging caption (which usually shows something similar to "Page x of y") in grids.
	Paging Left Container	Name of the div containing the paging left buttons (typically, the first and previous buttons) in grids.
	Paging Right Container	Name of the div containing the paging right buttons (typically, the next and last buttons) in grids.
	Grid Summary	Name of the div containing the grid's Summary.
	Grid Actions	Name of the div containing the grid's Actions.
Multiple Selection	Add Image	The image to show in the "Add" button in Multiple Selection controls.
Multiple Selection	Remove Image	The image to show in the "Remove" button in Multiple Selection controls.
User Interface	Form Designer Part Position	Determines the position of the designer part in web panels. The possible values for this property are as follows: First: It keeps the current behavior of the Web Panel Designer; the part is the first one displayed in the Web Panel (to the left of the Web Panel). Last: The part is the last one displayed in the Web Panel (to the left of the Web Panel). First If Active: The part is the first one displayed when opening web panels that have the Web Panel Designer enabled and it's the last one displayed in any other case.

Methods

There are two methods the developer can invoke through the settings node, which can be accessed using the contextual menu attached to the settings node.


Access to the methods

This method forces K2BWebPanelDesigner to regenerate all the web panels designed with it. This is useful when altering the settings, as the developer get the effects of changing the property's value on all web panels without having to manually regenerate each web panel.

Generate Security Procedure