Hide Table of Contents

Document Properties > Annotations > Balloons

 

Setting

Get/Set Methods

Return Value or <Value>

Comments

Base balloons standard

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingDimensionStandard, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingDimensionStandard, swUserPreferenceOption_e.swDetailingBalloon, swDetailingStandard_e.<Value>)

See swDetailingStandard_e for valid options

Specifies the base balloons standard to use

Leader style - Leader Style

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonLeaderLineStyle, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonLeaderLineStyle, swUserPreferenceOption_e.swDetailingBalloon, swLineStyles_e.<Value>)

See swLineStyles_e for valid options

 

Leader style - Leader Thickness

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonLeaderLineThickness, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonLeaderLineThickness, swUserPreferenceOption_e.swDetailingBalloon, swLineWeights_e.<Value>)

See swLineWeights_e for valid options

Specifies the default style of unattached dimension arrows

Leader style - Custom thickness

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonLeaderLineThicknessCustom, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonLeaderLineThicknessCustom, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies custom thickness for balloon leader lines; sets Custom Thickness to the specified thickness and Leader Thickness to Custom Size

Frame style - Frame Style

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonFrameLineStyle, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonFrameLineStyle, swUserPreferenceOption_e.swDetailingBalloon, swLineStyles_e .<Value>)

See swLineStyles_e for valid options

Specifies the length of the annotation bend leaders in a drawing document

Frame style -  Frame Thickness

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonFrameLineThickness, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonFrameLineThickness, swUserPreferenceOption_e.swDetailingBalloon, swLineWeights_e.<Value>)

See swLineWeights_e for valid options

 

Frame style - custom thickness

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonFrameLineThicknessCustom, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonFrameLineThicknessCustom, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies custom thickness for balloon frame lines; sets Custom Thickness to the specified thickness and Leader Thickness to Custom Size

Text - Font...

IModelDocExtension::GetUserPreferenceTextFormat(swUserPreferenceTextFormat_e.swDetailingBalloonTextFormat, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceTextFormat(swUserPreferenceTextFormat_e.swDetailingBalloonTextFormat, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

See ITextFormat for valid font options

To set font property values, implement ITextFormat, set the appropriate ITextFormat member values, and pass the ITextFormat object in the API set method

Text - Upper

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMUpperText, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMUpperText, swUserPreferenceOption_e.swDetailingBalloon, swBalloonTextContent_e.<Value>)

See swBalloonTextContent_e for valid options

Specifies the upper section of the text of BOM balloons

Text - Upper - Custom property

IModelDocExtension::GetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingBOMUpperCustomProperty, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingBOMUpperCustomProperty, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

String value

 

Text - Lower

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMLowerText, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMLowerText, swUserPreferenceOption_e.swDetailingBalloon, swBalloonTextContent_e.<Value>)

See swBalloonTextContent_e for valid options

Specifies the lower section of the text of BOM balloons

Text - Lower - Custom property

IModelDocExtension::GetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingBOMLowerCustomProperty, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingBOMLowerCustomProperty, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

String value

 

Leader display - Single/Stacked Balloons

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonLeaderStyle, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonLeaderStyle, swUserPreferenceOption_e.swDetailingBalloon, swLeaderStyle_e.<Value>)

See swLeaderStyle_e;  valid options:

  • swLeaderStyle_e.swSTRAIGHT
  • swLeaderStyle_e.swBENT
  • swLeaderStyle_e.swSPLINE

 


Leader display - Auto Balloons

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonAutoBalloons, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonAutoBalloons, swUserPreferenceOption_e.swDetailingBalloon, swLeaderStyle_e.<Value>)

 


See swLeaderStyle_e;  valid options:
  • swLeaderStyle_e.swSTRAIGHT
  • swLeaderStyle_e.swBENT
 

Leader display - Use document leader length

IModelDocExtension::GetUserPreferenceToggle(swUserPreferenceToggle_e.swDetailingBalloonUseBentLeaderLength, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceToggle(swUserPreferenceToggle_e.swDetailingBalloonUseBentLeaderLength, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Boolean value

Specifies whether to use bent leaders for annotations

Leader display - Leader length

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonBentLeaderLength, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonBentLeaderLength, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies length of the balloon bent leader

Quantity gap - Distance

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonQtyGapDistance, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonQtyGapDistance, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies the distance between the balloon edge and the quantity

Layer

IModelDocExtension::GetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingLayer, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingLayer, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

String value

Specifies the name of the layer to apply these settings to; this setting is available only on drawings

Single balloon - Style

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMBalloonStyle, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMBalloonStyle, swUserPreferenceOption_e.swDetailingBalloon, swBalloonStyle_e.<Value>)

See swBalloonStyle_e for valid options

Specifies shape of single BOM balloon

Single balloon - Size

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMBalloonFit, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMBalloonFit, swUserPreferenceOption_e.swDetailingBalloon, swBalloonFit_e.<Value>)

See swBalloonFit_e for valid options

Specifies size of single BOM balloon

Single balloon - User defined

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMBalloonCustomSize, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMBalloonCustomSize, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies the custom size of a single BOM balloon; sets the Size spin box to the specified size and the Size dropdown to Custom Size

Single balloon - Padding

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMBalloonPadding, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMBalloonPadding, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies the padding for single BOM balloons

Stacked balloons - Style

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMStackedBalloonStyle, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMStackedBalloonStyle, swUserPreferenceOption_e.swDetailingBalloon, swBalloonStyle_e.<Value>)

See swBalloonStyle_e for valid options

Specifies the shapes of stacked BOM balloons

Stacked balloons - Size

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMStackedBalloonFit, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBOMStackedBalloonFit, swUserPreferenceOption_e.swDetailingBalloon, swBalloonFit_e.<Value>)

See swBalloonFit_e for valid options

Specifies the sizes of stacked BOM balloons

Stacked balloons - User defined

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMStackedBalloonCustomSize, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMStackedBalloonCustomSize, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies the custom sizes of stacked BOM balloons; sets the Size spin box to the specified size and the Size dropdown to Custom Size

Stacked balloons - Padding

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMStackedBalloonPadding, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBOMStackedBalloonPadding, swUserPreferenceOption_e.swDetailingBalloon, <Value>)

Double value

Specifies the padding for stacked BOM balloons

Auto balloon layout

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingAutoBalloonLayout, swUserPreferenceOption_e.swDetailingBalloon)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingAutoBalloonLayout, swUserPreferenceOption_e.swDetailingBalloon, swBalloonLayoutType_e.<Value>)

See swBalloonLayoutType_e for valid options

Specifies default auto balloon layout



Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Document Properties > Annotations > Balloons
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2019 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.