SketchedSymbol Object


Description

The SketchedSymbol object represents the instance of a SketchedSymbolDefinition on a sheet. See the article in the overviews section.

Methods

Name Description
Delete Method that deletes the sketched symbol (e.g. the title block) from the sheet.
GetCustomLineType Method that sets a custom line type to the entity from the specified .lin file. The method automatically changes the value of the LineType property to kCustomLineType.
GetReferenceKey Method that generates and returns the reference key for this entity.
GetResultText Method that returns the text that is currently displayed for a specific text box. This is useful for text boxes that use input form other sources to define their content, i.e. properties and prompted text. The string displayed within this text box is 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.
SetPromptResultText Method that sets the text that was supplied for a specified sketched symbol that contains prompted text. The string displayed within this symbol is changed.

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.
Callout Property that gets whether this sketched symbol is a callout symbol.
Color Gets and sets the color for the symbol.
Definition Property returning the sketched symbol definition object referenced by the sketched symbol.
Layer Gets and sets the layer associated with the sketched symbol.
Leader Property that returns the Leader object.
LeaderClipping Gets and sets whether the symbol's leader should be clipped where it overlaps the symbol.
LeaderStyle Property that gets and sets the associated leader style.
LeaderVisible Gets and sets whether the leader of the SketchedSymbol is visible.
LineType Gets and sets the line type override for the symbol.
LineWeight Gets and sets the line weight override for the symbol.
Name Gets and sets the name of the sketched symbol instance.
Parent Property that gets the parent object from whom this object can logically be reached.
Position Gets and sets the origin position of the symbol on the sheet.
Rotation Gets and sets the rotation angle of the symbol in radians.
Scale Gets and sets the scale of the symbol.
Static Gets and sets whether to show the scale and rotation grip points on the SketchedSymbol.
SymbolClipping Gets and sets whether to trim annotations applied to the SketchedSymbol.
Transformation Property that provides the transform that is applied to display the associated sketched symbol definition in the correct location on the sheet. The matrix defines the sheet to sketched symbol transform.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

SketchedSymbols.Add, SketchedSymbols.AddWithLeader, SketchedSymbols.Item

Samples

Name Description
Create SketchedSymbol Definition This sample illustrates creating a new sketched symbol definition object and inserting it into the active sheet.
Create sketched symbol and leader This sample illustrates creating sketched symbol with a leader.

Version

Introduced in version 5.3