Version

ValueList Property (UltraGridColumn)

Returns a reference to a ValueList object containing the list of values used by a column. This property is not available at design-time.
Syntax
'Declaration
 
Public Property ValueList As Infragistics.Win.IValueList
public Infragistics.Win.IValueList ValueList {get; set;}
Remarks

This property returns a reference to a ValueList object that can be used to set properties of, and invoke methods on, the valuelist that is associated with a column. You can use this reference to access any of the returned valuelist's properties or methods.

This property is also used to assign a particular valuelist object to a column. Once assigned, the valuelist enables a column to use the dropdown list styles and intelligent data entry, specified by the Style and AutoEdit properties, respectively, of the column for which this property is set.

Example
Following code illustrates how to create a ValueList and assign it to a column. A ValueList maps data values to text. Depending on the value assigned to Style property of the column, cells in the column act like drop down lists or combo drop downs.

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub Button9_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button9.Click

      ' If the value list has already been created, then return since we
      ' don't want to recreate it again.
      If Me.ultraGrid1.DisplayLayout.ValueLists.Exists("VL1") Then Return

      ' Create a value list with the key of VL1.
      Dim valueList As valueList = Me.ultraGrid1.DisplayLayout.ValueLists.Add("VL1")

      ' Add some items to it. Here the items added have numeric data values and
      ' associated display texts. What the user sees in the cells is the display 
      ' text for these underlying numeric data value. Also when the user modifies
      ' a cell and selects one of the item, what goes in the data source is the
      ' associated numeric value.
      valueList.ValueListItems.Add(1, "One")
      valueList.ValueListItems.Add(2, "Two")
      valueList.ValueListItems.Add(3, "Three")
      valueList.ValueListItems.Add(4, "Four")
      valueList.ValueListItems.Add(5, "Five")

      ' Get the column you want to use the value list in.
      Dim column As UltraGridColumn = Me.ultraGrid1.DisplayLayout.Bands(0).Columns(0)

      ' Now assign the value list to that column.
      column.ValueList = valueList

      ' Optionally set the style of that column to an appropriate drop down style.
      ' DropDownValidate style ensures that the user enters only the values found 
      ' in the value list. 
      column.Style = ColumnStyle.DropDownValidate

      ' When AutoEdit is turned on on a column with value list assigned to it, the
      ' UltraGrid auto-completes the text in the cell as the user types to a matching
      ' item in the value list. This is enabled by default, however you can turn it
      ' off by setting AutoEdit to false.
      column.AutoEdit = False

  End Sub
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void button9_Click(object sender, System.EventArgs e)
{		
	
	// If the value list has already been created, then return since we
	// don't want to recreate it again.
	if ( this.ultraGrid1.DisplayLayout.ValueLists.Exists( "VL1" ) )
		return;

	// Create a value list with the key of VL1.
	ValueList valueList = this.ultraGrid1.DisplayLayout.ValueLists.Add( "VL1" );
	
	// Add some items to it. Here the items added have numeric data values and
	// associated display texts. What the user sees in the cells is the display 
	// text for these underlying numeric data value. Also when the user modifies
	// a cell and selects one of the item, what goes in the data source is the
	// associated numeric value.
	valueList.ValueListItems.Add( 1, "One" );
	valueList.ValueListItems.Add( 2, "Two" );
	valueList.ValueListItems.Add( 3, "Three" );
	valueList.ValueListItems.Add( 4, "Four" );
	valueList.ValueListItems.Add( 5, "Five" );

	// Get the column you want to use the value list in.
	UltraGridColumn column = this.ultraGrid1.DisplayLayout.Bands[0].Columns[0];

	// Now assign the value list to that column.
	column.ValueList = valueList;
	
	// Optionally set the style of that column to an appropriate drop down style.
	// DropDownValidate style ensures that the user enters only the values found 
	// in the value list. 
	column.Style = ColumnStyle.DropDownValidate;

	// When AutoEdit is turned on on a column with value list assigned to it, the
	// UltraGrid auto-completes the text in the cell as the user types to a matching
	// item in the value list. This is enabled by default, however you can turn it
	// off by setting AutoEdit to false.
	column.AutoEdit = false;

}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also