Class ItemBoxManager
Itembox-manager for working with item boxes
Inheritance
Inherited Members
Namespace: Simplic.Framework.DBUI
Assembly: Simplic.Framework.DBUI.dll
Syntax
public class ItemBoxManager
Methods
| Improve this Doc View SourceDoesItemBoxExists(String, String)
Check wether an ItemBox exists
Declaration
public static bool DoesItemBoxExists(string ItemBoxName, string ConnectionName)
Parameters
Type | Name | Description |
---|---|---|
System.String | ItemBoxName | |
System.String | ConnectionName |
Returns
Type | Description |
---|---|
System.Boolean | True if the ItemBox exists |
GetItemBox(ItemBoxConfiguration, String[], String, String, Boolean)
Get itembox from configuration
Declaration
public static AsyncItemBox GetItemBox(ItemBoxConfiguration configuration, string[] parameter, string ConnectionName = "Default", string DataConnectionString = "", bool SelectFirstIfOnly = false)
Parameters
Type | Name | Description |
---|---|---|
ItemBoxConfiguration | configuration | Configuration instance |
System.String[] | parameter | Parameter |
System.String | ConnectionName | Name of the connection string, default is "Default" |
System.String | DataConnectionString | Name of the connection string, where the data can be loaded from, default must be empty |
System.Boolean | SelectFirstIfOnly | Defines, if only one item is loaded in the itembox, it will be selected immediately |
Returns
Type | Description |
---|---|
AsyncItemBox | Instance of an itembox. The itembox can be shown with .ShowDialotg(). The returned value is available over .GetSelectedItemCell(Columns-Name). |
GetItemBoxFromDB(String, String, String, Boolean)
Create a new itembox by an itembox configuration. The itembox can be shown with the .ShowDialog() method.
Declaration
public static AsyncItemBox GetItemBoxFromDB(string ItemBoxName, string ConnectionName = "Default", string DataConnectionString = "", bool SelectFirstIfOnly = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | ItemBoxName | Name of the itembox in the configurator |
System.String | ConnectionName | Name of the connection string, default is "Default" |
System.String | DataConnectionString | Name of the connection string, where the data can be loaded from, default must be empty |
System.Boolean | SelectFirstIfOnly | Defines, if only one item is loaded in the itembox, it will be selected immediately |
Returns
Type | Description |
---|---|
AsyncItemBox | Instance of an itembox. The itembox can be shown with .ShowDialotg(). The returned value is available over .GetSelectedItemCell(Columns-Name). |