Nevron Open Vision Documentation
NCompositeTool Class Members
Fields  Properties  Methods  Events


The following tables list the members exposed by NCompositeTool.

Public Constructors
 NameDescription
Public ConstructorNCompositeTool ConstructorDefault constructor  
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)NCompositeToolSchemaSchema associated with NToolGroup  
Top
Public Properties
 NameDescription
Public PropertyActiveToolGets the active child tool within this composite tool  
Public PropertyAmbientGets or sets whether the tool is ambient. Ambient tools are such tools that are usually not disabled by the NInteractor.EnableTool method. (Inherited from Nevron.Nov.UI.NTool)
Public PropertyCountGets the count of elements in this collection.  
Public PropertyEnabledGets or sets whether the tool is enabled. By default false. (Inherited from Nevron.Nov.UI.NTool)
Public PropertyHistoryServiceGets the document effective history service that this node uses to record history (Inherited from Nevron.Nov.Dom.NDocumentNode)
Public PropertyIsActiveGets whether the tool is currently active (Inherited from Nevron.Nov.UI.NTool)
Public PropertyItemGets or sets the element at the specified index.  
Public PropertyOwnerCompositeToolGets a reference to the composite tool to which the tool belongs (Inherited from Nevron.Nov.UI.NTool)
Public PropertyOwnerDocumentGets a reference to the document owning the node. Returns null if the node is not residing in a document. (Inherited from Nevron.Nov.Dom.NDocumentNode)
Public PropertyOwnerInputTargetGets the input target to which this interactor belongs. (Inherited from Nevron.Nov.UI.NTool)
Public PropertyOwnerInteractorGets a reference to the interactor to which the tool belongs (Inherited from Nevron.Nov.UI.NTool)
Public PropertyParentNodeGets the parent node in the node hierarchy. (Inherited from Nevron.Nov.Dom.NNode)
Public PropertyRootNodeGets the root node in the node hierarchy. (Inherited from Nevron.Nov.Dom.NNode)
Public PropertySchemaGets the node schema. (Inherited from Nevron.Nov.Dom.NNode)
Public PropertyTagGets or sets the node tag, that can be any DOM compliant object. This property is not used by the node itself and is intended to provide users with the ability to attach custom data to the node. Attaching custom data to any node can also be achieved with the help of extendeded properties. (Inherited from Nevron.Nov.Dom.NNode)
Top
Public Methods
 NameDescription
