Class vdCommandAction

Namespace: VectorDraw.Professional.ActionUtilities

Assembly: VectorDraw.Professional.dll

Provides predefined drawing commands for creating, editing, and transforming entities in a vdDocument. Access this object through the CommandAction property.

public sealed class vdCommandAction : BaseObject, IDisposable, IBaseObject

Inheritance: object

BaseObject

vdCommandAction

Implements: IDisposable

IBaseObject

Inherited Members: BaseObject.GetHashCode()

BaseObject.Dispose()

BaseObject.Id

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Remarks

The vdCommandAction class exposes methods for:

Creating 2D entities: circles, lines, arcs, rectangles, polylines, ellipses, text, dimensions, etc.
Creating 3D entities: boxes, cones, spheres, torus, polyface meshes and boolean operations of these 3D objects.
Editing operations: copy, move, rotate, scale, mirror, offset, trim, extend, fillet, chamfer, explode and more.
View control: zoom, pan, different 3D views, render modes and UCS management.
File operations: open, save, PDF import, STL export.
Clipboard operations: copy, cut and paste.
Undo/Redo support.

Methods prefixed with Cmd (e.g. CmdCircle(object, object), CmdLine(object)) execute commands programmatically with specified parameters. Static methods suffixed with Ex (e.g. CircleEx(vdDocument), LineEx(vdDocument)) launch interactive commands that prompt the user for input.

Example: Create a circle and a line programmatically.

vdDocument doc = vdFramedControl.BaseControl.ActiveDocument;
doc.New();
var cmd = doc.CommandAction;
cmd.CmdCircle(new gPoint(0, 0, 0), 2.0);
cmd.CmdLine(new gPoints(new gPoint[] { new gPoint(-5, 0, 0), new gPoint(5, 0, 0) }));
doc.ZoomExtents();
doc.Redraw(false);

Properties

OpenLoops: Gets the number of currently active commands or user actions waiting for input.

Methods

AddAttribute(): Shows the Add Attribute dialog in order to add an attribute to the vdDocument object.

AddAttributeEx(vdDocument): Launches an interactive command to add attributes to the specified document.

ArcEx(vdDocument): Launches an interactive arc drawing command on the specified document.

ArrayPolarEx(vdDocument): Starts the polar array command so the user can place copies of the selection in a circle around a center point.

ArrayRectangularEx(vdDocument): Starts the rectangular array command so the user can place copies of the selection in rows and columns.

Box3dEx(vdDocument): Starts the 3D box drawing command so the user can create a box by picking points and entering sizes.

BreakEx(vdDocument): Breaks on line of an object by cutting the section between two points.

BurstEx(vdDocument): Opens an interactive command that lets the user select block inserts (vdInsert objects) and break them down into sub-entities while preserving attribute values as text objects.

Cancel(): Cancels all active commands and actions currently running in the Document.

Cancel1(): Cancels only the most recently active command/action, leaving other nested or concurrent commands running.

ChamferEx(vdDocument): Initiates a fully interactive chamfer command that allows the user to configure the chamfer method, distances, angle, and trim mode, then repeatedly select pairs of vdLine entities or vdPolyline segments to apply chamfers. The session continues until the user presses Enter to exit. All changes are grouped under a single named undo entry.

ChangeOrderEx(vdDocument): Starts the change order command so the user can select an entity and move it to the front or back of the drawing order.

Circle2pEx(vdDocument): Launches an interactive command for the user to draw a circle by specifying two symmetrical points (diameter) on its circumference.

Circle3Tan(vdDocument): Launches an interactive command for the user to draw a circle tangent to three curves (line, arc, and/or circle) or points.

Circle3pEx(vdDocument): Launches an interactive command for the user to draw a circle by specifying three points on its circumference.

CircleDiameter(vdDocument): Launches an interactive command that creates a circle by specifying its diameter (two points).

CircleEx(vdDocument): Launches an interactive command for the user to draw a circle by specifying center point and radius graphically.

CircleTanTanRad(vdDocument): Launches an interactive command for the user to draw a circle tangent to two curves with a specified radius.

ClipCopyEx(vdDocument): Launches an interactive command that lets the user select drawing objects and copy them to the system clipboard for pasting into other VectorDraw applications.

ClipCutEx(vdDocument): Launches an interactive command that lets the user select drawing objects, copy them to the system clipboard, and then delete them from the document.

ClipPasteEx(vdDocument): Launches an interactive command that lets the user paste drawing objects from the system clipboard into the document at a location they choose.

CloudEx(vdDocument): Initiates a fully interactive revision cloud command that prompts the user to specify an arc distance, then either freehand-draw a new cloud by clicking points in the viewport or convert an existing curve entity into a revision cloud. The resulting cloud is added to the active layout's entity collection as a vdPolyline with arc bulge vertices.

Cmd3DMesh(object, object, object): Creates a 3D mesh by defining the number of points in two directions and the list of vertex points.

Cmd3dFace(object): Creates a 3D face (a vd3DFace) from three or four points.

CmdAddSectionClip(object, object, object): Adds a named vdSectionClip to the active layout's (or active viewport's) Sections collection, defined by an origin point and a clipping plane direction in the current UCS. If a section clip with the supplied name already exists, its origin and direction are updated and it is re-enabled rather than creating a duplicate. The render is invalidated immediately after the operation.

CmdAddSectionClipEx(vdDocument): Initiates a fully interactive section clip command that prompts the user to enter a name, pick an origin point, and specify the visible side of the cutting plane of view. The resulting vdSectionClip is added to — or updated in — the active layout's (or active viewport's) Sections collection and immediately invalidates the render.

CmdAlign(object, object, object): Aligns selected entities to specified reference points, applying translation, rotation, and optionally scaling transformations based on the alignment point configuration and user preferences.

CmdAlignEx(vdDocument): Initiates a fully interactive command to align selected entities to reference points, applying translation, rotation, and optionally scaling transformations based on the alignment point configuration.

CmdArc(object, object, object, object): Performs a command to draw an arc to the passed document.

CmdArcAlignedText(object, string): Creates an arc-aligned text entity by positioning and rotating individual text characters along the curvature of a specified vdArc. The text follows the arc's geometry, with each character oriented tangentially to the arc.

CmdArcAlignedTextEx(vdDocument): Initiates a fully interactive arc-aligned text command that prompts the user to select a vdArc entity and then enter a text string. The text characters are positioned and rotated to follow the selected arc, creating a vdArcAlignedText entity linked to the arc via its "ReferenceObj" property.

CmdArea(object, object, out double, out double): Calculates the area and perimeter length of a drawing figure. Supports interactive user input or fully programmatic invocation against a vdCurve, vdPolyhatch, or vd3DFace entity.

CmdArrayPolar(object, object, object, object, object): Creates a circular array of copies from the selected objects around a center point.

CmdArrayRectangular(object, object, object, object, object): Creates a grid of copies from the current selection by asking for rows, columns, and spacing.

CmdArrayRectangular(object, object, object, object, object, int): Creates a grid of copies from the selection in rows and columns, using a specific fill order.

CmdBox3d(object, object, object, object, object): Creates a 3D box in the document.

CmdBreak(object, object, object): Breaks entities by removing the section between two points, splitting it into two separate pieces.

CmdBurst(object): Explodes selected block inserts into sub-entities while converting attribute values into regular text objects so that the displayed values are preserved.

CmdChamfer(object, object, object, object, object, object, object, bool): Chamfers the edges of two lines or a polyline using the passed parameters.

CmdChangeOrder(object, object): Changes the drawing order of a figure, moving it to the front or back in its collection.

CmdCircle(object, object): Starts a command so the user can draw a circle. This is a user-command where the user can choose using graphical interface the position and/or size of the circle.

CmdCircle3Tan(object, object, object): Creates a circle tangent to three curves (or passing through three points).

CmdCircleDiameter(object, object): Creates a circle using a center point and a diameter.

CmdCircleTanTanRad(object, object, object): Creates a circle tangent to two existing curves with a specified radius.

CmdClipCopy(object): Copies selected drawing objects to the system clipboard with the center of their bounding box automatically used as the reference point.

CmdClipCopy(object, int): Copies selected drawing objects to the system clipboard, using a predefined base point.

CmdClipCopy(object, object): Copies selected drawing objects to the system clipboard with a custom reference point specified as a coordinate in User Coordinate System (UCS).

CmdClipCut(object): Cuts selected drawing objects to the system clipboard and removes them from the document with the center of their bounding box automatically used as the reference point.

CmdClipCut(object, int): Cuts selected drawing objects to the system clipboard and removes them from the document, using a predefined base point from a 3x3 grid (1–9).

CmdClipCut(object, object): Cuts selected drawing objects to the system clipboard and removes them from the document, using a custom reference point specified as a coordinate in User Coordinate System (UCS).

CmdClipPaste(object): Pastes drawing objects from the system clipboard into the document at a specified or user-chosen insertion point.

CmdCloud(object, object): Creates a revision cloud as a vdPolyline with arc-bulge vertices, either by freehand-drawing in the viewport or by converting an existing vdCurve entity. The arc segment length is controlled by ArcDistance. When converting an existing curve, the source entity is deleted and replaced by the resulting cloud polyline. All changes are grouped under a single undo entry.

CmdCombinePolyfaces(object, object, BooleanOperation): Combines two vdPolyface entities using a specified Boolean operation, creating a new polyface that represents the result of the operation. The source polyfaces are preserved, and the user is prompted to reposition (move) the resulting polyface.

CmdCombinePolyfaces(object, object, BooleanOperation, bool, bool): Combines two vdPolyface entities using a specified Boolean operation, creating a new polyface that represents the result of the operation. The source polyfaces can be provided directly or selected interactively by the user.

CmdCombinePolyfacesIntersection(vdDocument): Initiates an interactive command to combine two polyfaces using the intersection Boolean operation. The user is prompted to select two vdPolyface entities, and the resulting intersected polyface is created and added to the document.

CmdCombinePolyfacesReverseSubsctraction(vdDocument): Initiates an interactive command to combine two polyfaces using the reverse subtraction Boolean operation. The user is prompted to select two vdPolyface entities, and the resulting polyface (representing the subtraction of the second polyface from the first) is created and added to the document.

CmdCombinePolyfacesSubstraction(vdDocument): Initiates an interactive command to combine two polyfaces using the subtraction Boolean operation. The user is prompted to select two vdPolyface entities, and the resulting polyface (representing the subtraction of the second polyface from the first) is created and added to the document.

CmdCombinePolyfacesUnion(vdDocument): Initiates an interactive command to combine two polyfaces using the union Boolean operation. The user is prompted to select two vdPolyface entities, and the resulting combined polyface is created and added to the document.

CmdCompare(object, object, bool): Compares two drawings and visualizes the differences in the current document.

CmdCompareEx(vdDocument): Launches an interactive command that compares two drawing files and visualizes the differences in the current document with color-coded highlighting.

CmdCone(object, object, object, object, object): Creates a 3D cone or truncated cone (frustum) as a vdPolyface and adds the resulting vdPolyface mesh to the active layout of the document.

CmdCopy(object, object, object): Copies a selection set of entities from a source point to a destination point.

CmdCopy(object, object, object, bool): Creates a copy of the selected objects and places them at a new location by calculating the offset between two points.

CmdCreatePolylineAutoBulge(object, object): Automatically detects and creates bulged arc segments in a polyline where points are closely spaced, replacing them with smooth arcs based on a specified tolerance.

CmdCreatePolylineAutoBulgeEx(vdDocument): Launches an interactive command that automatically detects and creates bulged arc segments in a polyline where points are closely spaced, based on a specified tolerance.

CmdCreatePolylineBulge(object, object, object, object): Creates a bulged arc segment in a polyline defined by start, end, and mid-points, with support for both interactive and programmatic parameter specification.

CmdCreatePolylineBulgeEx(vdDocument): Launches an interactive command that creates a bulged segment in a polyline by specifying start, end, and mid points.

CmdCurvePushPull(object, object): Executes a Push/Pull operation on a vdPolyface by allowing the user to draw a closed curve (vdCircle, vdEllipse, vdPolyline, or vdRect) that fits entirely within a set of coplanar faces, extrude it with a thickness, and combine the result with the original polyface via a Boolean Union (push outward) or Subtraction (pull inward), determined automatically by the extrusion direction. All changes are wrapped in a single named undo entry.

CmdCurvePushPullEx(vdDocument): Initiates a fully interactive Push/Pull command that allows the user to select a vdPolyface, pick one or more coplanar faces, draw a closede curve (vdCircle, vdEllipse, vdPolyline, or vdRect) that fits entirely within those faces, and then apply a thickness to extrude it. The extruded curve is combined with the original polyface via a Boolean Union (push outward) or Subtraction (pull inward) operation, depending on whether the extrusion direction points outside or inside the existing mesh. All changes are wrapped in a single named undo entry.

CmdCutPolyface(object, object, object, object): Cuts one or more vdPolyface entities along a vdCurve, retaining only the portion on the side of a specified keep-point. Optionally covers the faces exposed by the cut. The operation modifies each selected polyface in place and groups all changes under a single undo entry.

CmdCutPolyface(object, object, object, object, object, bool): Cuts one or more vdPolyface entities along a vdCurve, retaining only the portion on the side of a specified keep-point, with explicit control over cover face generation, resulting triangle edge visibility, and cover face edge visibility. The operation modifies each selected polyface in place and groups all changes under a single undo entry.

CmdCutPolyfaceEx(vdDocument): Initiates a fully interactive cut command that prompts the user to select one or more vdPolyface entities, pick a cutting curve, specify the side of the polyface to keep, and confirm whether to cover the exposed cut faces. The operation modifies each selected polyface in place and groups all changes under a single undo entry.

CmdDim(VdConstDimType, object, object, double): Creates a dimension of the specified type and adds it to the active layout.

CmdDimAR(object): Creates an auto-rotated linear dimension that automatically chooses horizontal or vertical orientation based (0 or 90 degrees) on the measured points and lets the user pick the dimension line position.

CmdDimArc(object, object, object): Adds a dimension to an arc, measuring either its angle or its arc length, and links the dimension to the arc so it updates automatically.

CmdDimArcEx(vdDocument): Opens an interactive command that lets the user select an arc and add an angular dimension to it, measuring either the angle or the arc length.

CmdDimContinuous(object, object, object, object, object): This command can be used to create multiple Dimensions

CmdDimContinuousLinearEx(vdDocument): Opens an interactive command that creates multiple consecutive linear (non-stacked) dimensions along a series of points in the specified document.

CmdDimContinuousStackedEx(vdDocument): Opens an interactive command that creates multiple stacked (baseline) dimensions from a shared first point across a series of subsequent points in the specified document.

CmdDimLine(object, object, object): Creates an associative dimension on a vdLine object. The dimension type can be Aligned, Horizontal, or Vertical.

CmdDimLineEx(vdDocument): Opens an interactive command that lets the user select a vdLine object and creates an associative dimension (Aligned, Horizontal, or Vertical) on it.

CmdDimPolyline(object, object): Adds a dimension to a segment of a polyline. The dimension type is chosen automatically based on the segment: aligned for straight segments, or the user chooses radial/diameter/angle/length for arc segments of the polyline.

CmdDimPolylineEx(vdDocument): Opens an interactive command that lets the user click on a polyline segment and add a dimension to it (aligned, radial, diameter or angular depending on the segment type).

CmdDimStyleDialog(): Opens the dimension style manager dialog so the user can create, edit, and delete dimension styles in the current document.

CmdDimStyleDialogEx(vdDocument): Opens the dimension style manager dialog so the user can create, edit, and delete dimension styles in the current document.

CmdDivide(object, object): Divides the specified entity into an equal number of segments by placing marker points along it, without breaking the original entity.

CmdDivideToCurves(object, object): Creates a new vdCurves objects with segments from a vdCurve object after it is divided

CmdDivideToPoints(object, object): Divides the specified entity into an equal number of segments by placing vdPoint entities at equal arc-length intervals along it, without modifying the original entity.

CmdEditTxT(object): Opens a text edit tool so the user can change an existing text object, vdMtext or vdText object.

CmdEditTxTEx(vdDocument): Opens the interactive "Edit Text" command so the user can pick and modify a text item (single-line vdText or multiline vdMText) on the drawing.

CmdEllipse(object, object, object): Creates an ellipse (vdEllipse object) and adds it to the document.

CmdErase(object): Deletes the specified drawing objects from the active layout. The figures are not destroyed from memory — they are marked as deleted and can be brought back with an Undo operation.

CmdExplode(object): Breaks down (explodes) selected objects into their individual sub-entities and replaces the originals in the document with them.

CmdExportLayoutToModel(object, object): Exports all layouts from the current document to a model space representation and saves the result to a file.

CmdExtend(object, object): Extend a selected entity to the intersection of another.

CmdExtend(object, object, bool): Extend a selected entity to the intersection of another.

CmdFillet(object, object): Fillets the edges between arcs and lines.

CmdFilletRadius(object, object, object): Fillets the edges between arcs and lines and polylines with an arc that is tangent to the edges and has a specified radius.

CmdGenerate3dPathSection(object, object, object, object): Creates a 3D polyface by sweeping a 2D section profile along a 3D path curve, with support for both interactive and programmatic parameter specification.

CmdHelix(object, object, object, object): Creates a vdHelix 3D curve with specified geometric parameters. Supports both programmatic input with explicit values and interactive user input via the viewport.

CmdHelixEx(vdDocument): Initiates a fully interactive command to create a 3D helix curve. Prompts the user to specify the base center point, base radius, top radius, and height of the helix geometry.

CmdHidePolyfaceEdges(object, object): Hides one or more edges of a vdPolyface by negating the corresponding indices in its FaceList. A negative FaceList entry marks the edge as invisible without removing it from the mesh topology. The polyface is updated and invalidated after the changes are applied.

CmdHidePolyfaceEdgesEx(vdDocument): Initiates a fully interactive command that prompts the user to select a vdPolyface entity and then click individual edges to hide them. Each selected edge index is negated in the polyface's FaceList, making that edge invisible without removing it from the mesh topology. Holding Shift during edge selection deselects previously hidden edges.

CmdImage(string, object): Loads an image file, registers its vdImageDef in the document's Images collection, and inserts the resulting vdImage entity into the active layout.

CmdImage(vdImage, object): Inserts a pre-configured vdImage entity into the active layout of the document, optionally prompting the user to pick the insertion point on screen.

CmdInsert(object, object, object, object, object): Inserts a block into the active layout with specified insertion point, scale factors (X and Y only), and rotation angle.

CmdInsert(object, object, FollowMode, object, object, object, object, object): Inserts a block into the active layout with full control over insertion point, scale (X, Y, Z), rotation, and optional constraint to a boundary path.

CmdInsertBlockDialog(): Opens a dialog for selecting and inserting a block in the document.

CmdInsertBlockDialog(string, bool, object, object, object): Opens the insert-block dialog, optionally pre-populating the dialog fields with the supplied block definition data.

CmdJoin(object): Joins multiple open curve entities into single vdPolyline objects by connecting their compatible endpoints. Supports both programmatic selection and interactive user selection.

CmdJoinEx(vdDocument): Initiates a fully interactive command to join multiple open curve entities into a single polyline. Prompts the user to select compatible curve entities and automatically combines them into joined polylines.

CmdLayerDialogEx(vdDocument): Opens the layer manager dialog so the user can view and edit all layers defined in the current document.

CmdLayoutSplitDialogEx(vdDocument): Opens the layout-split dialog so the user can configure the active vdLayoutSplit.

CmdLeader(object, object): A command that creates a leader line with annotation text programmatically using a vertex list and text content.

CmdLine(object): Performs a command to draw lines to the document.

CmdMText(object, object, object): Creates multi-line formatted text (MText) and adds it to the active layout.

CmdMText(object, object, object, int, int): Creates multi-line formatted text (MText) at a given point, with rotation and simple limits for wrapping and total text length.

CmdMText(object, object, object, object, int, int): Creates multi-line formatted text (MText) and adds it to the active layout. The command accepts either explicit values or interactive input when parameters are null/"USER".

CmdMakeBlock(object, object, object): Creates a named vdBlock definition from a set of entities, removes those entities from the active layout, and registers the block in the document's Blocks collection.

CmdMirror(object, object, object, object): Mirrors the current selection across a user-defined axis and optionally keeps the originals.

CmdMove(object, object, object): Moves the selected drawing objects from one point to another. The displacement is calculated as the difference between ToPoint and FromPoint.

CmdMove(object, object, object, FollowMode, object): Moves the selected drawing objects from one point to another, with an option to constrain (lock) the movement along or inside a boundary curve.

CmdMtextEdit(object): Opens the MText editor for an existing multi-line text object so the user can modify it.

CmdMtextEdit(object, int, int): Opens the MText editor for an existing multi-line text object and enforces simple wrapping and total-length limits while the user edits.

CmdMtextEditEx(vdDocument): Opens the interactive MText edit command so the user can pick and modify an existing multi-line text object in the document.

CmdMultiLine(object): Creates a vdMultiline entity either from a supplied set of vertices or through a fully interactive session after picking the multiline vertices. The resulting entity is added to the active layout's entity collection.

CmdMultiLineEx(vdDocument): Initiates a fully interactive multiline drawing command that prompts the user to pick a series of vertices to define a vdMultiline entity. The completed multiline is added to the active layout's entity collection.

CmdObjectToMesh(object): Turns the chosen objects into mesh shapes by replacing them with their mesh versions.

CmdOffset(object, object, object): Creates a new "offset" entity at a specified distance from an existing curve-based entity, on a given side determined by a point.

CmdOffsetEx(object, object, object, int, double): Offsets the given entity or selection by a specified distance and returns whether the operation produced geometry.

CmdPDFImport(object): Imports a PDF file page into the document, allowing the user to select which page to insert and configure import options through an interactive dialog.

CmdPDFImportEx(vdDocument): Initiates a fully interactive command to import a PDF file into the document, allowing the user to browse for a PDF file and configure import options through dialogs.

CmdPlineToMesh(object, object, object): Converts a polyline into a 3D mesh (a vdPolyface) inside the given document.

CmdPoint(object): Creates a vdPoint entity and adds it to the active layout of the document.

CmdPointDialogEx(vdDocument): Opens the point-style dialog so the user can configure the current document’s point display settings.

CmdPointStyleDlg(): Displays the point style dialog so the user can configure the document’s point symbol settings.

CmdPolyLine(object): Creates a vdPolyline entity and adds it to the active layout's entity collection. Supports both programmatic creation from a point list and interactive user-driven vertex picking.

CmdPrintDialog(object, object): Displays the print dialog for the current document, optionally pre-configuring the print window and scale.

CmdRay(object): Creates a ray (semi-infinite line) using a parameter list containing all necessary definition data.

CmdRay(object, object): Creates a ray (semi-infinite line) programmatically with the specified base point and direction.

CmdRect(object, object): Creates a rectangle (vdRect) and adds it to the document.

CmdRemovePolyfaceFaces(object, object, bool): Permanently removes one or more faces from a vdPolyface by rebuilding its FaceList without the selected face entries. Optionally removes any vertices that are no longer referenced by any remaining face. The polyface is updated and invalidated after the changes are applied, and all modifications are wrapped in a single named undo entry.

CmdRemovePolyfaceFacesEx(vdDocument): Initiates a fully interactive command that prompts the user to select a vdPolyface entity and then click individual faces to permanently remove them. The selected face entries are eliminated from FaceList and unused vertices are automatically cleaned up afterwards. All changes are wrapped in a single named undo entry.

CmdRotate(object, object, object): Rotates a selection set of entities around a specified base point by a given rotation angle.

CmdRotate(object, object, object, object): Rotates a selection set of entities around a base point using a reference angle and a target rotation angle.

CmdRotate3d(object, object, object, object): Runs the 3D rotate tool so the user can spin the selected figures around any axis.

CmdScale(object, object, object): Resizes the selected drawing objects by a scale factor around a fixed base point. Scaling is applied only in the X and Y directions — the Z axis is left unchanged.

CmdScale(object, object, object, object): Resizes the selected drawing objects by a scale factor around a fixed base point, with an option to include or exclude the Z direction scalling.

CmdSearchText(): Opens the Search and Replace text dialog for the associated vdDocument, allowing the user to find and optionally replace text strings within all text entities in the document. The method returns "true" only when the user closes the dialog by confirming with OK.

CmdSelect(object): Selects drawing objects using a specified mode or selection object. Results are stored in an internal selection set that can be retrieved later.

CmdSelectClipImageObject(object, object): Clips a vdImage entity using a curve boundary. The clip curve is sampled, transformed from the curve's coordinate system into image-local coordinates (Entity Coordinate System, or ECS), (accounting for image scale and orientation), and assigned to ClipBoundary, masking the portion of the image outside the boundary.

CmdSelectClipImageObjectEx(vdDocument): Initiates a fully interactive image-clipping command that prompts the user to select a vdImage entity and then either pick an existing curve or draw a freehand polyline to define the clip boundary. The selected curve is transformed into image-local coordinates and applied as the image's ClipBoundary, masking the portion of the image that falls outside it.

CmdSketch(object, Color): Starts a freehand sketch session that captures mouse movement as one or more vdPolyline entities, each sampled at a configurable record increment distance. Completed strokes are drawn using the specified rubber-line preview color and added to the active layout's entity collection. All strokes produced in a single session are grouped under one undo entry.

CmdSlice(object, object, object, object): Slices a vdPolyface (or vdGroundSurface) entity along a cutting plane defined by an origin point and a direction vector, optionally covering the exposed faces produced by the cut. The operation modifies the target entity in place.

CmdSphere(object, object, object, object): Creates a 3D sphere mesh and adds the resulting vdPolyface to the active layout of the document.

CmdSpline(object): Creates spline geometry from a point collection or starts the interactive Spline command.

CmdSpline(object, VdConstSplineFlag): Creates one or more spline entities from a point collection or by launching an interactive spline workflow, depending on ParamList. The created spline(s) are added to the active layout and the operation is recorded in the document undo history.

CmdStretch(object, object, object, object): Stretches entities by moving the grip points of selected figures that lie inside one or more specified polygon boundaries from a base point to a target point. The displacement vector (ToPoint - FromPoint) is applied to all qualifying grip points within the polygon boundaries. This is the polygon-based overload of the stretch command.

CmdStretch(object, object, object, object, object): Stretches entities by moving the grip points of selected figures that lie inside a specified rectangular window from a base point to a target point. The displacement vector (ToPoint - FromPoint) is applied to all qualifying grip points within the window. This is the window-based overload of the stretch command.

CmdSubstractCurvesFromPoly(object, object, bool): Subtracts selected closed curves from a main polyline, creating a new polyline with the subtracted regions removed and optionally moving the result.

CmdSubstractCurvesFromPolyEx(vdDocument): Launches an interactive command that subtracts selected closed curves from a polyline, creating a new polyline with the subtracted regions removed.

CmdText(object, object, object): Adds text to the drawing at a given point with a specific rotation.

CmdText(object, object, object, object): Adds text to the drawing at a specified location with a custom height and rotation angle.

CmdTextEdit(object): Opens an editor to modify an existing single-line text object (vdText) in the drawing. If no object is passed, the user is prompted to pick a text on screen.

CmdTextEdit(object, int): Opens the single-line text editor for an existing text object or prompts the user to pick a text on screen, enforcing a maximum total character length.

CmdTextEditEx(vdDocument): Opens an interactive single-line text edit command so the user can pick and modify an existing text (vdText) in the document.

CmdTextStyle(object, object, object, object): Creates or updates a text style in the document, or opens the text style manager dialog when no style name is provided.

CmdTextStyleDialogEx(vdDocument): Opens the text style manager dialog so the user can create, edit, and delete text styles in the current document.

CmdThickness(object, object, object): Applies a thickness value to a vdCurve or vdPolyhatch entity, then optionally replaces it with a covered vdPolyface whose fill color matches the original entity's pen color. When conversion is chosen, the source entity is deleted and the resulting polyface is added to the active layout.

CmdThicknessEx(vdDocument): Initiates a fully interactive thickness command that prompts the user to select a curve or vdPolyhatch entity, specify a thickness value via a live drag action, and optionally convert the thickened entity into a covered vdPolyface. When conversion is chosen, the source entity is deleted and replaced by the resulting polyface whose fill color matches the original pen color.

CmdTorus(object, object, object, object, object): Creates a torus (donut-shaped) vdPolyface entity defined by a center point, a main radius, a secondary tube radius, and two resolution values. The resulting mesh is added to the active layout's entity collection.

CmdTrim(object, object): Trims objects at a cutting edge defined by other objects

CmdTrim(object, object, bool): Trims objects at a cutting edge defined by other objects

CmdVolume(object, out gPoint): Calculates the volume and center of mass (centroid) of a closed vdPolyface entity. Supports both programmatic input and interactive user selection of the polyface.

CmdVolumeEx(vdDocument): Initiates a fully interactive command to calculate the volume and center of mass of a closed polyface. Prompts the user to select a vdPolyface entity and displays the computed results.

CmdWriteBlock(object, object, object): Saves selected drawing objects or an entire block to a new file using the document's default file format version.

CmdWriteBlock(object, object, object, object): Saves selected drawing objects or an entire block to a new file, with control over the origin point and file format version.

CmdXClip(object, object): Clips a vdInsert entity (block reference or XRef) using a vdCurve as the clip boundary. Only the portion of the insert that falls inside the curve is displayed after clipping.

CmdXLine(object): Creates a construction line (infinite line) using a parameter list containing all necessary definition data.

CmdXLine(object, object): Creates a construction line (infinite line) programmatically with the specified base point and direction.

CmdXref(string, string, object, object, object, short): Manages external references (Xrefs) for the current document by attaching, reloading, detaching, binding, or unloading a referenced drawing file.

CmdXrefEx(vdDocument): Opens the external reference (Xref) manager dialog, allowing the user to attach, reload, detach, bind, or unload external reference files associated with the current document.

ConeEx(vdDocument): Initiates an interactive command that prompts the user to specify the dimensions of a 3D cone (or truncated cone) and adds the resulting vdPolyface mesh "cone" to the active layout. This method calls CmdCone(object, object, object, object, object) with user-interactive parameters.

CopyEx(vdDocument): Launches an interactive copy command on the specified document.

DimAligned(vdDocument): Opens an interactive command that lets the user create an aligned dimension to measure the actual distance between two points along a slanted line.

DimAngular(vdDocument): Opens an interactive command that lets the user create an angular dimension to measure the angle between two lines or between two points from a center point.

DimDiameter(vdDocument): Opens an interactive command that lets the user create a diameter dimension to measure and display the diameter of a circle or arc.

DimRadial(vdDocument): Opens an interactive command that lets the user create a radial dimension to measure and display the radius of a circle or arc.

DimRotatedAuto(vdDocument): Opens an interactive command that lets the user create an automatic rotated dimension that intelligently chooses between horizontal and vertical based on the measured points.

DimRotatedHor(vdDocument): Opens an interactive command that lets the user create a horizontal dimension (a dimension line that is perfectly horizontal) to measure horizontal distances.

DimRotatedVer(vdDocument): Opens an interactive command that lets the user create a vertical rotated dimension to measure and display vertical distances on the drawing.

DivideEx(vdDocument): Creates a new vdPolyline object with line segments from a vdCurve object after it is divided

DivideToCurvesEx(vdDocument): Creates and adds to the document a series of vdCurves that are produced by calling the Break method of the object.

DivideToPointsEx(vdDocument): Entry point for the interactive Divide to Points command, which prompts the user to select an entity and specify a number of segments, then places vdPoint markers at equal lenght or arc-length intervals along the entity without modifying it.

DoDragDrop(object, DragDropEffects, object, int, int, int): Initiates a drag-and-drop operation for the specified selection set within the document.

EditAttrib(object): Opens a modal dialog for editing the attribute values of a specified insert entity (such as a vdInsert block reference). If "USER" is passed, the user is prompted to select an insert entity on screen.

EditAttribEx(vdDocument): Initiates an interactive command that prompts the user to select an insert entity (vdInsert, such as a block reference) and opens a dialog for editing its attribute values. This is a method that calls EditAttrib(object) with user-interactive parameters.

EllipseEx(vdDocument): Launches the interactive Ellipse command so the user can draw a vdEllipse object.

EraseEx(vdDocument): Launches an interactive erase command that lets the user pick objects on screen and then deletes them from the drawing.

ExTrim(object, object): Trims multiple objects at a cutting edge defined by a figure, removing geometry on the specified side.

ExTrimEx(vdDocument): Launches an interactive command that trims multiple objects at a cutting edge defined by a user-selected figure, allowing selective removal based on side selection.

ExplodeEx(vdDocument): Opens an interactive command that lets the user pick objects and break them down (explode) into their individual sub-entities.

ExtendEx(vdDocument): Launches the interactive Extend command for the specified document.

Face3dEx(vdDocument): Starts the interactive command that lets the user draw a 3D face (vd3DFace).

FilletEx(vdDocument): Initiates an interactive fillet command that prompts the user to select two curve entities (lines, arcs, or polylines) and connects them using a zero-radius fillet (sharp corner). This is a method that calls CmdFillet(object, object) with user-interactive parameters.

FilletRadiusEx(vdDocument): Initiates an interactive fillet-with-radius command that prompts the user to specify a fillet radius and then select two curve entities (lines, arcs, or polylines), connecting them with a tangent arc of the specified radius. This is a convenience wrapper that calls CmdFilletRadius(object, object, object) with user-interactive parameters.

FindInBoundCurveEx(vdDocument): Launches an interactive command that calculates and returns the inner boundary of selected entities relative to a user-specified interior point.

FindOutBoundCurveEx(vdDocument): Launches an interactive command that calculates and returns the outer boundary (convex hull) of user-selected entities.

Find_InBoundCurve(object, object): Calculates and returns the inner boundary vertices of selected entities relative to a specified interior point.

Find_OutBoundCurve(object): Calculates and returns the outer boundary (convex hull) vertices of a given selection of entities.

GetDistanceEx(vdDocument): Initiates an interactive command that prompts the user to select two points in the drawing viewport and displays a message box showing the measured distance between them, formatted according to the document's current length unit settings.

ImageEx(vdDocument): Prompts the user to select an image file (.BMP, .JPG, .PNG, .TIF etc) via an open-file dialog and then insert the resulting vdImage entity into the active layout of the document.

InitUserGetString(VdConstCodePage, string, string): Provides support for localized keywords like Yes/No, when prompting the user to type a string.

InsertEx(vdDocument): Launches a dialog that lets the user browse and insert a block or external file into the document at a location, scale, and rotation chosen by the user.

LayerControl(): Opens the layer manager dialog so the user can inspect and edit all layers defined in the current document.

LeaderEx(vdDocument): Launches an interactive leader line drawing command on the specified document.

LineEx(vdDocument): Launches an interactive line drawing command on the specified document.

LookAt(object, object): Positions the 3D view by pointing the camera from one location toward a target point (twist angle defaults to zero).

LookAt(object, object, object): Repositions the view so the camera sits at cameraPosition and looks toward targetPosition, optionally applying a roll/twist around the view axis (in radians).

MTextEx(vdDocument): Starts an interactive multi-line text (MText) command so the user can type and place formatted text on the drawing.

MakeBlockEx(vdDocument): Initiates an interactive command that prompts the user for a block name, an insertion origin point, and the entities to group inside the vdBlock, then creates a named vdBlock definition in the active document's Blocks collection. This method calls CmdMakeBlock(object, object, object) with all user-interactive parameters.

Mesh3dEx(vdDocument): Starts the 3D mesh drawing command so the user can create a 3D mesh by picking points and entering sizes.

MirrorEx(vdDocument): Lets the user mirror the current selection across any axis.

MoveEx(vdDocument): Launches an interactive move command that lets the user pick objects on screen, choose a base point, and then place them at a new location.

NamedUCS(): Prompts the user with the UCS command menu so they can switch to World, View, Previous, or a named UCS.

NamedUCSEx(vdDocument): Opens the Named UCS dialog so the user can restore, save, or delete a named User coordinate system.

NewEx(vdDocument): Resets the document to a blank drawing state, clearing all entities, layouts, blocks, and styles, then refreshes the active viewport.

ObjectToMeshEx(vdDocument): Starts the command to convert selected objects into mesh shapes (vdPolyface objects).

OffsetEx(vdDocument): Entry point for invoking the interactive Offset command for the specified document.

OpenEx(vdDocument): Opens the file picker dialog and loads the selected drawing file into the document, replacing its current content.

Pan(): Allows the user to interactively pan (drag) the view around the drawing to see different areas without changing the zoom level.

PanEx(vdDocument): Opens an interactive pan command so the user can drag the view around to see different parts of the document.

PlineToMeshEx(vdDocument): Starts the interactive command that converts a polyline (vdPolyline) into a 3D mesh (vdPolyface).

PointEx(vdDocument): Opens an interactive command that lets the user click on the drawing to place a vdPoint entity in the specified document.

PolylineEx(vdDocument): Entry point for the interactive Polyline command, which prompts the user to pick vertices on screen and creates a vdPolyline entity in the active layout.

PrintEx(vdDocument): Opens the print manager dialog with default “print extends” and “scale to fit” flags so the user can preview and print the current layout of the specified document.

Prompt(string): Adds a prompt string to the prompt stack of the Document, displaying it in the vdCommandLine control if it is available.

Purge(vdDocument): Call the Purge() of the passed object

RayEx(vdDocument): Launches an interactive ray (semi-infinite line vdInfinityLine) drawing command on the specified document.

RectEx(vdDocument): Starts the interactive Rectangle command.

Redo(): Re-applies the last action that was reversed by an Undo call.

RedoEx(vdDocument): Re-applies the last action that was undone on the document from an Undo method.

RedrawEx(vdDocument): Refreshes the viewport display of the specified document without recalculating geometry.

RegenAll(): Regenerates all geometry in the associated document without requiring a static document parameter.

RegenEx(vdDocument): Regenerates the document geometry on the specified document, recalculating all computed entities and updating the display.

Rotate3dEx(vdDocument): Starts the 3D rotation command so the user can orbit selected objects interactively.

RotateEx(vdDocument): Launches an interactive rotate command on the specified document.

STLout(object, object): Exports selected drawing entities to a Stereo Lithography (STL) binary format file. Supports programmatic or interactive selection of entities and file path specification.

STLoutEx(vdDocument): Initiates a fully interactive STL export command that prompts the user to select entities and choose an output file path. The selected entities are exported to a binary STL (Stereo Lithography) file via STLout(object, object).

SaveAsEx(vdDocument): Opens the "Save As" dialog, prompting the user to choose a file path and format, then saves the document's drawing to the selected location.

SaveCurrentView(object): Saves the active camera/zoom setup as a named view inside the document.

SaveCurrentViewEx(vdDocument): Prompts the user for a name and stores the active viewport configuration as a named view.

SaveEx(vdDocument): Saves the document's drawing to the current file. If no filename has been assigned to the document, the Save As dialog is displayed so the user can choose a file path.

ScaleEx(vdDocument): Launches an interactive scale command that lets the user pick objects on screen, choose a base point, and then resize them by a scale factor.

SearchTextEx(vdDocument): Opens the Search and Replace text dialog for the specified vdDocument, allowing the user to find and optionally replace text strings within all text entities in the document. This is the static convenience entry point for the search and replace command.

SelectEx(vdDocument): Launches an interactive selection tool that lets the user pick objects on screen using standard click-to-select and other selection modes.

SelectEx(vdDocument, string): Launches a selection command with a specific selection mode, and displays a message showing how many items were selected.

SketchEx(vdDocument): Initiates an interactive freehand sketch command that prompts the user to specify a record increment distance, then captures mouse movement to produce one or more vdPolyline entities drawn in red. Each completed stroke is added to the active layout's entity collection as a separate vdPolyline and grouped under a single undo entry.

SliceEx(vdDocument): Initiates a fully interactive slice command that prompts the user to select a vdPolyface (or vdGroundSurface) entity, pick an origin point, specify the visible side of the cutting plane, and choose whether to cover the exposed faces — then applies the slice to the selected object in place.

SphereEx(vdDocument): Initiates an interactive command that prompts the user to specify the center, radius, and mesh resolution of a 3D sphere, then adds the resulting vdPolyface to the active layout. This method calls CmdSphere(object, object, object, object) with all user-interactive parameters.

SplineControlPointsEx(vdDocument): Launches the interactive Spline Control-Points command for the supplied document.

SplineEx(vdDocument): Launches the interactive Spline command for the specified document.

SplineFittingEx(vdDocument): Launches the interactive Spline Fitting command for the specified document.

SplineQuadraticEx(vdDocument): Launches the interactive Quadratic Spline fitting workflow for the provided document.

StretchEx(vdDocument): Initiates an interactive stretch command that prompts the user to select entities and a crossing boundary, then moves the grip points of those entities that lie inside the boundary from a base point to a target point. This is a method that calls CmdStretch(object, object, object, object) with user-interactive parameters.

TextEx(vdDocument): Launches an interactive command that lets the user create text in the drawing by typing content and picking location, height, and rotation on screen.

TorusEx(vdDocument): Initiates a fully interactive torus creation command that prompts the user to pick a center point, specify the main radius, set the main circle resolution, set the torus resolution, and specify the secondary (tube) radius — then creates and adds the resulting vdPolyface torus to the active layout.

TrimEx(vdDocument): Launches the interactive Trim command for the specified document.

UCS(object, object, object): Sets the User Coordinate System (UCS) to a world/view/previous preset, a saved named UCS, or to a custom orientation defined by three points.

UCSEx(vdDocument): Starts an interactive command that lets the user define a new User Coordinate System (UCS) by picking three points on the screen: an origin, a point on the positive X axis, and a point on the positive Y axis.

UCSV(vdDocument): Resets the User Coordinate System so it matches the current view direction.

UCSW(vdDocument): Resets the User Coordinate System back to the World Coordinate System (WCS), so the X, Y and Z axes return to their default global directions.

UCSWorld(): Restores the document’s coordinate system to the world axes so X, Y, Z align with the global (World X/Y/Z) directions again.

Undo(string): Undoes the last action in the document or manages undo groups that let you bundle several operations into one undoable step.

UndoEx(vdDocument): Undoes the last action performed on the document.

View3D(object): Sets the 3D viewpoint or changes the render mode of the active document, depending on the string argument you pass in. This is the central method that all the View3D_* helper methods call internally.

View3D_Hide(vdDocument): Switches the active layout's render mode to Hide, which displays 3D objects with hidden lines removed so that back-facing edges are not visible.

View3D_Render(vdDocument): Switches the active layout's render mode to Render, which displays entities with full material rendering including lighting, textures, and shadows.

View3D_RenderOn(vdDocument): Switches the active layout's render mode to RenderOn, which displays entities with full material rendering (lighting, textures, shadows) AND overlays the wireframe edges on top of the rendered surfaces.

View3D_Shade(vdDocument): Switches the active layout's render mode to Shade, which displays 3D objects with flat or Gouraud shading but without drawing wireframe edges on top.

