Prod.: Engine, ver.: 6017, ID: 60001102, Wish : Feature to cancel the GetBoundaryPolyFromPoint operation by a user pressed Key

Wish : Feature to cancel the GetBoundaryPolyFromPoint operation by a user pressed Key

Article60001102
TypeWish
ProductEngine
Version6017
Date Added3/9/2010
FixedYes [3/11/2010]
Submitted byMakarounis Yiannis
Keywords

Subject

Feature to cancel the GetBoundaryPolyFromPoint operation by a user pressed Key

Summary

Feature to cancel the GetBoundaryPolyFromPoint operation by a user pressed Key

Solution

In 6018 a new CancelActionKey parameter was added in GetBoundaryPolyFromPoint method of vdPolyline.

Description of method:

 

       /// <summary>
        /// Search the ActiveLayout Entities which are visible in ActiveLayout render to find a closed perigram around the selected point and updates this polyline's VertexList.
        /// </summary>
        /// <param name="origin">The origin point in WCS which must be inside the desired closed path.</param>
        /// <param name="equality">A double representing the equality to be used in calculations(if this is equal to 0.0 the default = PixelSize * 1.4d is used).</param>
        /// <param name="CancelActionKey">A key value used to cancel the method.</param>
        /// <remarks>
        /// The return polyline has the active document default properties and it is not added in the active layout entities collection.
        /// The end points of seaching curves are compared with a default equality equal to (active render pixel size) * 1.4 if passed the parameter is 0.0.
        /// Only the 2d curves with  extrution vector 0,0,1 and in tha same elevation as the z of origin are taken into consideration.
        /// Only arcs , 2dpolylines , lines , circles, rectangles and ellipses, which are not filled are taken into consideration.
        /// Ellipses and polylines with spline flag are exploded into small segments depent on curveresolution.
        /// </remarks>
        public bool GetBoundaryPolyFromPoint(gPoint origin, double equality, System.Windows.Forms.Keys CancelActionKey)

Example:

VectorDraw.Professional.vdFigures.vdPolyline poly = new vdPolyline();

poly.SetUnRegisterDocument(Document);

poly.setDocumentDefaults();

//If the user press the Escape key the operation will be finished thrown an exception and will return false;

bool suc = poly.GetBoundaryPolyFromPoint(pt, 0.0, Keys.Escape);