Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.NodeProxy Class Reference

Class for node instance manipulation More...

Inheritance diagram for Ext.Net.NodeProxy:
Ext.Net.BaseItem Ext.Net.IXObject Ext.Net.IBase

Public Member Functions

 NodeProxy (object store, string nodeScript)
 
 NodeProxy (object store, string nodeScript, bool isArray)
 
override void AddScript (string script, params object[] args)
 
override void Call (string name, params object[] args)
 
virtual string ToScript ()
 
virtual string ToScript (bool ignoreAutoRegister)
 
virtual string ToScript (bool clearBuffer, bool ignoreAutoRegister)
 
virtual NodeProxy ChildNodes ()
 An array of this nodes children. Array will be empty if this node has no chidren. More...
 
void FireEvent (string eventName, params object[] args)
 Fires the specified event with the passed parameters (minus the event name) More...
 
virtual NodeProxy FirstChild ()
 A reference to this node's first child node. null if this node has no children. More...
 
virtual NodeProxy LastChild ()
 A reference to this node's last child node. null if this node has no children. More...
 
virtual NodeProxy NextSibling ()
 A reference to this node's next sibling node. null if this node does not have a next sibling. More...
 
virtual NodeProxy ParentNode ()
 A reference to this node's parent node. null if this node is the root node. More...
 
virtual NodeProxy PreviousSibling ()
 A reference to this node's previous sibling node. null if this node does not have a previous sibling. More...
 
virtual void Contains (NodeProxy node, JFunction trueFn, JFunction falseFn)
 Returns true if this node is an ancestor (at any point) of the passed node. More...
 
virtual NodeProxy Copy (object id, bool deep)
 Creates a copy (clone) of this Node. More...
 
virtual NodeProxy Copy (object id)
 Creates a copy (clone) of this Node. More...
 
virtual NodeProxy Copy ()
 Creates a copy (clone) of this Node. More...
 
virtual NodeProxy CreateNode (object nodeConfig)
 Ensures that the passed object is an instance of a Record with the NodeInterface applied More...
 
virtual NodeProxy FindChild (string attribute, object value, bool deep)
 Finds the first child that has the attribute with the specified value. More...
 
virtual NodeProxy FindChild (string attribute, object value)
 Finds the first child that has the attribute with the specified value. More...
 
virtual NodeProxy FindChildBy (JFunction fn, string scope, bool deep)
 Finds the first child by a custom function. The child matches if the function passed returns true. More...
 
virtual NodeProxy FindChildBy (JFunction fn, string scope)
 Finds the first child by a custom function. The child matches if the function passed returns true. More...
 
virtual NodeProxy FindChildBy (JFunction fn)
 Finds the first child by a custom function. The child matches if the function passed returns true. More...
 
virtual NodeProxy GetChildAt (int index)
 Returns the child node at the specified index. More...
 
virtual void HasChildNodes (JFunction trueFn, JFunction falseFn)
 Returns true if this node has one or more child nodes, else false. More...
 
virtual void IsAncestor (NodeProxy node, JFunction trueFn, JFunction falseFn)
 Returns true if the passed node is an ancestor (at any point) of this node. More...
 
virtual void IsExpandable (JFunction trueFn, JFunction falseFn)
 Returns true if this node has one or more child nodes, or if the expandable node attribute is explicitly specified as true, otherwise returns false. More...
 
virtual void IsExpanded (JFunction trueFn, JFunction falseFn)
 Returns true if this node is expaned More...
 
virtual void IsFirst (JFunction trueFn, JFunction falseFn)
 Returns true if this node is the first child of its parent More...
 
virtual void IsLast (JFunction trueFn, JFunction falseFn)
 Returns true if this node is the last child of its parent More...
 
virtual void IsLeaf (JFunction trueFn, JFunction falseFn)
 Returns true if this node is the last child of its parent More...
 
virtual void IsLoaded (JFunction trueFn, JFunction falseFn)
 Returns true if this node is loaded More...
 
virtual void IsRoot (JFunction trueFn, JFunction falseFn)
 Returns true if this node is the root node More...
 
virtual void IsVisible (JFunction trueFn, JFunction falseFn)
 Returns true if this node is visible More...
 
virtual void Reload ()
 Reload the node More...
 
virtual void Reload (object options)
 Reload the node More...
 
virtual void AppendChild (Node node)
 Insert node(s) as the last child node of the root node. More...
 
virtual void AppendChild (NodeProxy node)
 Insert node(s) as the last child node of the node. More...
 
virtual void AppendChild (IEnumerable< Node > nodes)
 Insert node(s) as the last child node of the root node. More...
 
virtual void Bubble (JFunction function, string scope)
 Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the bubble is stopped. More...
 
virtual void Bubble (JFunction function)
 Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the bubble is stopped. More...
 
virtual void CascadeBy (JFunction function, string scope)
 Cascades down the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the cascade is stopped on that branch. More...
 
virtual void CascadeBy (JFunction function)
 Cascades down the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the cascade is stopped on that branch. More...
 
