Version

EditingControlPropertyName Property (UltraControlContainerEditor)

Gets or sets the name of the property on the EditingControl which will be used to determine the value of the owning object.
Syntax
'Declaration
 
Public Property EditingControlPropertyName As String
public string EditingControlPropertyName {get; set;}
Remarks

In order for the editor to function, it must deal with a single property of the EditingControl as specified by this property. If no EditingControlPropertyName is specified, the editor will look for a property named Value on the control. Failing that, the Text property will be used. If neither a Value nor a Text property are found, the editor will not be able to function properly.

The ControlContainerEditor needs to know when the specified property on the control is changed. To do this, it will attempt to hook an event on the specified control with a name that matches the property (i.e. ValueChanged or TextChanged). If no such event exists or is not fired when the property changes, the editor will be unable to write changes to the owner. In the rare case where this happens, it is recommend that the developer derive a class from ControlContainerEditor and override the EditorValue property and set this property any time the editor value changes.

Example
The following code will set up ultraControlContainerEditor1 so that it renders and edits with a TrackBar control in a grid column.

Imports Infragistics.Win.UltraWinEditors



' Create a TrackBar for editing. This control will be used for cells that
' are in edit mode. 
'
Dim trackBarForEditing As TrackBar = New TrackBar()
trackBarForEditing.Minimum = 0
trackBarForEditing.Maximum = 10
Me.Controls.Add(trackBarForEditing)

' Set the EditingControl on the UltraControlContainer to the trackBarForEditing. 
'
Me.ultraControlContainerEditor1.EditingControl = trackBarForEditing

' Create another TrackBar for rendering. This will be used for cells that 
' are NOT in edit mode. Since both trackbars will serve the same grid column
' it makes sense to set all of the properties the same. 
'
Dim trackBarForRendering As TrackBar = New TrackBar()
trackBarForRendering.Minimum = 0
trackBarForRendering.Maximum = 10
Me.Controls.Add(trackBarForRendering)

' Set the RenderingControl on the UltraControlContainer to the trackBarForRendering. 
'
Me.ultraControlContainerEditor1.RenderingControl = trackBarForRendering

' Set ApplyOwnerAppearanceToEditingControl so that the Trackbar will not pick
' up the appearance of the cell. 
'
Me.ultraControlContainerEditor1.ApplyOwnerAppearanceToEditingControl = False
Me.ultraControlContainerEditor1.ApplyOwnerAppearanceToRenderingControl = False

' Tell the UltraControlContainerEditor to use the Value property on the 
' trackbar for both the editing and rendering value. 
'
Me.ultraControlContainerEditor1.EditingControlPropertyName = "Value"
Me.ultraControlContainerEditor1.RenderingControlPropertyName = "Value"

' Since the editing and rendering controls are exactly the same, we want
' the user to be able to click and drag the trackbar thumb with a single 
' click and drag. Setting EnterEditModeMouseBehavior to 
' EnterEditModeAndClick will allow the editor to forward the MouseDown 
' that causes the cell to enter edit mode to the Trackbar control.
'
Me.ultraControlContainerEditor1.EnterEditModeMouseBehavior = EnterEditModeMouseBehavior.EnterEditModeAndClick

' Assign the UltraControlContainerEditor to the grid column
'
Me.ultraGrid1.DisplayLayout.Bands(0).Columns(0).EditorComponent = Me.ultraControlContainerEditor1
using Infragistics.Win.UltraWinEditors;


// Create a TrackBar for editing. This control will be used for cells that
// are in edit mode. 
//
TrackBar trackBarForEditing = new TrackBar();
trackBarForEditing.Minimum = 0;
trackBarForEditing.Maximum = 10;
this.Controls.Add(trackBarForEditing);

// Set the EditingControl on the UltraControlContainer to the trackBarForEditing. 
//
this.ultraControlContainerEditor1.EditingControl = trackBarForEditing;

// Create another TrackBar for rendering. This will be used for cells that 
// are NOT in edit mode. Since both trackbars will serve the same grid column
// it makes sense to set all of the properties the same. 
//
TrackBar trackBarForRendering = new TrackBar();
trackBarForRendering.Minimum = 0;
trackBarForRendering.Maximum = 10;
this.Controls.Add(trackBarForRendering);

// Set the RenderingControl on the UltraControlContainer to the trackBarForRendering. 
//
this.ultraControlContainerEditor1.RenderingControl = trackBarForRendering;

// Set ApplyOwnerAppearanceToEditingControl so that the Trackbar will not pick
// up the appearance of the cell. 
//
this.ultraControlContainerEditor1.ApplyOwnerAppearanceToEditingControl = false;
this.ultraControlContainerEditor1.ApplyOwnerAppearanceToRenderingControl = false;

// Tell the UltraControlContainerEditor to use the Value property on the 
// trackbar for both the editing and rendering value. 
//
this.ultraControlContainerEditor1.EditingControlPropertyName = "Value";
this.ultraControlContainerEditor1.RenderingControlPropertyName = "Value";

// Since the editing and rendering controls are exactly the same, we want
// the user to be able to click and drag the trackbar thumb with a single 
// click and drag. Setting EnterEditModeMouseBehavior to 
// EnterEditModeAndClick will allow the editor to forward the MouseDown 
// that causes the cell to enter edit mode to the Trackbar control.
//
this.ultraControlContainerEditor1.EnterEditModeMouseBehavior = EnterEditModeMouseBehavior.EnterEditModeAndClick;

// Assign the UltraControlContainerEditor to the grid column
//
this.ultraGrid1.DisplayLayout.Bands[0].Columns[0].EditorComponent = this.ultraControlContainerEditor1;
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