LeaderStyle Object

Derived from: Style Object

Description

The LeaderStyle object represents a leader style in a drawing. The properties and methods listed below are in addition to those supported by the Style object.

Methods

Name	Description
ConvertToLocal	Method that creates a local cached copy of a global style and returns the local style.
Copy	Method that creates a new local Style object. The newly created style is returned.
Delete	Method that deletes the Style/Layer/UnfoldMethod.
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.
SaveToGlobal	Method that saves this style to the global repository. If a style with the same name is found in the repository, that style is updated.
SetCustomLineType	Method that sets a custom line type to the style from the specified .lin file. The method automatically changes the value of LineType property to kCustomLineType.
UpdateFromGlobal	Method that updates this style from the global repository.

Properties

Name	Description
AllAroundSymbolDiameter	Property that gets and sets the size of the all-around symbol for Feature Control Frames, Surface symbols, and Weld symbols (circular only). This value is used only if the ScaleToTextHeight property is set to False.
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.
ArrowheadHeight	Property that gets and sets the height of the arrowhead relative to the associated line.
ArrowheadSize	Property that gets and sets the size of the arrowhead (i.e. the terminator). The value is that of width of the arrow if the terminator is an arrowhead or for diameter if the terminator is a circle.
ArrowheadType	Property that gets and sets the arrowhead style to use.
Color	Property that gets and sets the color for the style. Setting the property to Nothing restores the style to the color defined by the layer.
Comments	Gets and sets comments associated with the style.
ExtensionLineOffset	Property that gets and sets the space from the end of the edge to which the leader attaches to the beginning of the leader extension line.
ExtensionLineOvershoot	Property that gets and sets the length of the leader extension line past the end of the terminator.
InternalName	Property that returns the internal name of the style. The name is the internal English name of the standard style. This name will remain constant and is not affected by locale. This name is never displayed to the user. Note that this name is not guaranteed to be unique.
InUse	Property that indicates if this style is in use.
LineType	Property that gets and sets the line type override. Setting the property to kDefaultLineType restores the default line type. If the property returns kCustomLineType, the GetCustomLineType method can be used to get further details about the line type.
LineWeight	Property that gets and sets the thickness of this primitive/object. If LineDefinitionSpace is set to kScreenSpace, this value is defined in pixels. If LineDefinitionSpace is set to kModelSpace, this value is defined in model units (centimeters).
Name	Gets/Sets the name of the Style.
Parent	Property returning the parent of this object.
ScaleToTextHeight	Property that gets and sets whether to define the all-around symbol size by the height of text from the symbol's text style. This specifies the size of the all-around symbol for Feature Control Frames, Surface symbols, and Weld symbols (circular only).
StyleLocation	Property that returns the location of this style, i.e. local to the document, cached locally in the document, exists in the library. Styles that exist in the library cannot be edited.
StyleType	Gets the type of the style.
Type	Returns an ObjectTypeEnum indicating this object's type.
UpToDate	Property that gets the up-to-date status of the style against the global repository.

Accessed From

BalloonStyle.AlternateLeaderStyle, BalloonStyle.LeaderStyle, DimensionStyle.LeaderStyle, EdgeSymbolStyle.LeaderStyle, FeatureControlFrameStyle.LeaderStyle, LeaderStylesEnumerator.Item, ObjectDefaultsStyle.OriginIndicatorStyle, ObjectDefaultsStyle.SketchedSymbolLeaderStyle, OriginIndicator.LeaderStyle, RevisionTableStyle.RevisionTagLeaderStyle, SketchedSymbol.LeaderStyle, SurfaceTextureStyle.LeaderStyle, TransitionSymbolStyle.LeaderStyleForEdgeSelected, TransitionSymbolStyle.LeaderStyleForFaceSelected, WeldSymbolStyle.LeaderStyle

Version

Introduced in version 2009