Skip to main content
.NET 6.0+

TreeListEditor Members

Represents a Windows Forms List Editor that displays data in the form of a tree-like structure.

Constructors

Name Description
TreeListEditor(IModelListView) Creates and initializes an instance of the TreeListEditor class.

Properties

Name Description
Adapter Provides access to the tree node adapter used by the TreeListEditor.
AllowEdit Indicates whether the data bound to the current List Editor can be edited via the List Editor’s control. Inherited from ListEditor.
BorderStyle Gets or sets the border style for the target Tree List.
ClearFocusedObjectOnMouseClick Specifies whether the focused object can be deselected by clicking on the TreeListEditor‘s region not occupied by a node.
Columns Provides access to a collection of objects representing the TreeListEditor‘s columns.
ContextMenuTemplate Provides access to the TreeListEditor‘s Context Menu Template.
Control Provides access to the control that is used by the current List Editor to represent a List View in a UI. Inherited from ListEditor.
DataSource Specifies a List Editor‘s data source. Inherited from ListEditor.
DeferredNodeLoading Indicates whether deferred node loading is enabled.
ErrorMessages Provides access to the current ListEditor‘s error message collection, populated when Validation Rules are broken. Inherited from ListEditor.
FirstNodeFocusedAndSelected For internal use.
FocusedColumnMemberName Inherited from ColumnsListEditor.
FocusedObject Gets or sets the focused object in the TreeListEditor.
HoldRootValue Specifies whether the nodes whose parent node is absent in the TreeListEditor‘s data source should be displayed as root.
IsDisposed Indicates whether a List Editor has been disposed of. Inherited from ListEditor.
IsFooterVisible Specifies whether the TreeListEditor‘s footer is visible.
List This property is intended for internal use. Inherited from ListEditor.
Model Provides access to the Application Model node that defines the List View represented by the current List Editors. Inherited from ListEditor.
Name Specifies the TreeListEditor‘s name.
PopupSite Returns the control over which a context menu is being invoked.
PreventServerSideOperationsForNonPersistentMembers Specifies whether server-side operations are prevented for non-persistent properties in the Server, ServerView, InstantFeedback, and InstantFeedbackView data access modes, or not. Inherited from ColumnsListEditor.
Printable Specifies the control to be exported via the ExportController.ExportAction.
ProcessSelectedItemBySingleClick Specifies whether a List View’s record must be processed after a click or a double-click.
ProtectedContentText Specifies the text that is used by a List Editor to display a property which is prohibited for viewing by the current user. Inherited from ListEditor.
RequiredProperties Returns an array of descriptors for the properties considered bindable by the List Editor‘s Collection Source. Inherited from ListEditor.
RootValue Specifies the root node.
SelectionType Returns the selection type supported by the TreeListEditor.
SupportedExportFormats Provides access to the list of export formats supported by the current Tree List Editor.
TrackMousePosition Specifies whether mouse tracking is enabled for the TreeListEditor.
TreeList Provides access to the TreeListEditor‘s control.
UseAsyncLoading Specifies whether an XPO-based WinForms application loads a List View’s data asynchronously. Inherited from ListEditor.

Methods

