Share

SketchBlock Object


Description

The SketchBlock object represents a sketch block instance within a sketch.

Methods

Name Description
Delete Method that deletes the sketch block.
Edit Method that activates the sketch block for editing by the user.
ExitEdit Method that causes the sketch block to return from the edit mode and into the environment specified by the input argument. If the sketch block is not currently active (i.e. this is not the same block as returned by Application.ActiveEditObject property), then this method does nothing.
Explode Method that explodes the contents of the block and deletes the block instance. Note that the contents of the block are retained.
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.
GetObject Method that returns the corresponding object in the sketch block for the given object from it's definition.
GetReferenceKey Method that generates and returns the reference key for this entity.
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.

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.
ChildBlocks Property that returns an enumerator of SketchBlocks objects found directly under this sketch block.
Color Gets and sets the color for the sketch block. Setting the property to Nothing restores the sketch block to the default color.
ConstraintStatus Property that returns the constraint status of the sketch block. Possible return values are kFullyConstrainedConstraintStatus, kOverConstrainedConstraintStatus, kUnderConstrainedConstraintStatus and kUnknownConstraintStatus.
ContainingSketchBlock Property that returns the sketch block that in turn contains this sketch block. This is the same SketchBlock returned as the last item in the SketchBlockPath property. This property \returns Nothing if this sketch block does not belong to another sketch block and lives directly under a sketch.
Definition Property that returns the referenced sketch block definition.
Exported Read-write property that gets and sets whether the object is exported. Objects must be marked for export in order for them to be derived.
Flexible Gets and sets whether this sketch block is flexible.
HasReferenceComponent Property that specifies if the object was created as the result of a derived part.
LineType Gets and sets the line type override for the sketch block.
LineWeight Gets and sets the line weight override for the sketch block.
Name Gets and sets name of the sketch block.
Parent Property that returns the parent sketch of the object.
Position Gets and sets the position of the sketch block.
ReferenceComponent Property that returns the ReferenceComponent that resulted in the creation of this feature.
ReferencedEntity Property that returns the referenced sketch block, if there is one. Else, the property returns Nothing.
SketchBlockPath Property that returns the path of sketch blocks at the leaf of which this sketch block is found. The enumerator returns a count of 0 if the block lives directly under a sketch. The path does not include this sketch block itself.
Transformation Gets and sets the transformation matrix for the sketch block.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets and sets whether this sketch block is visible.

Accessed From

SketchArc.ContainingSketchBlock, SketchArcProxy.ContainingSketchBlock, SketchBlock.ContainingSketchBlock, SketchBlock.ReferencedEntity, SketchBlockProxy.ContainingSketchBlock, SketchBlockProxy.NativeObject, SketchBlockProxy.ReferencedEntity, SketchBlocks.Add, SketchBlocks.AddByDefinition, SketchBlocks.Item, SketchBlocksEnumerator.Item, SketchCircle.ContainingSketchBlock, SketchCircleProxy.ContainingSketchBlock, SketchControlPointSpline.ContainingSketchBlock, SketchControlPointSplineProxy.ContainingSketchBlock, SketchEllipse.ContainingSketchBlock, SketchEllipseProxy.ContainingSketchBlock, SketchEllipticalArc.ContainingSketchBlock, SketchEllipticalArcProxy.ContainingSketchBlock, SketchEntity.ContainingSketchBlock, SketchEquationCurve.ContainingSketchBlock, SketchEquationCurveProxy.ContainingSketchBlock, SketchFixedSpline.ContainingSketchBlock, SketchFixedSplineProxy.ContainingSketchBlock, SketchImage.ContainingSketchBlock, SketchImageProxy.ContainingSketchBlock, SketchLine.ContainingSketchBlock, SketchLineProxy.ContainingSketchBlock, SketchOffsetSpline.ContainingSketchBlock, SketchOffsetSplineProxy.ContainingSketchBlock, SketchPoint.ContainingSketchBlock, SketchPointProxy.ContainingSketchBlock, SketchSpline.ContainingSketchBlock, SketchSplineHandle.ContainingSketchBlock, SketchSplineHandleProxy.ContainingSketchBlock, SketchSplineProxy.ContainingSketchBlock, TextBox.ContainingSketchBlock, TextBoxProxy.ContainingSketchBlock

Derived Classes

SketchBlockProxy

Version

Introduced in version 2010

Was this information helpful?