Public MethodAbortAborts the tool (Inherited from Nevron.Nov.UI.NTool)
Public MethodAccumulateAggregatedNodesAccumulates the aggregated nodes to the specified list (Inherited from Nevron.Nov.Dom.NNode)
Public MethodAccumulateChildrenOverloaded. Accumulates the children of this node, to the provided node list (Inherited from Nevron.Nov.Dom.NNode)
Public MethodAccumulateDescendantsOverloaded. Accumulates the descendants of this node, to the provided node list (Inherited from Nevron.Nov.Dom.NNode)
Public MethodAccumulatePropertyNodesAccumulates the nodes that are exposed by properties of this node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodActivateActivates the tool (Inherited from Nevron.Nov.UI.NTool)
Public MethodAddAdds (appends) the item at the end of the collection  
Public MethodAddChildAppends the specified node to the end of the list of children of this node. Throws an exception, if this node is not a collection node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodAddEventHandlerOverloaded. Appends an event handler, which is triggered during the AtTarget/Bubbling phase (Inherited from Nevron.Nov.Dom.NNode)
Public MethodCanAbortDetermines whether the tool can abort (Inherited from Nevron.Nov.UI.NTool)
Public MethodCanActivateDetermines whether the tool can activate. (Inherited from Nevron.Nov.UI.NTool)
Public MethodCanDeactivateDetermines whether the tool can deactivate (Inherited from Nevron.Nov.UI.NTool)
Public MethodCanInsertChildQueries whether the specified node can be inserted at the specified index (Inherited from Nevron.Nov.Dom.NNode)
Public MethodCanRecordHistoryDetermines whether this document node can possibly record history for property changes, child changes and fx changes. (Inherited from Nevron.Nov.Dom.NDocumentNode)
Public MethodCanRemoveChild (Inherited from Nevron.Nov.Dom.NNode)
Public MethodCanRemoveChildAtQueries whether the node at the specified index can be removed. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodCanSetChildQueries whether the specified node can be set at the specified named slot (Inherited from Nevron.Nov.Dom.NNode)
Public MethodClearRemoves all children  
Public MethodClearLocalValueClears the local value for the specified property. Has no effect on properties backed by member. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodClearValueClears the value of the specified property. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodContainsQueries whether this collection contains the specified element at least once  
Public MethodContainsEventHandlerReturns true if the node contains the specifeid event handler for the specified dom event (Inherited from Nevron.Nov.Dom.NNode)
Public MethodContainsLocalValueGets whether the node contains a local value setting for the specified property (Inherited from Nevron.Nov.Dom.NNode)
Public MethodCopyToCopies all items of this set to the specified array, starting from the specified array index.  
Public MethodDeactivateDeactivates the tool (Inherited from Nevron.Nov.UI.NTool)
Public MethodDeepCloneOverloaded. Creates an identical copy of this node subtree. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodDeepEqualsPerforms deep equals of this node object in the specified context and returns true if the given object is a node and its properties and children are equal to those of this node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodEqualsOverriden to seal the Equals overridable method and to check the nodes for reference equality. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetAggregatedNodesOverloaded. Gets the nodes aggregated by this node (e.g. both children and property nodes) (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetAggregationInfoGets information about the way in which the node is currently aggregated in its parent (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetAncestorGets the ancestor of this node that is the specified levels-up from this ancestor. 0 is the node itself, 1 is ParentNode, 2 is the ParentNode.ParentNode etc. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetChildOverloaded. Gets the child at the specified named slot. If a child node at the slot does not exist, but the named child is marked as CreateOnDemand, a new child node of the default schema is automatically created. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetChildAtGets the child node at the specified index. Throws an exception, if the index is out of range. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetChildrenOverloaded. Gets a list that contains the children of this node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetChildrenCountOverloaded. Get the count of child nodes (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetChildrenIteratorGets a child node iterator, which iterates through this node children in forward order (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetDepthFromAncestorDetermines the depth of the node from the specfified ancestor (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetDepthFromRootDetermines the depth of the node from the root. The root is at depth 0. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetDescendantsOverloaded. Gets a list, which contains the descendants of this node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetDescendantsCountOverloaded. Returns the number of descendant nodes. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetFirstAncestorOverloaded. Returns the first node ancestor that satisfies the specified filter or null if such ancestor is not found. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetFirstChildOverloaded. Gets the first child node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetFirstCommonAncestorGets the first ancestor, which is an ancestor of this node and the specified node (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetFirstDescendantOverloaded. Gets the first descendant node of the given schema. This method visits descendants in Depth-First Pre-Order. Children are enumerated in forward order (from first to last). (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetHashCodeOverriden to seal the GetHashCode and return the default implementation. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetIteratorGets an iterator that iterates through the children in forward order.  
Public MethodGetLastAncestorOverloaded. Returns the last node ancestor that satisfies the specified filter or null if such ancestor is not found. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetLastChildOverloaded. Gets the last child node (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetLastDescendantOverloaded. Gets the last descendant node of the given schema. This method visits descendants in Depth-First Post-Order. Children are enumerated in reverse order (from last to first). (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetLocalValueOverloaded. Gets the local value of the specified property (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetMediaSafely gets the owner document media. If the document node is not registered in a document returns the screen media. (Inherited from Nevron.Nov.Dom.NDocumentNode)
Public MethodGetNextSiblingGets the next sibling node (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetPathFromAncestorReturns the path from the node to the specified ancestor. The returned path has a root-to-leaf order, meaning that ancestor nodes appear before descendant nodes in the list order. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetPrevSiblingGets the previous sibling node (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetPropertyNodesOverloaded. Gets a list of the nodes, which are exposed as property values (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetReverseChildrenIteratorGets a child node iterator, which iterates through this node children in reverse order (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetReverseIteratorGets an iterator that iterates throw the child elements in reverse order.  
Public MethodGetReverseSubtreeIteratorOverloaded. Gets an iterator, which iterates through the node and its descendants in a Depth-First-Pre-Order fashion (visits the parent and then visits the children). Children are enumerated in reverse order (from last to first). (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetSubtreeIteratorOverloaded. Gets an iterator, which iterates through the node and its descendants in a Depth-First-Pre-Order fashion (visits the parent and then visits the children). Children are enumerated in forward order (from first to last). (Inherited from Nevron.Nov.Dom.NNode)
Public MethodGetToolOverloaded. Gets the first child tool with the specified schema.  
Public MethodGetValueOverloaded. Gets the value of the specified property. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodIndexOfReturns the index of the specified item inside this collection. Returns -1 if the item is not contained in the collection.  
Public MethodIndexOfChildGets the index of the specified child node in this node children container. Returns -1 if the node is not a child of this node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodInsertInserts the item at the specified index  
Public MethodInsertChildInserts the specified node at the specified index. Throws an exception, if this node is not a collection node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodIsChildDetermines whether the specified node is a child node of this node. Note that although the node ParentNode may be this node, this node may not consider the node as child, if it is exposed by a property. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodIsDescendantOfOverloaded. Determines whether this node is a descendant of the specified ancestor (Inherited from Nevron.Nov.Dom.NNode)
Public MethodIsInstanceOfSchemaQueries whether the node is an instance of the specified schema. (i.e. whether the node schema is equal to the specified schema, or is its ancestor). (Inherited from Nevron.Nov.Dom.NNode)
Public MethodMoveToCurrentThreadMoves the node aggregated subtree cache and other thread related information so that the node aggregated subtree can function on the current thread. Call this method when the node has been constructed on another thread, but will continue to be used on the current thread. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodMoveToThreadMoves the node aggregated subtree cache and other thread related information so that the node aggregated subtree can function on the specified thread. Call this method when the node has been constructed on the current thread, but will continue to be used on the specified thread. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodOnDragDropOverridden. Handler for the NDragDrop.DragDropEvent event.  
Public MethodOnDragEnterOverridden. Handler for the NDragDrop.DragEnterEvent event.  
Public MethodOnDragInOverridden. Handler for the NDragDrop.DragInEvent event.  
Public MethodOnDragLeaveOverridden. Handler for the NDragDrop.DragLeaveEvent event.  
Public MethodOnDragOutOverridden. Handler for the NDragDrop.DragOutEvent event.  
Public MethodOnDragOverOverridden. Handler for the NDragDrop.DragOverEvent event.  
Public MethodOnFocusInOverridden. Handler for the NKeyboard.FocusInEvent event.  
Public MethodOnFocusOutOverridden. Handler for the NKeyboard.FocusOutEvent event.  
Public MethodOnGotFocusOverridden. Handler for the NKeyboard.GotFocusEvent event.  
Public MethodOnGotMouseCaptureOverridden. Handler for the NMouse.GotCaptureEvent events  
Public MethodOnGotTouchCaptureOverridden. Handler for the NTouch.GotCaptureEvent events  
Public MethodOnInputCharOverridden. Handler for the NKeyboard.InputCharEvent event.  
Public MethodOnKeyDownOverridden. Handler for the NKeyboard.KeyDownEvent event.  
Public MethodOnKeyUpOverridden. Handler for the NKeyboard.KeyUpEvent event.  
Public MethodOnLostFocusOverridden. Handler for the NKeyboard.LostFocus event.  
Public MethodOnLostMouseCaptureOverridden. Handler for the NMouse.LostCaptureEvent event  
Public MethodOnLostTouchCaptureOverridden. Handler for the NTouch.LostCaptureEvent event  
Public MethodOnMouseCaptureInOverridden. Handler for the NMouse.CaptureInEvent event  
Public MethodOnMouseCaptureOutOverridden. Handler for the NMouse.CaptureOutEvent event  
Public MethodOnMouseDownOverridden. Handler for the NMouse.DownEvent event.  
Public MethodOnMouseEnterOverridden. Handler for the NMouse.EnterEvent event.  
Public MethodOnMouseInOverridden. Handler for the NMouse.InEvent event.  
Public MethodOnMouseLeaveOverridden. Handler for the NMouse.LeaveEvent event.  
Public MethodOnMouseMoveOverridden. Handler for the NMouse.MoveEvent event.  
Public MethodOnMouseOutOverridden. Handler for the NMouse.OutEvent event.  
Public MethodOnMouseUpOverridden. Handler for the NMouse.UpEvent event.  
Public MethodOnMouseWheelOverridden. Handler for the NMouse.WheelEvent event.  
Public MethodOnTouchCaptureInOverridden. Handler for the NTouch.CaptureInEvent event  
Public MethodOnTouchCaptureOutOverridden. Handler for the NTouch.CaptureOutEvent event  
Public MethodOnTouchDownOverridden. Handler for the NTouch.DownEvent event.  
Public MethodOnTouchEnterOverridden. Handler for the NTouch.EnterEvent event.  
Public MethodOnTouchInOverridden. Handler for the NTouch.InEvent event.  
Public MethodOnTouchLeaveOverridden. Handler for the NTouch.LeaveEvent event.  
Public MethodOnTouchMoveOverridden. Handler for the NTouch.MoveEvent event.  
Public MethodOnTouchOutOverridden. Handler for the NTouch.OutEvent event.  
Public MethodOnTouchUpOverridden. Handler for the NTouch.UpEvent event.  
Public MethodRemoveRemoves the specified item.  
Public MethodRemoveAllChildrenRemoves all child nodes of this node. Works for both collection and container node. In the case of container nodes where a child may be set as non-nullable, throws an exception. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodRemoveAllEventHandlersOverloaded. Removes all normal (attarget/bubbling) or sinking event handlers (Inherited from Nevron.Nov.Dom.NNode)
Public MethodRemoveAtRemoves the item at the specified index  
Public MethodRemoveChildRemoves the specified child node. Works for both collection and container nodes. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodRemoveChildAtRemoves the child node at the specified index. Throws an expection if index if out of range. Works for both collection and container nodes. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodRemoveEventHandlerOverloaded. Removes the specified event handler for the specified DOM event. The event handler must have been registered for the AtTarget/Bubbling or the Capturing phase depending on the sinking parameter. The event handler must have been registered for the default group. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodReplaceTool<TTool>Replaces the first tool of the given type TTool with the specified tool instance.  
Public MethodSetChildSets the child instance at the specified child slot. Throws an exception, if this node is not a container node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodSetChildAtSets(substitudes) the child at the specified index. Throws an exception, if this node is not a collection node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodSetLocalValueSets a local value for the specified property. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodSetValueSets the value of the specified property. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodToArrayConverts this set to an array.  
Public MethodToStringReturns a string that represents this node. (Inherited from Nevron.Nov.Dom.NNode)
Public MethodUpdateAidsCalled to update the visual aids of this tool. (Inherited from Nevron.Nov.UI.NTool)
Top
Protected Methods
 NameDescription
Protected MethodCommitDocumentHistoryTransactionCommits the last started transaction in the document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodDeepCopyCoreCalled to perform the actual deep copying of the source node. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodEvaluateDocumentSafely evaluates the document in which this document node resides. If the document node does not reside in a document, does nothing. (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodIsDocumentHistoryUndoingOrRedoingSafely checks whether the document effective history service is currently undoing or redoing an operation. (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodOnAbortedCalled when the tool was aborted. Raises the Aborted event (Inherited from Nevron.Nov.UI.NTool)
Protected MethodOnActivatedCalled when the tool was activated. Raises the Activated event (Inherited from Nevron.Nov.UI.NTool)
Protected MethodOnAncestorsChangedCalled when the node ancestors chain has changed. IMPORTANT: There is a serious perfomance penalty associated with overriding this method. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnChangedCalled when an arbitrary mutation has occurred in this node. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnChildInsertedCalled when a child node has been inserted. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnChildInsertingCalled when a child node is about to be inserted at the specified index. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnChildRemovedCalled when a child node has been removed. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnChildRemovingCalled when a child node is about to be removed. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnChildrenChangedCalled when a child was inserted or removed from this node. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnDeactivatedCalled when the tool was deactivated. Raises the Deactivated event (Inherited from Nevron.Nov.UI.NTool)
Protected MethodOnDeepCopiedCalled after the node is deeply copied from the specified source node. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnDeepCopyingCalled before the node is deeply copied for deep cloning from the specified source node. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnDeserializedCalled when the node is deserialized (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnEnabledChangedCalled when the enabled property has changed. (Inherited from Nevron.Nov.UI.NTool)
Protected MethodOnParentChangedOverridden. Called when the node parent has changed. Raises the ParentChangedEvet  
Protected MethodOnParentChangingCalled when the parent of the node is about to be changed. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnPropertyLocalValueChangingCalled when the local value of a property is about to be changed. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnPropertyValueChangedCalled when the local and/or computed value of a property has changed. (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnRegisteredCalled after the document node is registered in its owner document. (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodOnSerializingCalled when the node is being serialized (Inherited from Nevron.Nov.Dom.NNode)
Protected MethodOnUnregisteredCalled after the document node is unregistered from its owner document. (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodPauseDocumentHistoryServicePauses the document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodRecordDocumentHistoryFieldRecords the state of the specified field in the document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodRecordDocumentHistoryFieldsRecords the state of the specified fields in the document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodRecordDocumentHistoryUnitRecords a history unit in the document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodResumeDocumentHistoryServiceResumes the owner document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodRollbackDocumentHistoryTransactionRolls back the last started transaction in the document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Protected MethodStartDocumentHistoryTransactionOverloaded. Starts a new transaction, in the document effective history service (Inherited from Nevron.Nov.Dom.NDocumentNode)
Top
Public Events
 NameDescription
Public EventAbortedOccurs when a tool has been aborted (Inherited from Nevron.Nov.UI.NTool)
Public EventActivatedOccurs when a tool has been activated (Inherited from Nevron.Nov.UI.NTool)
Public EventChangedOccurs when this node has changed. (Inherited from Nevron.Nov.Dom.NNode)
Public EventChangingOccurs when this node is about to be changed. (Inherited from Nevron.Nov.Dom.NNode)
Public EventChildInsertedOccurs when a child node has been inserted in this node (Inherited from Nevron.Nov.Dom.NNode)
Public EventChildInsertingOccurs when a child node is about to be inserted in this node (Inherited from Nevron.Nov.Dom.NNode)
Public EventChildRemovedOccurs when a child node has been removed from this node (Inherited from Nevron.Nov.Dom.NNode)
Public EventChildRemovingOccurs when a child node is about to be removed from this node (Inherited from Nevron.Nov.Dom.NNode)
Public EventChildrenChangedOccurs when the children set of this node has changed, either because a new child was inserted or because an existing child was removed. (Inherited from Nevron.Nov.Dom.NNode)
Public EventChildrenChangingOccurs when the children set of this node is about to change, either because a new child is about to be inserted or because an existing child is about to be removed. (Inherited from Nevron.Nov.Dom.NNode)
Public EventDeactivatedOccurs when a tool has been deactivated (Inherited from Nevron.Nov.UI.NTool)
Public EventParentChangedOccurs when the parent node of this node has changed. (Inherited from Nevron.Nov.Dom.NNode)
Public EventRegisteredOccurs when the document node is registered in a document (Inherited from Nevron.Nov.Dom.NDocumentNode)
Public EventUnregisteredOccurs when the document node was unregistered from a document (Inherited from Nevron.Nov.Dom.NDocumentNode)
Top
See Also

Reference

NCompositeTool Class
Nevron.Nov.UI Namespace

 

 


©2022. Nevron Software LLC.

Send Feedback