Name Description
AddColumn(IModelColumn) Adds a column to the ColumnsListEditor, using information from the specified Application Model‘s node. Inherited from ColumnsListEditor.
ApplyModel() Updates the current List Editor’s state in accordance with the information stored in the Application Model.
BeginUpdate() Prevents the TreeListEditor‘s control from being updated until the TreeListEditor.EndUpdate method is called.
BreakLinksToControls() Removes references to the TreeListEditor‘s control and its event handlers.
CanShowPopupMenu(Point) Returns a Boolean value that indicates whether it is possible to invoke a context menu at the specified position.
CreateControls() Creates the current List Editor‘s control that represents a List View in a UI. Inherited from ListEditor.
Dispose() Releases all resources used by the TreeListEditor.
EndUpdate() Unlocks the TreeListEditor‘s control after a call to the TreeListEditor.BeginUpdate method and causes an immediate update.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FindColumn(String) Provides access to the ColumnsListEditor‘s column with the specified identifier. Inherited from ColumnsListEditor.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetIndexByObject(Object) Returns the index of an object that represents the TreeListEditor‘s node.
GetObjectByIndex(Int32) Returns an object that represents the TreeListEditor‘s node with the specified index.
GetOrderedObjects() Returns an ordered list of objects that represent the TreeListEditor‘s nodes.
GetSelectedObjects() Provides access to the collection of objects that are currently selected in the TreeListEditor‘s TreeList control.
GetType() Gets the Type of the current instance. Inherited from Object.
GetVisibleColumns() Returns the list of ColumnsListEditor‘s visible columns. Inherited from ColumnsListEditor.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnExporting() Performs the required pre-export actions under the TreeListEditor.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh() Refreshes the bound data source of the TreeListEditor‘s control.
RemoveColumn(ColumnWrapper) Removes a particular column from the TreeListEditor‘s TreeListEditor.TreeList.
SaveModel() Writes information on a List Editor‘s control to the Application Model.
SetMenuManager(IDXMenuManager) Sets the IDXMenuManager object that controls the Look & Feel options of the Context Menu Template via the TreeListEditor‘s control.
Setup(CollectionSourceBase, XafApplication) Performs additional initialization of the TreeListEditor.
StartIncrementalSearch(String) Starts an incremental search for the specified string. Inherited from ListEditor.
SupportsDataAccessMode(CollectionSourceDataAccessMode) Determines whether or not the given data access mode is supported by the ListEditor. Inherited from ListEditor.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
AllowEditChanged Occurs after the ListEditor‘s ListEditor.AllowEdit property has changed. Inherited from ListEditor.
BeginCustomization Occurs after the customization form that displays headers of hidden columns has been displayed.
ColumnAdded Occurs when a column is added to ColumnsListEditor. Inherited from ColumnsListEditor.
ControlsCreated Occurs after a ListEditor‘s control is created. Inherited from ListEditor.
DataSourceChanged Occurs after the ListEditor.DataSource property’s value has been changed. Inherited from ListEditor.
EndCustomization Occurs before the customization form that displays headers of hidden columns has been closed.
FilterEditorCreated
FocusedObjectChanged Occurs after the focused object has been changed in a List Editor‘s control. Inherited from ListEditor.
FocusedObjectChanging Occurs before the focused object is changed in a List Editor‘s control. Inherited from ListEditor.
ModelApplied Occurs after the customizations from the Application Model have been applied to the List Editor’s control. Inherited from ListEditor.
ModelApplying Occurs when customizations from the Application Model are applied to the List Editor’s control. Inherited from ListEditor.
ModelSaved Occurs after the List Editor’s control customizations have been saved to the Application Model. Inherited from ListEditor.
ModelSaving Occurs when the List Editor’s control customizations are saved to the Application Model. Inherited from ListEditor.
NewObjectAdding Occurs before a new object is created in a List Editor. Inherited from ListEditor.
NewObjectCanceled Occurs after creation of a new object is cancelled in a List Editor. Inherited from ListEditor.
NewObjectCreated Occurs after a new object has been created in a List Editor. Inherited from ListEditor.
ObjectChanged For internal use only. Inherited from ListEditor.
PrintableChanged Occurs when the IExportable.Printable control is created and disposed of.
ProcessSelectedItem Occurs after an object is selected in the List Editor‘s control and an end-user presses Enter or double-clicks the object. Inherited from ListEditor.
QueryCustomFunctions
RequiredPropertiesChanged Inherited from ListEditor.
SelectionChanged Occurs after the selection has been changed in a List Editor‘s control. Inherited from ListEditor.
SelectionTypeChanged Occurs after a List Editor‘s supported selection type is changed. Inherited from ListEditor.
TreeListDoubleClick Occurs when the TreeListEditor‘s item is double clicked.
TreeListKeyDown
TreeListMouseClick
TreeListMouseDown
TreeListMouseMove
ValidateObject Occurs when the object represented by the ListEditor‘s focused row must be validated. Inherited from ListEditor.
See Also