virtual void Collapse (bool recursive, JFunction callback, string scope)
 Collapse this node. More...
 
virtual void Collapse (bool recursive, JFunction callback)
 Collapse this node. More...
 
virtual void Collapse (bool recursive)
 Collapse this node. More...
 
virtual void CollapseChildren (bool recursive, JFunction callback, string scope)
 Collapse all the children of this node. More...
 
virtual void CollapseChildren (bool recursive, JFunction callback)
 Collapse all the children of this node. More...
 
virtual void CollapseChildren (bool recursive)
 Collapse all the children of this node. More...
 
virtual void Erase ()
 Destroys the node. More...
 
virtual void Erase (bool deep)
 Destroys the node. More...
 
virtual void EachChild (JFunction function, string scope)
 Interates the child nodes of this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the iteration stops. More...
 
virtual void EachChild (JFunction function)
 Interates the child nodes of this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the iteration stops. More...
 
virtual void Expand (bool recursive, JFunction callback, string scope)
 Expand this node. More...
 
virtual void Expand (bool recursive, JFunction callback)
 Expand this node. More...
 
virtual void Expand (bool recursive)
 Expand this node. More...
 
virtual void ExpandChildren (bool recursive, JFunction callback, string scope)
 Expand all the children of this node. More...
 
virtual void ExpandChildren (bool recursive, JFunction callback)
 Expand all the children of this node. More...
 
virtual void ExpandChildren (bool recursive)
 Expand all the children of this node. More...
 
virtual void InsertBefore (NodeProxy node, NodeProxy refNode)
 Inserts the first node before the second node in this nodes childNodes collection. More...
 
virtual void InsertBefore (Node node, NodeProxy refNode)
 Inserts the first node before the second node in this nodes childNodes collection. More...
 
virtual void InsertChild (int index, Node node)
 Insert a node into this node More...
 
virtual void InsertChild (int index, NodeProxy refNode)
 Insert a node into this node More...
 
virtual void Remove (bool destroy)
 Removes this node from its parent More...
 
virtual void Remove ()
 Removes this node from its parent More...
 
virtual void RemoveAll (bool destroy)
 Removes all child nodes from this node. More...
 
virtual void RemoveAll ()
 Removes all child nodes from this node. More...
 
virtual void RemoveChild (NodeProxy node, bool destroy)
 Removes a child node from this node. More...
 
virtual void RemoveChild (NodeProxy node)
 Removes a child node from this node. More...
 
virtual void ReplaceChild (NodeProxy newChild, NodeProxy oldChild)
 Replaces one child node in this node with another. More...
 
virtual void ReplaceChild (Node newChild, NodeProxy oldChild)
 Replaces one child node in this node with another. More...
 
virtual void Sort (JFunction f, bool recursive, bool suppressEvent)
 Sorts this nodes children using the supplied sort function. More...
 
virtual void Sort (JFunction f, bool recursive)
 Sorts this nodes children using the supplied sort function. More...
 
virtual void Sort (JFunction f)
 Sorts this nodes children using the supplied sort function. More...
 
virtual void On (string eventName, string fn)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, string fn, string scope)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, string fn, string scope, HandlerConfig options)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn, string scope)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void On (string eventName, JFunction fn, string scope, HandlerConfig options)
 Appends an event handler to this element (shorthand for addListener) More...
 
virtual void Un (string eventName, string fn)
 Removes an event handler. More...
 
virtual void Un (string eventName, string fn, string scope)
 Removes an event handler. More...
 
void BeginEdit ()
 Begin an edit. While in edit mode, no events (e.g. the update event) are relayed to the containing store. When an edit has begun, it must be followed by either endEdit or cancelEdit. More...
 
void CancelEdit ()
 Cancels all changes made in the current edit operation. More...
 
void Commit ()
 Usually called by the Ext.data.Store which owns the model instance. Commits all changes made to the instance since either creation or the last commit operation. Developers should subscribe to the Ext.data.Store.update event to have their code notified of commit operations. More...
 
void Commit (bool silent)
 Usually called by the Ext.data.Store which owns the model instance. Commits all changes made to the instance since either creation or the last commit operation. Developers should subscribe to the Ext.data.Store.update event to have their code notified of commit operations. More...
 
