BalloonStyle Object

Derived from: Style Object

Description

The BalloonStyle object represents a balloon 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.
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.
UpdateFromGlobal	Method that updates this style from the global repository.

Properties

Name	Description
AlternateLeaderStyle	Property that gets and sets the alternate leader style used for the balloon style. Alternate leader style is used when a balloon termination is dragged away from its associative edge.
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.
BalloonDiameter	Property that gets and sets the balloon diameter. This value is used only if the ScaleToTextHeight property is set to False. This property is not applicable if the balloon type is kNoneBalloonType or kLinearBalloonType.
BalloonType	Property that gets and sets the shape of the balloon. Valid types are kCircularWithOneEntryBalloonType, kCircularWithTwoEntriesBalloonType, kHexagonBalloonType, kLinearBalloonType and kNoneBalloonType.
Comments	Gets and sets comments associated with the style.
DefaultOffset	Property that gets and sets the default distance between balloons when they are aligned. Changing this value has no effect on previously created balloons.
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.
LeaderStyle	Property that gets and sets the leader style used for a balloon.
Name	Gets/Sets the name of the Style.
Parent	Property returning the parent of this object.
Properties	Property that gets and sets the properties to display in the balloon. The number of properties displayed depends on the balloon shape.
ScaleToTextHeight	Property that gets and sets whether to define the balloon size by text height. This property is not applicable if the balloon type is kNoneBalloonType or kLinearBalloonType.
StretchBalloonToText	Property that gets and sets whether to size the balloon horizontally to accommodate long text strings. If set to False, the balloon is restricted to the defined size. This property is not applicable if the balloon type is kNoneBalloonType or kLinearBalloonType.
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.
TextStyle	Property that gets and sets the text style used to format the text in a balloon.
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

Balloon.Style, BalloonStylesEnumerator.Item, ObjectDefaultsStyle.BalloonStyle

Version

Introduced in version 2009