Class ItemBoxSelectionProvider

Provider for LookupTextBox which use ItemBox-Technology for data selection

Inheritance

System.Object

ItemBoxSelectionProvider

Implements

IValueSelectionProvider

IDisposable

Namespace: Simplic.Framework.DBUI

Assembly: Simplic.Framework.DBUI.dll

Syntax

public class ItemBoxSelectionProvider : object, IValueSelectionProvider

Constructors

| Improve this Doc View Source

ItemBoxSelectionProvider()

Initialize new LTB

Declaration

public ItemBoxSelectionProvider()

| Improve this Doc View Source

ItemBoxSelectionProvider(String, String, String, String, String, String)

Crate ItemBox-Selection-Provider for a LookupTextBox

Declaration

public ItemBoxSelectionProvider(string itemBoxName, string displayFriendlyColumn, string displayColumn, string identityColumn, string loadByIdentityStatement, string connectionStringName = "Default")

Parameters

Type	Name	Description
System.String	itemBoxName	Name of the ItemBox
System.String	displayFriendlyColumn	Name of the display column, which will be the friendly text of the selected value
System.String	displayColumn	Name of the display column in the read only textbox, such as customer number
System.String	identityColumn	Name of the id column, for example customer ident
System.String	loadByIdentityStatement	The statement which will be used for loading
System.String	connectionStringName	Name of the connection string, default is "Default"

Properties

| Improve this Doc View Source

DisplayColumn

Gets or sets the display column

Declaration

public string DisplayColumn { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

DisplayFriendlyColumn

Gets or sets the friendly column

Declaration

public string DisplayFriendlyColumn { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IdentityColumn

Gets or sets the identity column

Declaration

public string IdentityColumn { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ItemBoxName

Gets or sets the itembox name

Declaration

public string ItemBoxName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

LoadByIdentityStatement

Gets or sets the load by identity statement

Declaration

public string LoadByIdentityStatement { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

LookupTextBox

Gets or sets the depending Lookuptextbox

Declaration

public LookupTextBox LookupTextBox { get; set; }

Property Value

Type	Description
LookupTextBox

| Improve this Doc View Source

StaticParameter

Gets the static parameter list of the current itembox

Declaration

public IList<string> StaticParameter { get; }

Property Value

Type	Description
IList<System.String>

Methods

| Improve this Doc View Source

ClearItemBoxPlaceholder()

Clear all placeholder

Declaration

public void ClearItemBoxPlaceholder()

| Improve this Doc View Source

ClearParameter()

Clear all parameters

Declaration

public void ClearParameter()

| Improve this Doc View Source

DependingLookupTextBoxesChanged(SelectorLookupResult, LookupTextBox)

Will be executed, if a depending lookup textbox content changed

Declaration

public void DependingLookupTextBoxesChanged(SelectorLookupResult result, LookupTextBox lookupTextBox)

Parameters

Type	Name	Description
SelectorLookupResult	result	Result of the textbox
LookupTextBox	lookupTextBox	Instance of the depending lookup textbox

| Improve this Doc View Source

Dispose()

Dispose the current itembox

Declaration

public void Dispose()

| Improve this Doc View Source

Find(Object)

Get a result by it's unique identity

Declaration

public SelectorLookupResult Find(object identity)

Parameters

Type	Name	Description
System.Object	identity	Identity of the dataset to query

Returns

Type	Description
SelectorLookupResult	Return an instance of a lookup result

| Improve this Doc View Source

Find<T, TResult>(Func<T, TResult>)

This method is not implemented for ItemBoxSelectionProvider, becuase it does not use the entity framework for selecting data

Declaration

public SelectorLookupResult Find<T, TResult>(Func<T, TResult> findDelegate)

Parameters

Type	Name	Description
Func<T, TResult>	findDelegate

Returns

Type	Description
SelectorLookupResult	Throws an NotImplemented excpetion

Type Parameters

Name	Description
T
TResult

| Improve this Doc View Source

InitializeDependingLookupTextBox(LookupTextBox, Object[])

Initialize a lookup TextBox for depending value resolving

Declaration

public void InitializeDependingLookupTextBox(LookupTextBox lookupTextBox, params object[] parameter)

Parameters

Type	Name	Description
LookupTextBox	lookupTextBox	LookupTextBOx instance, must be set
System.Object[]	parameter	Initialize parameter

| Improve this Doc View Source

Search(String)

Execute a search if the text in the LTP changed and it will be leaved or enter was pressed

Declaration

public SelectorLookupResult Search(string searchText)

Parameters

Type	Name	Description
System.String	searchText	Text to search

Returns

Type	Description
SelectorLookupResult	Selector result

| Improve this Doc View Source

SetItemBoxPlaceholder(String, String)

Set a placeholder string in the itembox

Declaration

public void SetItemBoxPlaceholder(string key, string value)

Parameters

Type	Name	Description
System.String	key	Name of the placeholder without [ and ]
System.String	value	Value of the placeholder

| Improve this Doc View Source

SetStaticParameter(String)

Adds a parameter in the itembox

Declaration

public void SetStaticParameter(string param)

Parameters

Type	Name	Description
System.String	param

| Improve this Doc View Source

Show(String)

Open the ItemBox and execute the search

Declaration

public SelectorLookupResult Show(string input)

Parameters

Type	Name	Description
System.String	input	Default search string for the currnt IB

Returns

Type	Description
SelectorLookupResult	Selector result

| Improve this Doc View Source

UseStatisSource(StaticIBValueProvider)

Use static source for value selection

Declaration

public void UseStatisSource(StaticIBValueProvider source)

Parameters

Type	Name	Description
StaticIBValueProvider	source	Instance of a source provider

Implements

IValueSelectionProvider

IDisposable