GoDigram for .NET Framework and .NET Core
Northwoods.Go Namespace / GoToolCreating Class
Properties Methods


In This Topic
    GoToolCreating Class Members
    In This Topic

    The following tables list the members exposed by GoToolCreating.

    Public Constructors
     NameDescription
    Public ConstructorGoToolCreating ConstructorThis constructs a modeless creation tool that has no Prototype object.  
    Top
    Public Properties
     NameDescription
    Public PropertyActive Gets or sets whether this tool is in the process of drawing a new object.  
    Public PropertyAutoScrolling Gets or sets whether dragging the mouse near the edges of the view should cause the view to scroll automatically.  
    Public PropertyCurrentObject Gets or sets this tool's CurrentObject property. (Inherited from Northwoods.Go.GoTool)
    Public PropertyFirstInput Gets this view's FirstInput property. (Inherited from Northwoods.Go.GoTool)
    Public PropertyLastInput Gets this view's LastInput property. (Inherited from Northwoods.Go.GoTool)
    Public PropertyMaximumSizeGets or sets the maximum size for the NewObject, as computed by ComputeBox.  
    Public PropertyMinimumSizeGets or sets the minimum size for the NewObject, as computed by ComputeBox.  
    Public PropertyModal Whether this tool can be used to implement an object-creating mode for a GoView, or whether this tool can be get started when appropriate as one of the GoView.MouseMoveTools.  
    Public PropertyNewObjectGets or sets the GoObject that is a copy of the Prototype that will be added to this view's document in DoCreate.  
    Public PropertyOneShot Whether this tool automatically stops itself on a mouse up event.  
    Public PropertyPrototype Gets or sets the GoObject that should be copied, sized, and positioned by this tool.  
    Public PropertyResizesSelectionObjectGets or sets whether the NewObject or the NewObject's GoObject.SelectionObject has its Bounds set to the value returned by ComputeBox.  
    Public PropertySelection Gets this view's Selection property. (Inherited from Northwoods.Go.GoTool)
    Public PropertySnapsToGridGets or sets whether the result of ComputeBox heeds the view's grid by calling GoView.GoView.SnapPoint.  
    Public PropertyTransactionResult Gets or sets whether to abort the current transaction if this tool is stopped; if set to a string, the string specifies the name of the transaction that will be finished when the tool stops. (Inherited from Northwoods.Go.GoTool)
    Public PropertyView Gets the view for which this tool is handling canonicalized input events. (Inherited from Northwoods.Go.GoTool)
    Top
    Public Methods
     NameDescription
    Public MethodCanStartOverridden.  This tool, when used modelessly, does not start when the user is using the context button or when the mouse is over an object in the document.  
    Public MethodComputeBoxCompute the Bounds for the NewObject, given the initial and current positions of the mouse.  
    Public MethodCopyPrototypeThis method is called to create the NewObject by making a copy of the Prototype.  
    Public MethodDoCancelMouseOverridden. If Modal and not OneShot, the current NewObject is removed but this tool remains active to allow further object creations; otherwise this tool is stopped.  
    Public MethodDoClick Any tool can call this method in order to implement the standard click behavior. (Inherited from Northwoods.Go.GoTool)
    Public MethodDoCreateAdd the NewObject to this view's document.  
    Public MethodDoKeyDownOverridden. When Modal is true and OneShot is false, handle Ctrl-Z and Ctrl-Y for undo and redo.  
    Public MethodDoMouseDownOverridden. A mouse-down activates this tool so that a mouse-move causes the Prototype object to be copied as the NewObject.  
    Public MethodDoMouseHoverThe view calls this method after the mouse rests for a while at a point; all of the event information is provided by the LastInput property. (Inherited from Northwoods.Go.GoTool)
    Public MethodDoMouseMoveOverridden. Create and resize the NewObject that is added to this view.  
    Public MethodDoMouseUpOverridden. A mouse-up calls DoCreate to add the NewObject to the view's document.  
    Public MethodDoMouseWheelThe view calls this method as the mouse wheel rotates; all of the event information is provided by the LastInput property. (Inherited from Northwoods.Go.GoTool)
    Public MethodDoSelect Any tool can call this method in order to implement the standard selection behavior for a user click. (Inherited from Northwoods.Go.GoTool)
    Public MethodIsBeyondDragSizeDetermine if the mouse has gone beyond the DragSize distance to be considered a drag instead of a sloppy click. (Inherited from Northwoods.Go.GoTool)
    Public MethodStartOverridden.  Starting this tool starts a transaction covering all of the changes made until this tool is stopped.  
    Public MethodStartTransaction Start a transaction on the view. (Inherited from Northwoods.Go.GoTool)
    Public MethodStopOverridden. Stopping this tool will remove the temporary NewObject from the view, if it had not yet been added to the document.  
    Public MethodStopTool This method just causes the view's current tool to be stopped and to start the view's default tool instead as the current tool. (Inherited from Northwoods.Go.GoTool)
    Public MethodStopTransactionStop the current transaction, aborting it if TransactionResult is null. (Inherited from Northwoods.Go.GoTool)
    Top
    See Also

    Reference

    GoToolCreating Class
    Northwoods.Go Namespace

     

     

    Copyright © 1998-2019 by Northwoods Software Corporation

    Send Feedback