void EndEdit ()
 End an edit. If any data was modified, the containing store is notified (ie, the store's update event will fire). More...
 
void EndEdit (bool silent)
 End an edit. If any data was modified, the containing store is notified (ie, the store's update event will fire). More...
 
void Reject ()
 Usually called by the Ext.data.Store to which this model instance has been joined. Rejects all changes made to the model instance since either creation, or the last commit operation. Modified fields are reverted to their original values. Developers should subscribe to the Ext.data.Store.update event to have their code notified of reject operations. More...
 
void Reject (bool silent)
 Usually called by the Ext.data.Store to which this model instance has been joined. Rejects all changes made to the model instance since either creation, or the last commit operation. Modified fields are reverted to their original values. Developers should subscribe to the Ext.data.Store.update event to have their code notified of reject operations. More...
 
void Save ()
 Saves the model instance using the configured proxy More...
 
void Save (object options)
 Saves the model instance using the configured proxy More...
 
void Set (string fieldName, object value)
 Sets the given field to the given value, marks the instance as dirty More...
 
new void SetDirty ()
 Marks this Record as dirty. This method is used interally when adding phantom records to a writer enabled store. Marking a record dirty causes the phantom to be returned by Ext.data.Store.getModifiedRecords where it will have a create action composed for it during store save operations. More...
 
void SetId (object id)
 Sets the model instance's id field to the given id More...
 
void SetAllowDrag (bool allowDrag)
 False to make this node undraggable if draggable = true More...
 
void SetAllowDrop (bool allowDrop)
 False if this node cannot have child nodes dropped on it More...
 
void SetChecked (bool @checked)
 
void SetCls (string cls)
 
void SetHref (string href)
 
void SetHrefTarget (string hrefTarget)
 
void SetIconFile (string iconFile)
 
void SetIcon (Icon icon)
 
void SetIconCls (string iconCls)
 
void SetQTip (string qtip)
 
void SetQtitle (string qtitle)
 
void SetText (string text)
 
void SetDataPath (string dataPath)
 
- Public Member Functions inherited from Ext.Net.BaseItem
virtual bool HasExplicitValue (string name)
 
void EnsureDataBind ()
 
virtual void Call (string name)
 
virtual void AddScript (string script)
 
virtual bool IsEmptyObject ()
 
Apply< T > (IApply config)
 
BaseItem Apply (object config)
 
virtual void LoadViewState (object state)
 
virtual object SaveViewState ()
 
virtual void TrackViewState ()
 
void SetDirty ()
 
virtual void DataBind ()
 
virtual IControlBuilder ToNativeBuilder ()
 

Static Public Member Functions

static NodeProxy GetRootNode (object store)
 Get proxy instance for root node More...
 
static NodeProxy GetNodeById (object store, object id)
 Get proxy instance for node with passed id More...
 

Properties

bool IsArray [get, set]
 
virtual string? NodeInstance [get]
 
virtual string? NodeScript [get]
 
virtual string StoreId [get]
 
virtual TreeStoreBase Store [get]
 
virtual bool AutoRegister [get, set]
 
virtual bool Safe [get, set]
 
virtual string MethodScript [get]
 
- Properties inherited from Ext.Net.BaseItem
virtual string InstanceOf [get]
 
ItemState State [get]
 
virtual DefaultValueMode DefaultValueMode [get, set]
 
virtual bool DesignMode [get]
 
bool AutoDataBind [get, set]
 
ResourceManager ResourceManager [get]
 
virtual Control Owner [get, set]
 The Owner Control for this Listener. More...
 
virtual bool IsDefault [get]
 Does this object currently represent it's default state. More...
 
bool IsTrackingViewState [get]
 
EventHandlerList Events [get]
 
EventHandler DataBinding
 
Control?? BindingContainer [get]
 
virtual ConfigItemCollection?? CustomConfig [get]
 Collection of custom js config More...
 
virtual ConfigOptionsCollection ConfigOptions [get]
 
virtual ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
System.Web.Mvc.HtmlHelper?? HtmlHelper [get, set]
 
- Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection ConfigOptions [get]
 
ConfigOptionsExtraction ConfigOptionsExtraction [get]
 
DefaultValueMode DefaultValueMode [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Ext.Net.BaseItem
 BaseItem (Control owner)
 
 BaseItem ()
 
virtual void OwnerUpdate (Control owner)
 
virtual void OnDataBinding (EventArgs e)
 

Detailed Description

Class for node instance manipulation

Constructor & Destructor Documentation

◆ NodeProxy() [1/2]

Ext.Net.NodeProxy.NodeProxy ( object  store,
string  nodeScript 
)
inline

Parameters
store
nodeScript

◆ NodeProxy() [2/2]

Ext.Net.NodeProxy.NodeProxy ( object  store,
string  nodeScript,
bool  isArray 
)
inline

Parameters
store
nodeScript
isArray

Member Function Documentation

◆ AddScript()

override void Ext.Net.NodeProxy.AddScript ( string  script,
params object[]  args 
)
inlinevirtual

Parameters
script
args

Reimplemented from Ext.Net.BaseItem.

◆ AppendChild() [1/3]

virtual void Ext.Net.NodeProxy.AppendChild ( IEnumerable< Node nodes)
inlinevirtual

Insert node(s) as the last child node of the root node.

If the node was previously a child node of another parent node, it will be removed from that node first.

Parameters
nodesThe node or Array of nodes to append

◆ AppendChild() [2/3]

virtual void Ext.Net.NodeProxy.AppendChild ( Node  node)
inlinevirtual

Insert node(s) as the last child node of the root node.

If the node was previously a child node of another parent node, it will be removed from that node first.

Parameters
nodeThe node or Array of nodes to append

◆ AppendChild() [3/3]

virtual void Ext.Net.NodeProxy.AppendChild ( NodeProxy  node)
inlinevirtual

Insert node(s) as the last child node of the node.

If the node was previously a child node of another parent node, it will be removed from that node first.

Parameters
nodeThe node or Array of nodes to append

◆ BeginEdit()

void Ext.Net.NodeProxy.BeginEdit ( )
inline

Begin an edit. While in edit mode, no events (e.g. the update event) are relayed to the containing store. When an edit has begun, it must be followed by either endEdit or cancelEdit.

◆ Bubble() [1/2]

virtual void Ext.Net.NodeProxy.Bubble ( JFunction  function)
inlinevirtual

Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the bubble is stopped.

Parameters
functionThe function to call

◆ Bubble() [2/2]

virtual void Ext.Net.NodeProxy.Bubble ( JFunction  function,
string  scope 
)
inlinevirtual

Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the bubble is stopped.

Parameters
functionThe function to call
scopeThe scope (this reference) in which the function is executed. Defaults to the current Node.

◆ Call()

override void Ext.Net.NodeProxy.Call ( string  name,
params object[]  args 
)
inlinevirtual

Parameters
name
args

Reimplemented from Ext.Net.BaseItem.

◆ CancelEdit()

void Ext.Net.NodeProxy.CancelEdit ( )
inline

Cancels all changes made in the current edit operation.

◆ CascadeBy() [1/2]

virtual void Ext.Net.NodeProxy.CascadeBy ( JFunction  function)
inlinevirtual

Cascades down the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the cascade is stopped on that branch.

Parameters
functionThe function to call

◆ CascadeBy() [2/2]

virtual void Ext.Net.NodeProxy.CascadeBy ( JFunction  function,
string  scope 
)
inlinevirtual

Cascades down the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the cascade is stopped on that branch.

Parameters
functionThe function to call
scopeThe scope (this reference) in which the function is executed. Defaults to the current Node.

◆ ChildNodes()

virtual NodeProxy Ext.Net.NodeProxy.ChildNodes ( )
inlinevirtual

An array of this nodes children. Array will be empty if this node has no chidren.

Returns

◆ Collapse() [1/3]

virtual void Ext.Net.NodeProxy.Collapse ( bool  recursive)
inlinevirtual

Collapse this node.

Parameters
recursiveTrue to recursively collapse all the children

◆ Collapse() [2/3]

virtual void Ext.Net.NodeProxy.Collapse ( bool  recursive,
JFunction  callback 
)
inlinevirtual

Collapse this node.

Parameters
recursiveTrue to recursively collapse all the children
callbackThe function to execute once the collapse completes

◆ Collapse() [3/3]

virtual void Ext.Net.NodeProxy.Collapse ( bool  recursive,
JFunction  callback,
string  scope 
)
inlinevirtual

Collapse this node.

Parameters
recursiveTrue to recursively collapse all the children
callbackThe function to execute once the collapse completes
scopeThe scope to run the callback in

◆ CollapseChildren() [1/3]

virtual void Ext.Net.NodeProxy.CollapseChildren ( bool  recursive)
inlinevirtual

Collapse all the children of this node.

Parameters
recursiveTrue to recursively collapse all the children

◆ CollapseChildren() [2/3]

virtual void Ext.Net.NodeProxy.CollapseChildren ( bool  recursive,
JFunction  callback 
)
inlinevirtual

Collapse all the children of this node.

Parameters
recursiveTrue to recursively collapse all the children
callbackThe function to execute once all the children are collapsed

◆ CollapseChildren() [3/3]

virtual void Ext.Net.NodeProxy.CollapseChildren ( bool  recursive,
JFunction  callback,
string  scope 
)
inlinevirtual

Collapse all the children of this node.

Parameters
recursiveTrue to recursively collapse all the children
callbackThe function to execute once all the children are collapsed
scopeThe scope to run the callback in

◆ Commit() [1/2]

void Ext.Net.NodeProxy.Commit ( )
inline

Usually called by the Ext.data.Store which owns the model instance. Commits all changes made to the instance since either creation or the last commit operation. Developers should subscribe to the Ext.data.Store.update event to have their code notified of commit operations.

◆ Commit() [2/2]

void Ext.Net.NodeProxy.Commit ( bool  silent)
inline

Usually called by the Ext.data.Store which owns the model instance. Commits all changes made to the instance since either creation or the last commit operation. Developers should subscribe to the Ext.data.Store.update event to have their code notified of commit operations.

Parameters
silentTrue to skip notification of the owning store of the change

◆ Contains()

virtual void Ext.Net.NodeProxy.Contains ( NodeProxy  node,
JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is an ancestor (at any point) of the passed node.

Parameters
node
trueFn
falseFn

◆ Copy() [1/3]

virtual NodeProxy Ext.Net.NodeProxy.Copy ( )
inlinevirtual

Creates a copy (clone) of this Node.

Returns

◆ Copy() [2/3]

virtual NodeProxy Ext.Net.NodeProxy.Copy ( object  id)
inlinevirtual

Creates a copy (clone) of this Node.

Parameters
id
Returns

◆ Copy() [3/3]

virtual NodeProxy Ext.Net.NodeProxy.Copy ( object  id,
bool  deep 
)
inlinevirtual

Creates a copy (clone) of this Node.

Parameters
id
deep
Returns

◆ CreateNode()

virtual NodeProxy Ext.Net.NodeProxy.CreateNode ( object  nodeConfig)
inlinevirtual

Ensures that the passed object is an instance of a Record with the NodeInterface applied

Parameters
nodeConfig
Returns

◆ EachChild() [1/2]

virtual void Ext.Net.NodeProxy.EachChild ( JFunction  function)
inlinevirtual

Interates the child nodes of this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the iteration stops.

Parameters
functionThe function to call

◆ EachChild() [2/2]

virtual void Ext.Net.NodeProxy.EachChild ( JFunction  function,
string  scope 
)
inlinevirtual

Interates the child nodes of this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the iteration stops.

Parameters
functionThe function to call
scopeThe scope (this reference) in which the function is executed. Defaults to the current Node in the iteration..

◆ EndEdit() [1/2]

void Ext.Net.NodeProxy.EndEdit ( )
inline

End an edit. If any data was modified, the containing store is notified (ie, the store's update event will fire).

◆ EndEdit() [2/2]

void Ext.Net.NodeProxy.EndEdit ( bool  silent)
inline

End an edit. If any data was modified, the containing store is notified (ie, the store's update event will fire).

Parameters
silentTrue to not notify the store of the change

◆ Erase() [1/2]

virtual void Ext.Net.NodeProxy.Erase ( )
inlinevirtual

Destroys the node.

◆ Erase() [2/2]

virtual void Ext.Net.NodeProxy.Erase ( bool  deep)
inlinevirtual

Destroys the node.

Parameters
deepTrue to erase all the children

◆ Expand() [1/3]

virtual void Ext.Net.NodeProxy.Expand ( bool  recursive)
inlinevirtual

Expand this node.

Parameters
recursiveTrue to recursively expand all the children

◆ Expand() [2/3]

virtual void Ext.Net.NodeProxy.Expand ( bool  recursive,
JFunction  callback 
)
inlinevirtual

Expand this node.

Parameters
recursiveTrue to recursively expand all the children
callbackThe function to execute once the expand completes

◆ Expand() [3/3]

virtual void Ext.Net.NodeProxy.Expand ( bool  recursive,
JFunction  callback,
string  scope 
)
inlinevirtual

Expand this node.

Parameters
recursiveTrue to recursively expand all the children
callbackThe function to execute once the expand completes
scopeThe scope to run the callback in

◆ ExpandChildren() [1/3]

virtual void Ext.Net.NodeProxy.ExpandChildren ( bool  recursive)
inlinevirtual

Expand all the children of this node.

Parameters
recursiveTrue to recursively expand all the children

◆ ExpandChildren() [2/3]

virtual void Ext.Net.NodeProxy.ExpandChildren ( bool  recursive,
JFunction  callback 
)
inlinevirtual

Expand all the children of this node.

Parameters
recursiveTrue to recursively expand all the children
callbackThe function to execute once all the children are expanded

◆ ExpandChildren() [3/3]

virtual void Ext.Net.NodeProxy.ExpandChildren ( bool  recursive,
JFunction  callback,
string  scope 
)
inlinevirtual

Expand all the children of this node.

Parameters
recursiveTrue to recursively expand all the children
callbackThe function to execute once all the children are expanded
scopeThe scope to run the callback in

◆ FindChild() [1/2]

virtual NodeProxy Ext.Net.NodeProxy.FindChild ( string  attribute,
object  value 
)
inlinevirtual

Finds the first child that has the attribute with the specified value.

Parameters
attributeThe attribute name
valueThe value to search for
Returns

◆ FindChild() [2/2]

virtual NodeProxy Ext.Net.NodeProxy.FindChild ( string  attribute,
object  value,
bool  deep 
)
inlinevirtual

Finds the first child that has the attribute with the specified value.

Parameters
attributeThe attribute name
valueThe value to search for
deepTrue to search through nodes deeper than the immediate children
Returns

◆ FindChildBy() [1/3]

virtual NodeProxy Ext.Net.NodeProxy.FindChildBy ( JFunction  fn)
inlinevirtual

Finds the first child by a custom function. The child matches if the function passed returns true.

Parameters
fnA function which must return true if the passed Node is the required Node.
Returns

◆ FindChildBy() [2/3]

virtual NodeProxy Ext.Net.NodeProxy.FindChildBy ( JFunction  fn,
string  scope 
)
inlinevirtual

Finds the first child by a custom function. The child matches if the function passed returns true.

Parameters
fnA function which must return true if the passed Node is the required Node.
scopeThe scope (this reference) in which the function is executed. Defaults to the Node being tested.
Returns

◆ FindChildBy() [3/3]

virtual NodeProxy Ext.Net.NodeProxy.FindChildBy ( JFunction  fn,
string  scope,
bool  deep 
)
inlinevirtual

Finds the first child by a custom function. The child matches if the function passed returns true.

Parameters
fnA function which must return true if the passed Node is the required Node.
scopeThe scope (this reference) in which the function is executed. Defaults to the Node being tested.
deepTrue to search through nodes deeper than the immediate children
Returns

◆ FireEvent()

void Ext.Net.NodeProxy.FireEvent ( string  eventName,
params object[]  args 
)
inline

Fires the specified event with the passed parameters (minus the event name)

Parameters
eventNameThe name of the event to fire.
argsVariable number of parameters are passed to handlers.

◆ FirstChild()

virtual NodeProxy Ext.Net.NodeProxy.FirstChild ( )
inlinevirtual

A reference to this node's first child node. null if this node has no children.

Returns

◆ GetChildAt()

virtual NodeProxy Ext.Net.NodeProxy.GetChildAt ( int  index)
inlinevirtual

Returns the child node at the specified index.

Parameters
index
Returns

◆ GetNodeById()

static NodeProxy Ext.Net.NodeProxy.GetNodeById ( object  store,
object  id 
)
inlinestatic

Get proxy instance for node with passed id

Parameters
storeTreeStore reference
idNode id
Returns
NodeProxy

◆ GetRootNode()

static NodeProxy Ext.Net.NodeProxy.GetRootNode ( object  store)
inlinestatic

Get proxy instance for root node

Parameters
storeTreeStore reference
Returns
NodeProxy

◆ HasChildNodes()

virtual void Ext.Net.NodeProxy.HasChildNodes ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node has one or more child nodes, else false.

Parameters
trueFn
falseFn

◆ InsertBefore() [1/2]

virtual void Ext.Net.NodeProxy.InsertBefore ( Node  node,
NodeProxy  refNode 
)
inlinevirtual

Inserts the first node before the second node in this nodes childNodes collection.

Parameters
nodeThe node to insert
refNodeThe node to insert before

◆ InsertBefore() [2/2]

virtual void Ext.Net.NodeProxy.InsertBefore ( NodeProxy  node,
NodeProxy  refNode 
)
inlinevirtual

Inserts the first node before the second node in this nodes childNodes collection.

Parameters
nodeThe node to insert
refNodeThe node to insert before

◆ InsertChild() [1/2]

virtual void Ext.Net.NodeProxy.InsertChild ( int  index,
Node  node 
)
inlinevirtual

Insert a node into this node

Parameters
indexThe zero-based index to insert the node at
nodeThe node to insert

◆ InsertChild() [2/2]

virtual void Ext.Net.NodeProxy.InsertChild ( int  index,
NodeProxy  refNode 
)
inlinevirtual

Insert a node into this node

Parameters
indexThe zero-based index to insert the node at
refNodeThe node to insert

◆ IsAncestor()

virtual void Ext.Net.NodeProxy.IsAncestor ( NodeProxy  node,
JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if the passed node is an ancestor (at any point) of this node.

Parameters
node
trueFn
falseFn

◆ IsExpandable()

virtual void Ext.Net.NodeProxy.IsExpandable ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node has one or more child nodes, or if the expandable node attribute is explicitly specified as true, otherwise returns false.

Parameters
trueFn
falseFn

◆ IsExpanded()

virtual void Ext.Net.NodeProxy.IsExpanded ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is expaned

Parameters
trueFn
falseFn

◆ IsFirst()

virtual void Ext.Net.NodeProxy.IsFirst ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is the first child of its parent

Parameters
trueFn
falseFn

◆ IsLast()

virtual void Ext.Net.NodeProxy.IsLast ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is the last child of its parent

Parameters
trueFn
falseFn

◆ IsLeaf()

virtual void Ext.Net.NodeProxy.IsLeaf ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is the last child of its parent

Parameters
trueFn
falseFn

◆ IsLoaded()

virtual void Ext.Net.NodeProxy.IsLoaded ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is loaded

Parameters
trueFn
falseFn

◆ IsRoot()

virtual void Ext.Net.NodeProxy.IsRoot ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is the root node

Parameters
trueFn
falseFn

◆ IsVisible()

virtual void Ext.Net.NodeProxy.IsVisible ( JFunction  trueFn,
JFunction  falseFn 
)
inlinevirtual

Returns true if this node is visible

Parameters
trueFn
falseFn

◆ LastChild()

virtual NodeProxy Ext.Net.NodeProxy.LastChild ( )
inlinevirtual

A reference to this node's last child node. null if this node has no children.

Returns

◆ NextSibling()

virtual NodeProxy Ext.Net.NodeProxy.NextSibling ( )
inlinevirtual

A reference to this node's next sibling node. null if this node does not have a next sibling.

Returns

◆ On() [1/6]

virtual void Ext.Net.NodeProxy.On ( string  eventName,
JFunction  fn 
)
inlinevirtual

Appends an event handler to this element (shorthand for addListener)

Parameters
eventNameThe type of event to listen for
fnThe method the event invokes

◆ On() [2/6]

virtual void Ext.Net.NodeProxy.On ( string  eventName,
JFunction  fn,
string  scope 
)
inlinevirtual

Appends an event handler to this element (shorthand for addListener)

Parameters
eventNameThe type of event to listen for
fnThe method the event invokes
scopeThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

◆ On() [3/6]

virtual void Ext.Net.NodeProxy.On ( string  eventName,
JFunction  fn,
string  scope,
HandlerConfig  options 
)
inlinevirtual

Appends an event handler to this element (shorthand for addListener)

Parameters
eventNameThe type of event to listen for
fnThe method the event invokes
scopeThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
optionsAn object containing handler configuration.

◆ On() [4/6]

virtual void Ext.Net.NodeProxy.On ( string  eventName,
string  fn 
)
inlinevirtual

Appends an event handler to this element (shorthand for addListener)

Parameters
eventNameThe type of event to listen for
fnThe method the event invokes

◆ On() [5/6]

virtual void Ext.Net.NodeProxy.On ( string  eventName,
string  fn,
string  scope 
)
inlinevirtual

Appends an event handler to this element (shorthand for addListener)

Parameters
eventNameThe type of event to listen for
fnThe method the event invokes
scopeThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

◆ On() [6/6]

virtual void Ext.Net.NodeProxy.On ( string  eventName,
string  fn,
string  scope,
HandlerConfig  options 
)
inlinevirtual

Appends an event handler to this element (shorthand for addListener)

Parameters
eventNameThe type of event to listen for
fnThe method the event invokes
scopeThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
optionsAn object containing handler configuration.

◆ ParentNode()

virtual NodeProxy Ext.Net.NodeProxy.ParentNode ( )
inlinevirtual

A reference to this node's parent node. null if this node is the root node.

Returns

◆ PreviousSibling()

virtual NodeProxy Ext.Net.NodeProxy.PreviousSibling ( )
inlinevirtual

A reference to this node's previous sibling node. null if this node does not have a previous sibling.

Returns

◆ Reject() [1/2]

void Ext.Net.NodeProxy.Reject ( )
inline

Usually called by the Ext.data.Store to which this model instance has been joined. Rejects all changes made to the model instance since either creation, or the last commit operation. Modified fields are reverted to their original values. Developers should subscribe to the Ext.data.Store.update event to have their code notified of reject operations.

◆ Reject() [2/2]

void Ext.Net.NodeProxy.Reject ( bool  silent)
inline

Usually called by the Ext.data.Store to which this model instance has been joined. Rejects all changes made to the model instance since either creation, or the last commit operation. Modified fields are reverted to their original values. Developers should subscribe to the Ext.data.Store.update event to have their code notified of reject operations.

Parameters
silentreject

◆ Reload() [1/2]

virtual void Ext.Net.NodeProxy.Reload ( )
inlinevirtual

Reload the node

◆ Reload() [2/2]

virtual void Ext.Net.NodeProxy.Reload ( object  options)
inlinevirtual

Reload the node

Parameters
options

◆ Remove() [1/2]

virtual void Ext.Net.NodeProxy.Remove ( )
inlinevirtual

Removes this node from its parent

◆ Remove() [2/2]

virtual void Ext.Net.NodeProxy.Remove ( bool  destroy)
inlinevirtual

Removes this node from its parent

Parameters
destroytrue to destroy the node upon removal. Defaults to false.

◆ RemoveAll() [1/2]

virtual void Ext.Net.NodeProxy.RemoveAll ( )
inlinevirtual

Removes all child nodes from this node.

◆ RemoveAll() [2/2]

virtual void Ext.Net.NodeProxy.RemoveAll ( bool  destroy)
inlinevirtual

Removes all child nodes from this node.

Parameters
destroytrue to destroy the node upon removal. Defaults to false.

◆ RemoveChild() [1/2]

virtual void Ext.Net.NodeProxy.RemoveChild ( NodeProxy  node)
inlinevirtual

Removes a child node from this node.

Parameters
nodeThe node to remove

◆ RemoveChild() [2/2]

virtual void Ext.Net.NodeProxy.RemoveChild ( NodeProxy  node,
bool  destroy 
)
inlinevirtual

Removes a child node from this node.

Parameters
nodeThe node to remove
destroytrue to destroy the node upon removal. Defaults to false.

◆ ReplaceChild() [1/2]

virtual void Ext.Net.NodeProxy.ReplaceChild ( Node  newChild,
NodeProxy  oldChild 
)
inlinevirtual

Replaces one child node in this node with another.

Parameters
newChildThe replacement node
oldChildThe node to replace

◆ ReplaceChild() [2/2]

virtual void Ext.Net.NodeProxy.ReplaceChild ( NodeProxy  newChild,
NodeProxy  oldChild 
)
inlinevirtual

Replaces one child node in this node with another.

Parameters
newChildThe replacement node
oldChildThe node to replace

◆ Save() [1/2]

void Ext.Net.NodeProxy.Save ( )
inline

Saves the model instance using the configured proxy

◆ Save() [2/2]

void Ext.Net.NodeProxy.Save ( object  options)
inline

Saves the model instance using the configured proxy

Parameters
optionsOptions to pass to the proxy

◆ Set()

void Ext.Net.NodeProxy.Set ( string  fieldName,
object  value 
)
inline

Sets the given field to the given value, marks the instance as dirty

Parameters
fieldNameThe field to set
valueThe value to set

◆ SetAllowDrag()

void Ext.Net.NodeProxy.SetAllowDrag ( bool  allowDrag)
inline

False to make this node undraggable if draggable = true

Parameters
allowDrag

◆ SetAllowDrop()

void Ext.Net.NodeProxy.SetAllowDrop ( bool  allowDrop)
inline

False if this node cannot have child nodes dropped on it

Parameters
allowDrop

◆ SetChecked()

void Ext.Net.NodeProxy.SetChecked ( bool @  checked)
inline

◆ SetCls()

void Ext.Net.NodeProxy.SetCls ( string  cls)
inline

◆ SetDataPath()

void Ext.Net.NodeProxy.SetDataPath ( string  dataPath)
inline

◆ SetDirty()

new void Ext.Net.NodeProxy.SetDirty ( )
inline

Marks this Record as dirty. This method is used interally when adding phantom records to a writer enabled store. Marking a record dirty causes the phantom to be returned by Ext.data.Store.getModifiedRecords where it will have a create action composed for it during store save operations.

◆ SetHref()

void Ext.Net.NodeProxy.SetHref ( string  href)
inline

◆ SetHrefTarget()

void Ext.Net.NodeProxy.SetHrefTarget ( string  hrefTarget)
inline

◆ SetIcon()

void Ext.Net.NodeProxy.SetIcon ( Icon  icon)
inline

◆ SetIconCls()

void Ext.Net.NodeProxy.SetIconCls ( string  iconCls)
inline

◆ SetIconFile()

void Ext.Net.NodeProxy.SetIconFile ( string  iconFile)
inline

◆ SetId()

void Ext.Net.NodeProxy.SetId ( object  id)
inline

Sets the model instance's id field to the given id

Parameters
idThe new id

◆ SetQTip()

void Ext.Net.NodeProxy.SetQTip ( string  qtip)
inline

◆ SetQtitle()

void Ext.Net.NodeProxy.SetQtitle ( string  qtitle)
inline

◆ SetText()

void Ext.Net.NodeProxy.SetText ( string  text)
inline

◆ Sort() [1/3]

virtual void Ext.Net.NodeProxy.Sort ( JFunction  f)
inlinevirtual

Sorts this nodes children using the supplied sort function.

Parameters
fA function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order.

◆ Sort() [2/3]

virtual void Ext.Net.NodeProxy.Sort ( JFunction  f,
bool  recursive 
)
inlinevirtual

Sorts this nodes children using the supplied sort function.

Parameters
fA function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order.
recursiveWhether or not to apply this sort recursively

◆ Sort() [3/3]

virtual void Ext.Net.NodeProxy.Sort ( JFunction  f,
bool  recursive,
bool  suppressEvent 
)
inlinevirtual

Sorts this nodes children using the supplied sort function.

Parameters
fA function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order.
recursiveWhether or not to apply this sort recursively
suppressEventSet to true to not fire a sort event.

◆ ToScript() [1/3]

virtual string Ext.Net.NodeProxy.ToScript ( )
inlinevirtual

Returns

◆ ToScript() [2/3]

virtual string Ext.Net.NodeProxy.ToScript ( bool  clearBuffer,
bool  ignoreAutoRegister 
)
inlinevirtual

Parameters
clearBuffer
ignoreAutoRegister
Returns

◆ ToScript() [3/3]

virtual string Ext.Net.NodeProxy.ToScript ( bool  ignoreAutoRegister)
inlinevirtual

Returns

◆ Un() [1/2]

virtual void Ext.Net.NodeProxy.Un ( string  eventName,
string  fn 
)
inlinevirtual

Removes an event handler.

Parameters
eventNameThe type of event the handler was associated with.
fnThe handler to remove. This must be a reference to the function passed into the addListener call.

◆ Un() [2/2]

virtual void Ext.Net.NodeProxy.Un ( string  eventName,
string  fn,
string  scope 
)
inlinevirtual

Removes an event handler.

Parameters
eventNameThe type of event the handler was associated with.
fnThe handler to remove. This must be a reference to the function passed into the addListener call.
scopeThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

Property Documentation

◆ AutoRegister

virtual bool Ext.Net.NodeProxy.AutoRegister
getset

◆ IsArray

bool Ext.Net.NodeProxy.IsArray
getsetprotected

◆ MethodScript

virtual string Ext.Net.NodeProxy.MethodScript
getprotected

◆ NodeInstance

virtual string? Ext.Net.NodeProxy.NodeInstance
getprotected

◆ NodeScript

virtual string? Ext.Net.NodeProxy.NodeScript
getprotected

◆ Safe

virtual bool Ext.Net.NodeProxy.Safe
getset

◆ Store

virtual TreeStoreBase Ext.Net.NodeProxy.Store
getprotected

◆ StoreId

virtual string Ext.Net.NodeProxy.StoreId
getprotected


The documentation for this class was generated from the following file: