DrawingSketch Object
Derived from: Sketch ObjectDescription
The DrawingSketch object represents a sketch within a drawing.Methods
| Name | Description |
| AddArcSlotByCenterPointArc | Method that creates an arc slot. The sketch entities represent the sketch slot are returned. |
| AddArcSlotByThreePointArc | Method that creates an arc slot. The sketch entities represent the sketch slot are returned. |
| AddByProjectingEntity | Method that creates a new sketch entity by projecting other entities onto the sketch plane. This method performs the same function as the Project Geometry or Project DWG Geometry command according to the Entity you specified. |
| AddStraightSlotByCenterToCenter | Method that creates a straight slot. The sketch entities represent the sketch slot are returned. |
| AddStraightSlotByOverall | Method that creates a straight slot. The sketch entities represent the sketch slot are returned. |
| AddStraightSlotBySlotCenter | Method that creates a straight slot. The sketch entities represent the sketch slot are returned. |
| CopyContentsTo | Method that copies all the contents of the sketch to the \input target sketch. |
| CopyEntitiesTo | Method that copies sketch entities of the sketch to the input target sketch. |
| Delete | Method that deletes the sketch. This method is only valid for sketches that are not used by a feature. |
| Edit | Method that causes the Sketch environment to be invoked with this sketch available for interactive edit. |
| ExitEdit | Causes the Sketch environment to be closed and the user interface to return to the previous environment. This is equivalent to the Return command. This method is only valid in the case where this sketch is open for edit within the user interface. |
| GetAutomatedCenterlineSettings | Method that returns the settings that define how automatic center lines and center marks are to be calculated for this sketch. |
| GetCustomLineType | Method that returns information regarding the custom line type in use. The method returns a failure if the return value of the LineType property is not kCustomLineType. |
| GetReferenceKey | Method that generates and returns the reference key for this entity. |
| MoveSketchObjects | Method that moves a collection of sketch objects by a specified vector. If the Copy argument is set to True, the newly created objects are returned. |
| OffsetSketchEntitiesUsingDistance | Method that offsets a sketch entity or a group of connected sketch entities. In both cases, the base sketch entity is first offset by the specified distance and along the specified direction. The base sketch entity is determined as follows: * If only one sketch entity needs to be offset, it will be treated as the base sketch entity. * If a group of end-to-end connected entities need to be offset, the first entity in the group will be treated as the base sketch entity. If this method successfully offsets the specified input sketch entities, the newly created sketch entities are returned. |
| OffsetSketchEntitiesUsingPoint | Method that offsets a sketch entity or a group of end-to-end connected sketch entities. In both cases, the offset is first applied to the base sketch entity such that the offset of the base sketch entity passes through the specified offset point on the sketch. The shortest distance of this offset point from the original base sketch entity determines the offset distance. |
| RotateSketchObjects | Method that rotates a collection of sketch objects by a specified angle. If the Copy argument is set to True, the newly created objects are returned. |
| SetAutomatedCenterlineSettings | Method that sets the automatic centerline and center mark settings for this sketch and creates the centerlines and center marks defined by the settings. The centerlines and center marks that were created are returned. |
| SetCustomLineType | Method that sets a custom line type to the curve from the specified .lin file. The method automatically changes the value of LineType property to kCustomLineType. |
| SheetToSketchSpace | Method that takes a coordinate in sheet space returns a Point2d object containing the resulting coordinate point in sketch space. |
| SketchToSheetSpace | Method that takes a coordinate in sketch space, and returns a Point2d object containing the coordinates of the point in sheet space. |
| Solve | Method that causes the sketch to solve. |
Properties
| Name | Description |
| Application | Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned. |
| AttributeSets | Property that returns the AttributeSets collection object associated with this object. |
| CircularPatterns | Gets the SketchCircularPatterns collection object. |
| Color | Gets and Sets the color for the sketch. |
| ConstraintStatus | Property that returns an enum indicating the constraint status of the sketch entity, signifying whether it is fully constrained, over constrained, or under constrained. |
| DataIO | Gets the object through which this sketch's data content can be persisted. |
| DeferUpdates | Gets and Sets whether to defer the solving of the sketch or not. |
| DimensionConstraints | Gets the collection of all dimension constraints on the sketch. |
| DisabledActionTypes | Gets and sets the action types valid for this sketch. |
| GeometricConstraints | Property that returns the collection of all geometric constraints on the sketch. |
| LineType | Gets and Sets the line type override for the sketch. |
| LineWeight | Gets and Sets the line weight override for the sketch. |
| Name | Gets and sets name of the sketch. |
| Parent | Property that gets the parent object from whom this object can logically be reached. |
| Profiles | Gets the profiles collection associated with this drawing sketch. |
| RectangularPatterns | Gets the SketchRectangularPatterns collection object. |
| SketchArcs | Property that returns the SketchArcs collection object. |
| SketchCircles | Property that returns the SketchArcs collection object. |
| SketchControlPointSplines | Read-only property that returns the SketchControlPointSplines collection object. This collection provides access to the existing control point splines in the sketch and provides functionality to create new control point splines. |
| SketchEllipses | Property that returns the SketchEllipses collection object. |
| SketchEllipticalArcs | Property that returns the SketchEllipticalArcs collection object. |
| SketchEntities | Property that returns the collection of all entities on the sketch, regardless of their type. |
| SketchEquationCurves | Read-only property that returns the SketchEquationCurves collection object. This collection provides access to the existing equation curves in the sketch and provides functionality to create new equation curves. |
| SketchFillRegions | |
| SketchFixedSplines | Property that gets the collection object. |
| SketchHatchRegions | Read-only property that returns the SketchHatchRegions collection object. |
| SketchImages | Property that returns a collection of all images on the sketch. |
| SketchLines | Property that returns the SketchLines collection object. This collection provides access to the existing lines in the sketch and provides functionality to create new lines. |
| SketchOffsetSplines | Property that returns the collection object. This collection provides access to the existing offset splines in the sketch. |
| SketchPoints | Property that returns the SketchPoints collection object. |
| SketchSplines | Property that returns the SketchSplines collection object. |
| TextBoxes | Gets the TextBoxes collection associated with this Sketch. |
| Type | Returns an ObjectTypeEnum indicating this object's type. |
| Visible | Gets and sets the visibility of the sketch. |
Accessed From
BorderDefinition.Edit, BorderDefinition.Sketch, CropOperation.CropBoundarySketch, DrawingSketches.Add, DrawingSketches.Item, RevisionCloud.Sketch, SectionDrawingView.SectionLineSketch, SketchedSymbolDefinition.Edit, SketchedSymbolDefinition.Sketch, SketchHatchRegion.Parent, TitleBlockDefinition.Edit, TitleBlockDefinition.SketchSamples
| Name | Description |
| Drawing Sketches - editing line type and color | This sample demonstrates the modification of sketch entity line type and color in drawings. |
| Sketch fill region | This sample demonstrates the sketch fill functionality in drawing sketches. |
| Create SketchedSymbol Definition | This sample illustrates creating a new sketched symbol definition object and inserting it into the active sheet. |
| Title Block Definition Create and Insert | This sample illustrates creating a new title block definition object and inserting it into the active sheet. This sample consists of two subs. The first demonstrates the creation of a title block definition and the second inserts it into the active sheet. |