Skip to main content
All docs
V25.1
  • EditFormUserControl.GetBoundFieldName(Control) Method

    Returns the field name in the data source to which the specified editor is bound.

    Namespace: DevExpress.XtraTreeList

    Assembly: DevExpress.XtraTreeList.v25.1.dll

    NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.TreeList

    Declaration

    [DefaultValue("")]
    public string GetBoundFieldName(
        Control c
    )

    Parameters

    Name Type Description
    c Control

    An object that specifies the editor on a custom Edit Form.

    Returns

    Type Default Description
    String String.Empty

    The field name in the data source to which the specified editor is bound.

    Remarks

    The EditFormUserControl class implements the IExtenderProvider interface. The GetBoundFieldName method supports the ProvideProperty attribute.

    Use the SetBoundFieldName method to bind an editor on the Edit Form to a data source field. Use the SetBoundPropertyName method to set the editor’s property that is bound to the data source field. If the property name is not specified, the data source field is bound to the Control.Text or BaseEdit.EditValue property depending on the editor type.

    Example

    The code below creates a custom Edit Form.

    image

    using DevExpress.XtraEditors;
    using DevExpress.XtraTreeList;
    
    treeList.OptionsBehavior.EditingMode = TreeListEditingMode.EditForm;
    // Create a custom EditForm
    var control = new EditFormUserControl();
    control.Height = treeList.Height / 2;
    // Add editors
    MemoEdit memoEditNotes = new MemoEdit();
    memoEditNotes.Dock = DockStyle.Fill;
    TextEdit textEditName = new TextEdit();
    textEditName.Dock = DockStyle.Top;
    TextEdit textEditType = new TextEdit();
    textEditType.Dock = DockStyle.Top;
    DateEdit dateEditDate = new DateEdit();
    dateEditDate.Dock = DockStyle.Bottom;
    control.Controls.Add(memoEditNotes);
    control.Controls.Add(dateEditDate);
    control.Controls.Add(textEditType);
    control.Controls.Add(textEditName);
    // Bind the editors to data source fields
    control.SetBoundFieldName(memoEditNotes, "Notes");
    control.SetBoundFieldName(textEditName, "Name");
    control.SetBoundFieldName(textEditType, "TypeOfObject");
    control.SetBoundFieldName(dateEditDate, "RecordDate");
    // Assign the Edit Form to the Tree List
    treeList.OptionsEditForm.CustomEditFormLayout = control;
    

    Note

    Run the following demo for the complete example: Edit nodes with a custom Edit Form.

    See Also