Nevron Open Vision Documentation
NCreateGuidelineTool Class Members
Fields  Properties  Methods  Events


The following tables list the members exposed by NCreateGuidelineTool.

Public Constructors
 NameDescription
Public ConstructorNCreateGuidelineTool ConstructorDefault constructor  
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)NCreateGuidelineToolSchemaSchema associated with NCreateGuidelineTool  
Top
Public Properties
 NameDescription
Public PropertyAbortKeyGets or sets the keyboard key that aborts this drag tool. By default set to LeftButtonUp. (Inherited from Nevron.Nov.UI.NDragTool)
Public PropertyActivePageGets the active page of the owner drawing (Inherited from Nevron.Nov.Diagram.DrawingTools.NDrawingDragTool)
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 PropertyCreateItemDistanceGets or sets the distance, beyond which the mouse has to be dragged for the respective page item to be created. (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Public PropertyEnabledGets or sets whether the tool is enabled. By default false. (Inherited from Nevron.Nov.UI.NTool)
Public PropertyEndMouseButtonEventGets or sets the mouse button event that deactivates this drag tool. By default set to LeftButtonDown. (Inherited from Nevron.Nov.UI.NDragTool)
Public PropertyIsActiveGets whether the tool is currently active (Inherited from Nevron.Nov.UI.NTool)
Public PropertyOwnerCompositeToolGets a reference to the composite tool to which the tool belongs (Inherited from Nevron.Nov.UI.NTool)
Public PropertyOwnerDrawingViewObtains a reference to the drawing vuew to which this tool belongs (Inherited from Nevron.Nov.Diagram.DrawingTools.NDrawingDragTool)
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 PropertyStartMouseButtonEventGets or sets the mouse button event that activates this drag tool. (Inherited from Nevron.Nov.UI.NDragTool)
Public PropertyStartPagePosGets the mouse start position in page coordinates. Valid only when the tool is active. (Inherited from Nevron.Nov.Diagram.DrawingTools.NDrawingDragTool)
Public PropertyStartScreenPosGets mouse position in screen coordinates at drag tool activation time. Valid only when the tool is active. (Inherited from Nevron.Nov.UI.NDragTool)
Top
Protected Properties
 NameDescription
Protected PropertyCreateItemDistancePassedGets the CreateItemDistance has been passed. (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected PropertyEndSnapPointGets the snap point (in drawing coordinates) with which the page item preview was last stretched. (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected PropertyPageItemObtains a reference to the page element, which is created for preview purposes. (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected PropertyStartSnapPointGets the snap point (in drawing coordinates) with which the page item preview was started. (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Top
Public Methods
 NameDescription
Public MethodAbortAborts the tool (Inherited from Nevron.Nov.UI.NTool)
Public MethodActivateActivates the tool (Inherited from Nevron.Nov.UI.NTool)
Public MethodCanAbortOverloaded.  (Inherited from Nevron.Nov.UI.NDragTool)
Public MethodCanActivateOverloaded. Overridden. Determines whether the tool can activate  
Public MethodCanDeactivateOverloaded. Determines whether the tool can decactivate itself in response to a mouse button args event (Inherited from Nevron.Nov.UI.NDragTool)
Public MethodDeactivateDeactivates the tool (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnDragDropHandler for the NDragDrop.DragDropEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnDragEnterHandler for the NDragDrop.DragEnterEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnDragInHandler for the NDragDrop.DragInEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnDragLeaveHandler for the NDragDrop.DragLeaveEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnDragOutHandler for the NDragDrop.DragOutEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnDragOverHandler for the NDragDrop.DragOverEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnFocusInHandler for the NKeyboard.FocusInEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnFocusOut (Inherited from Nevron.Nov.UI.NDragTool)
Public MethodOnGotFocusHandler for the NKeyboard.GotFocusEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnGotMouseCaptureHandler for the NMouse.GotCaptureEvent events (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnGotTouchCaptureHandler for the NTouch.GotCaptureEvent events (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnInputCharHandler for the NKeyboard.InputCharEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnKeyDownProcesses the key down event (Inherited from Nevron.Nov.UI.NDragTool)
Public MethodOnKeyUpHandler for the NKeyboard.KeyUpEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnLostFocusHandler for the NKeyboard.LostFocus event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnLostMouseCaptureHandler for the NMouse.LostCaptureEvent event (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnLostTouchCaptureHandler for the NTouch.LostCaptureEvent event (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnMouseCaptureInHandler for the NMouse.CaptureInEvent event (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnMouseCaptureOutHandler for the NMouse.CaptureOutEvent event (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnMouseDownHandler for the NMouse.DownEvent event. (Inherited from Nevron.Nov.UI.NDragTool)
Public MethodOnMouseEnterHandler for the NMouse.EnterEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnMouseInHandler for the NMouse.InEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnMouseLeaveHandler for the NMouse.LeaveEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnMouseMoveOverridden.   
Public MethodOnMouseOutHandler for the NMouse.OutEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnMouseUpProcesses the mouse up event (Inherited from Nevron.Nov.UI.NDragTool)
Public MethodOnMouseWheelHandler for the NMouse.WheelEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchCaptureInHandler for the NTouch.CaptureInEvent event (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchCaptureOutHandler for the NTouch.CaptureOutEvent event (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchDownHandler for the NTouch.DownEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchEnterHandler for the NTouch.EnterEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchInHandler for the NTouch.InEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchLeaveHandler for the NTouch.LeaveEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchMoveHandler for the NTouch.MoveEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchOutHandler for the NTouch.OutEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodOnTouchUpHandler for the NTouch.UpEvent event. (Inherited from Nevron.Nov.UI.NTool)
Public MethodUpdateAidsCalled to update the visual aids of this tool. (Inherited from Nevron.Nov.UI.NTool)
Top
Protected Methods
 NameDescription
Protected MethodActivationHandlesEventReturns whether the activation of the tool must handle(cancel) the event. (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodAddPageItemToActivePageOverridden. Overriden to add the guideline to the page if the guideline is inside the drawing window area.  
Protected MethodCaptureMouseOnActivatedGets whether the tool must capture the mouse on the interactor target when activated. This implementation returns true. (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodCreateActivationAreaGets the area in which this tool can activate. A return value of null, means that the tool can activate in any area. (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodCreatePageItemOverridden. Overriden to create a horizontal or vertical guideline, depending on whether the HRuler or VRuler was hit.  
Protected MethodDeactivationHandlesEventReturns whether the deactivation of the tool must handle(cancel) the event. (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodEndPreviewEnds the preview of the page item. This implementation removes the item from the active page previews. (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected MethodFocusOnActivatedGets whether the tool must focus the interactor target when activated. This implementation returns true. (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodGetActiveCursorAndTooltipOverridden. Gets the cursor and tooltip that the tool requests when active  
Protected MethodGetReadyCursorAndTooltipGets the cursor and tooltip that the tool requests when not active. (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodIsPageItemContentEmptyDetermines whether the page item content is empty (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected MethodOnAbortedOverridden. Called when the tool was aborted  
Protected MethodOnActivatedOverriden to start a drag operation in the view (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected MethodOnDeactivatedOverridden. Called when the tool was deactivated  
Protected MethodOnEnabledChangedCalled when the enabled flag has changed (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected MethodOnMouseDownOrUp (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodOnParentChangedCalled when the node parent has changed. Raises the ParentChangedEvet (Inherited from Nevron.Nov.UI.NTool)
Protected MethodOperatesInWindowAreaOverridden.   
Protected MethodSnapPointOverridden. Overriden to snap the X or Y coordinate of the point, depending on the tool mode  
Protected MethodStartPreviewStarts a the page item preview. This implementation creates a page item and adds it the active page previews. (Inherited from Nevron.Nov.Diagram.DrawingTools.NCreatePageItemTool<NGuideline>)
Protected MethodStretchPreviewOverridden. Overriden to change the guideline coordinate  
Protected MethodTryActivateOverridden. Overriden to active the tool in H or V guideline mode  
Protected MethodTryDeactivateTries to deactivate the tool in response to the specified mouse event. Returns true if the tool is deactivated after the call. (Inherited from Nevron.Nov.UI.NDragTool)
Protected MethodUpdateCursorAndTooltipRequests cursor and tooltip depending on the tool state. (Inherited from Nevron.Nov.Diagram.DrawingTools.NDrawingDragTool)
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 EventDeactivatedOccurs when a tool has been deactivated (Inherited from Nevron.Nov.UI.NTool)
Top
See Also

Reference

NCreateGuidelineTool Class
Nevron.Nov.Diagram.DrawingTools Namespace

 

 


©2021. Nevron Software LLC.

Send Feedback