View3D_ShadeOn(vdDocument): Switches the active layout's render mode to ShadeOn, which displays 3D objects with flat or Gouraud shading AND draws wireframe edges on top of the shaded surfaces.

View3D_VBack(vdDocument): Changes the view so you are looking toward the model from the back side.

View3D_VBottom(vdDocument): Sets the 3D view to look at the model from directly below, as if you are looking up at the bottom of the drawing from underneath.

View3D_VCrot(vdDocument): Starts an interactive continuous 3D orbit command that lets the user drag the mouse to spin the view and, after releasing the mouse button, keeps the view spinning in the last direction the user specified.

View3D_VFront(vdDocument): Changes the viewpoint to look straight at the front face of the model.

View3D_VINE(vdDocument): Switches the camera to the northeast isometric view so you see the model from above looking toward the corner where the X, Y and Z axes meet.

View3D_VINW(vdDocument): Changes the view to the northwest isometric preset so you see the model from above toward the corner defined by the negative X, positive Y, and Z axes.

View3D_VISE(vdDocument): Switches the view to the southeast isometric preset so you see the model from above toward the corner where the positive X, negative Y, and Z axes meet.

View3D_VISW(vdDocument): Changes the camera to the southwest isometric view, showing the model from above toward the corner defined by the negative X, negative Y, and positive Z axes.

View3D_VLeft(vdDocument): Moves the camera to look directly at the model from the left side.

View3D_VRight(vdDocument): Moves the camera so you are looking directly at the right side of the model.

View3D_VTop(vdDocument): Changes the viewpoint so you are looking straight down at the model from above.

View3D_VWorld(vdDocument): Resets the 3D view to the standard World (plan) view, looking straight down at the XY plane from above, as if the drawing is flat on a table.

View3D_Vrot(vdDocument): Starts an interactive 3D orbit command that lets the user drag the mouse to freely rotate the view around in any direction.

View3D_Wire(vdDocument): Switches the active layout's render mode to Wire, which displays 3D objects as a wireframe with depth sorting so closer edges appear in front of farther ones.

View3D_Wire2d(vdDocument): Switches the active layout's render mode to Wire2d, which displays all entities as a flat 2D-style wireframe without any depth sorting or perspective.

WriteBlockEx(vdDocument): Launches an interactive command that lets the user select drawing objects and save them to a new file with a user-chosen origin point.

XClipEx(vdDocument): Initiates a fully interactive clip boundary command that prompts the user to select a vdInsert entity (block reference or XRef) and then either pick an existing vdCurve or draw a new vdPolyline to use as the clip boundary. The chosen curve is assigned to the insert's ClipBoundary property, and the insert is updated and invalidated to reflect the new clipping region.

XLineEx(vdDocument): Launches an interactive infinite line (construction line) drawing command on the specified document.

Zoom(object, object, object): Performs a zoom operation on the active layout with customizable type and optional corner parameters.

ZoomA_Ex(vdDocument): Performs a "zoom all" operation on the specified document, fitting the view to include all drawing content and layouts taking drawing's Limits into consideration.

ZoomE_Ex(vdDocument): Performs a zoom extents on the active layout of the provided document, fitting all entities into the view.

ZoomEx(vdDocument): Presents an interactive zoom menu allowing the user to select from various zoom modes.

ZoomIn_Ex(vdDocument): Performs a zoom in operation on the specified document, magnifying the view by 20%.

ZoomOut_Ex(vdDocument): Performs a zoom out operation on the specified document, reducing the view by 20%.

ZoomP_Ex(vdDocument): Restores the previous zoom view state on the specified document.

ZoomS_Ex(vdDocument): Performs a scaled zoom on the specified document, prompting the user to enter a zoom scale factor.

ZoomToObject_Ex(vdDocument): Zooms to fit a specific object or entity selected by the user.

ZoomToSelection_Ex(vdDocument): Zooms to fit all currently selected entities into the viewport.

ZoomW_Ex(vdDocument): Performs a zoom window operation on the specified document, allowing the user to define a rectangular area to zoom into.

bHatch(): Opens the hatch dialog, allowing the user to define and apply a hatch pattern to a closed boundary entity in the active layout of the document.

bhatchEx(vdDocument): Opens the hatch dialog, allowing the user to define and apply a hatch pattern to a closed boundary in the active layout of the document.

cmdAttachAllPDFPages(object, object, object, object, object, object): Command so the user selects a pdf file and then is prompted to attach all the pages to the Document. There are options for aligment(horizontal or vertical) , view(full or partial) , pages to export and distance between pages.

cmdAttachAllPDFPagesEx(vdDocument): Initiates a fully interactive command to import all or selected pages from a PDF file into the document as organized blocks with configurable layout, spacing, and view options.

cmdConvertToHatchedPolyface(object): Converts a polyface entity into a hatched polyface (vdPolyfaceHatched) with the document's active hatch properties.

cmdConvertToHatchedPolyfaceEx(vdDocument): Launches an interactive command that converts a selected polyface into a hatched polyface (vdPolyfaceHatched) with user interaction.

cmdDistance(): Interactively prompts the user to select two points in the drawing viewport and displays a message box showing the measured distance between them, formatted according to the document's current length unit settings.

cmdDistance(bool, out double): Interactively prompts the user to select two points in the drawing viewport and returns the measured distance between them. Optionally displays a message box with the result formatted according to the document's current length unit settings.

cmdExportLayoutToModelEx(vdDocument): Initiates a fully interactive command to export the active paper space layout as a new document file with all layout entities converted to model space, allowing user-controlled file path and version specification. Works only in Paper Space Layouts.

cmdGenerate3dPathSectionEx(vdDocument): Launches an interactive command that creates a 3D polyface by sweeping a 2D section profile along a 3D path curve.

cmdTangentLineFromCircle(object): Creates a tangent line from an external point to a circle, with automatic selection of the nearest tangent point based on user input.

cmdTangentLineFromCircleEx(vdDocument): Performs the cmdTangentLineFromCircle export with null parameters.

getUserPolyline(): Interactively prompts the user to pick vertices on screen and constructs a vdPolyline entity in World Coordinate System (WCS) without adding it to the active layout's entity collection.

Table of Contents

Class vdCommandAction

Remarks

Properties

Methods