Hide Table of Contents

Document Properties > Annotations > Notes

 

Setting

Get/Set Methods

Return Value or <Value>

Comments

Base notes standard

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

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

See swDetailingStandard_e for valid options

Specifies the base notes standard to use

Leader style - Leader Style

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteLeaderLineStyle, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteLeaderLineStyle, swUserPreferenceOption_e.swDetailingNoOptionSpecified, swLineStyles_e.<Value>)

See swLineStyles_e for valid options

 

Leader style - Leader Thickness

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteLeaderLineThickness, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteLeaderLineThickness, swUserPreferenceOption_e.swDetailingNoOptionSpecified, swLineWeights_e.<Value>)

See swLineWeights_e for valid options

 

Leader style - Custom thickness

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingNoteLeaderLineThicknessCustom, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingNoteLeaderLineThicknessCustom, swUserPreferenceOption_e.swDetailingNoOptionSpecified, <Value>)

Double value

Specifies custom thickness of note leader lines; sets Custom Thickness to the specified thickness and Leader Thickness to Custom Size

Text - Font...

IModelDocExtension::GetUserPreferenceTextFormat(swUserPreferenceTextFormat_e.swDetailingNoteTextFormat, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceTextFormat(swUserPreferenceTextFormat_e.swDetailingNoteTextFormat, swUserPreferenceOption_e.swDetailingNoOptionSpecified, <Value>)

See ITextFormat for 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 - Text alignment

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteTextAlignment, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteTextAlignment, swUserPreferenceOption_e.swDetailingNoOptionSpecified, swTextJustification_e.<Value>)

See swTextJustification_e for valid options

Specifies text alignment for notes

Leader anchor - Closest, Left, or Right

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteLeaderSide, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNoteLeaderSide, swUserPreferenceOption_e.swDetailingNoOptionSpecified, swLeaderSide_e.<Value>)

See swLeaderSide_e for valid options

Specifies leader side for notes

Leader display - Straight, Bent, or Underlined

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNotesLeaderStyle, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingNotesLeaderStyle, swUserPreferenceOption_e.swDetailingNoOptionSpecified, swLeaderStyle_e.<Value>)

See swLeaderStyle_e for valid options

Specifies notes leader style

Leader display - Use document leader length

IModelDocExtension::GetUserPreferenceToggle(swUserPreferenceToggle_e.swDetailingNoteUseDocBentLeaderLength, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceToggle(swUserPreferenceToggle_e.swDetailingNoteUseDocBentLeaderLength, swUserPreferenceOption_e.swDetailingNoOptionSpecified, <Value>)

Boolean value

Specifies whether to use document bent leader lengths for annotations

Leader display - Leader length

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingNoteBentLeaderLength, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingNoteBentLeaderLength, swUserPreferenceOption_e.swDetailingNoOptionSpecified, <Value>)

Double value in meters

Specifies distance between leader bend and text of the note

Leader display - Leader justification snapping

IModelDocExtension::GetUserPreferenceToggle(swUserPreferenceToggle_e.swDetailingNotesLeaderJustificationSnapping, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceToggle(swUserPreferenceToggle_e.swDetailingNotesLeaderJustificationSnapping, swUserPreferenceOption_e.swDetailingNoOptionSpecified, <Value>)

Boolean value

Specifies whether leaders snap along grid lines

Border - Style

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonStyle, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonStyle, swUserPreferenceOption_e.swDetailingNoOptionSpecified, swBalloonStyle_e.<Value>)

See swBalloonStyle_e for valid options

Specifies the style of the border

Border - Size

IModelDocExtension::GetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonFit, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceInteger(swUserPreferenceIntegerValue_e.swDetailingBalloonFit, swUserPreferenceOption_e.swDetailingNoOptionSpecified, swBalloonFit_e.<Value>)

See swBalloonFit_e for valid options

Specifies the size of the border

Border - Size - Custom size

IModelDocExtension::GetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonCustomSize, swUserPreferenceOption_e.swDetailingNoOptionSpecified)

IModelDocExtension::SetUserPreferenceDouble(swUserPreferenceDoubleValue_e.swDetailingBalloonCustomSize, swUserPreferenceOption_e.swDetailingNoOptionSpecified, <Value>)

Double value

Specifies a custom size of the border; sets Border Size spin box to the specified size and Border Size dropdown to Custom Size

Layer

IModelDocExtension::GetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingLayer, swuserPreferenceOption_e.swDetailingNote)

IModelDocExtension::SetUserPreferenceString(swUserPreferenceStringValue_e.swDetailingLayer, swuserPreferenceOption_e.swDetailingNote, <Value>)

String value

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



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 > Notes
*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) 2012 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.