Welcome
Getting Started
SolidWorks API Help
Functional Categories
Release Notes
SolidWorks.Interop.sldworks Namespace
Overview
Interfaces
IAdvancedSelectionCriteria
IAnnotation
IAnnotationView
IAppearanceSetting
IAssemblyDoc
IAttribute
IAttributeDef
IAutoBalloonOptions
IBalloonOptions
IBalloonStack
IBaseFlangeFeatureData
IBendsFeatureData
IBendTable
IBendTableAnnotation
IBody2
IBodyFolder
IBomFeature
IBomTable
IBomTableAnnotation
IBomTableSortData
IBreakCornerFeatureData
IBreakLine
IBrokenOutSectionFeatureData
IBSurfParamData
ICallout
ICamera
ICavityFeatureData
ICenterLine
ICenterMark
IChamferFeatureData2
ICircularPatternFeatureData
IClosedCornerFeatureData
ICoEdge
IColorTable
ICombineBodiesFeatureData
ICommandGroup
ICommandManager
ICommandTab
ICommandTabBox
IComment
ICommentFolder
IComponent2
ICompositeCurveFeatureData
IConfiguration
IConfigurationManager
IConnectionPointFeatureData
ICoordinateSystemFeatureData
ICoreFeatureData
ICosmeticThreadFeatureData
ICThread
ICurve
ICurveDrivenPatternFeatureData
ICurveParamData
ICustomBendAllowance
ICustomPropertyManager
IDatumOrigin
IDatumTag
IDatumTargetSym
IDecal
IDeleteBodyFeatureData
IDeleteFaceFeatureData
IDerivedPartFeatureData
IDerivedPatternFeatureData
IDesignTable
IDetailCircle
IDiagnoseResult
IDimension
IDimensionSensorData
IDimensionTolerance
IDimXpertManager
IDisplayData
IDisplayDimension
IDisplayStateSetting
IDocumentSpecification
IDomeFeatureData2
IDowelSymbol
IDraftFeatureData2
IDragArrowManipulator
IDragOperator
IDrawingComponent
IDrawingDoc
IDrSection
IEdge
IEdgeFlangeFeatureData
IEdgePoint
IEndCapFeatureData
IEntity
IEnumBodies2
IEnumCoEdges
IEnumComponents2
IEnumDisplayDimensions
IEnumDocuments2
IEnumDrSections
IEnumEdges
IEnumFaces2
IEnumLoops2
IEnumModelViews
IEnumSketchHatches
IEnumSketchPoints
IEnumSketchSegments
IEnvironment
IEquationMgr
IExplodeStep
IExportPdfData
IExtrudeFeatureData2
IFace2
IFaceDecalProperties
IFaceHatch
IFaultEntity
IFeatMgrView
IFeature
IFeatureFolder
IFeatureManager
IFeatureStatistics
IFillSurfaceFeatureData
IFlatPatternFeatureData
IFlyoutGroup
IFoldsFeatureData
IFrame
IFreePointCurveFeatureData
IGeneralTableAnnotation
IGeneralTableFeature
IGtol
IGussetFeatureData
IHealEdgesFeatureData
IHelixFeatureData
IHemFeatureData
IHoleSeriesFeatureData
IHoleTable
IHoleTableAnnotation
IImportDxfDwgData
IImportedCurveFeatureData
IImportIgesData
IImportStepData
IInterference
IInterferenceDetectionMgr
IJogFeatureData
IJoinFeatureData
ILayer
ILayerMgr
ILibraryFeatureData
ILight
ILightDialog
ILinearPatternFeatureData
ILocalCircularPatternFeatureData
ILocalLinearPatternFeatureData
ILoftedBendsFeatureData
ILoftFeatureData
ILoop2
IMacroFeatureData
IMagneticLine
IManipulator
IMassProperty
IMate2
IMateEntity2
IMateInPlace
IMateLoadReference
IMateReference
IMaterialVisualPropertiesData
IMathPoint
IMathTransform
IMathUtility
IMathVector
IMeasure
IMidSurface3
IMirrorPatternFeatureData
IMirrorSolidFeatureData
IMiterFlangeFeatureData
IModelDoc2
IModelDocExtension
IModeler
IModelView
IModelViewManager
IModelWindow
IMotionPlotAxisFeatureData
IMotionPlotFeatureData
IMouse
IMoveCopyBodyFeatureData
IMoveFaceFeatureData
IMultiJogLeader
INote
Members
IOneBendFeatureData
IPackAndGo
IPageSetup
IParameter
IPartDoc
IPartingLineFeatureData
IPartingSurfaceFeatureData
IPlaneManipulator
IPrint3DDialog
IProjectionArrow
IProjectionCurveFeatureData
IPropertyManagerPage2
IPropertyManagerPageActiveX
IPropertyManagerPageBitmap
IPropertyManagerPageBitmapButton
IPropertyManagerPageButton
IPropertyManagerPageCheckbox
IPropertyManagerPageCombobox
IPropertyManagerPageControl
IPropertyManagerPageGroup
IPropertyManagerPageLabel
IPropertyManagerPageListbox
IPropertyManagerPageNumberbox
IPropertyManagerPageOption
IPropertyManagerPageSelectionbox
IPropertyManagerPageSlider
IPropertyManagerPageTab
IPropertyManagerPageTextbox
IPropertyManagerPageWindowFromHandle
IPunchTable
IPunchTableAnnotation
IRayTraceRenderer
IRayTraceRendererOptions
IRefAxis
IRefAxisFeatureData
IReferenceCurve
IReferencePointCurveFeatureData
IRefPlane
IRefPlaneFeatureData
IRefPoint
IRefPointFeatureData
IRenderMaterial
IReplaceFaceFeatureData
IRevisionTableAnnotation
IRevisionTableFeature
IRevolveFeatureData2
IRibFeatureData2
IRipFeatureData
IRoutingSettings
IRuledSurfaceFeatureData
ISaveBodyFeatureData
IScaleFeatureData
ISectionViewData
ISelectData
ISelectionMgr
ISensor
ISFSymbol
ISheet
ISheetMetalFeatureData
IShellFeatureData
IShutOffSurfaceFeatureData
ISilhouetteEdge
ISimpleFilletFeatureData2
ISimpleHoleFeatureData2
ISimulation3DContactFeatureData
ISimulationDamperFeatureData
ISimulationForceFeatureData
ISimulationGravityFeatureData
ISimulationMotorFeatureData
ISimulationSpringFeatureData
ISketch
ISketchArc
ISketchBlockDefinition
ISketchBlockInstance
ISketchContour
ISketchedBendFeatureData
ISketchEllipse
ISketchHatch
ISketchLine
ISketchManager
ISketchParabola
ISketchPath
ISketchPatternFeatureData
ISketchPicture
ISketchPoint
ISketchRegion
ISketchRelation
ISketchRelationManager
ISketchSegment
ISketchSlot
ISketchSpline
ISketchText
ISldWorks
ISmartComponentFeatureData
ISnapShot
ISplineHandle
ISplineParamData
ISplitBodyFeatureData
ISplitLineFeatureData
ISpring
IStackedBalloonOptions
IStatusBarPane
IStructuralMemberFeatureData
IStructuralMemberGroup
ISurface
ISurfaceCutFeatureData
ISurfaceExtendFeatureData
ISurfaceKnitFeatureData
ISurfaceOffsetFeatureData
ISurfaceParameterizationData
ISurfacePlanarFeatureData
ISurfaceRadiateFeatureData
ISurfaceTrimFeatureData
ISurfExtrudeFeatureData
ISurfRevolveFeatureData
ISweepFeatureData
ISwOLEObject
ISWPropertySheet
ITableAnchor
ITableAnnotation
ITablePatternFeatureData
ITaskpaneView
ITessellation
ITextFormat
ITexture
IThickenFeatureData
ITitleBlock
ITitleBlockTableAnnotation
ITitleBlockTableFeature
IToolingSplitFeatureData
ITreeControlItem
ITriadManipulator
IUserProgressBar
IUserUnit
IVariableFilletFeatureData2
IVertex
IView
IWeldBead
IWeldmentBeadFeatureData
IWeldmentCutListAnnotation
IWeldmentCutListFeature
IWeldmentTrimExtendFeatureData
IWeldSymbol
IWizardHoleFeatureData2
IWrapSketchFeatureData
SolidWorks.Interop.swmotionstudy Namespace
SolidWorks.Interop.swdimxpert Namespace
SolidWorks.Interop.swpublished Namespace
SolidWorks.Interop.sw3dprinter Namespace
SolidWorks.Interop.dsgnchk Namespace
SolidWorks.Interop.swhtmlcontrol Namespace
SolidWorks.Interop.swconst Namespace
SolidWorks.Interop.swcommands Namespace
FeatureWorks API Help
SolidWorks Document Manager API Help
eDrawings API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
Hide Table of Contents Show Table of Contents
INote Interface Members

The following tables list the members exposed by INote.

Public Properties

 NameDescription
 PropertyAngleControls the rotation angle of this note.  
 PropertyHasMultipleFontsGets whether a note contains multiple fonts.  
 PropertyIsBendLineNoteGets whether this note is a bend-line note.  
 PropertyLockPositionGets and sets whether to anchor this note.  
 PropertyPromptTextGets and sets the message prompt text.  
 PropertyPropertyLinkedTextGets or sets the text for the note using the values of the properties linked to the note.  
 PropertyReadOnlyGets or sets the read-only state of a note.  
 PropertyTagNameGets or sets the tag name for this note.  
 PropertyTextRightToLeftGets or sets whether notes are displayed right to left.  
 PropertyVisibleGets and sets the visibility state of a note during the creation of a block.  
Top

Public Methods

 NameDescription
 MethodAddTextAdds text to the selected compound note.  
 MethodBeginSketchEditActivates the sketch of the compound note.  
 MethodEndSketchEditFinishes accessing this compound note's sketch.  
 MethodGetAnnotationGets the annotation for this specific note.  
 MethodGetArcAtIndexGets information for the specified arc in this note.  
 MethodGetArcCountGets the number of arcs in the note.  
 MethodGetArrowHeadAtIndexGets information on the specified arrowhead in this note.  
 MethodGetArrowHeadCountGets the number of arrowheads in the note.  
 MethodGetArrowHeadInfoGets an array of doubles that describe the geometry of the arrowhead on the far end of the leader line.  
 MethodGetAttachPosGets the attachment point of this note.  
 MethodGetBalloonInfoGets information describing the geometry of the balloon, if any, that encloses the note text.  
 MethodGetBalloonSizeGets the balloon size or fit of this note.  
 MethodGetBalloonStackGets the balloon stack this balloon note.  
 MethodGetBalloonStyleGets the balloon style of this note.  
 MethodGetBendLineValuesObsolete. Superseded by INote::GetBendLineValues2.  
 MethodGetBendLineValues2Gets the values of a bend line note.  
 MethodGetBomBalloonTextGets the text for this BOM balloon note.  
 MethodGetBomBalloonTextStyleGets the text style of this BOM balloon note.  
 MethodGetCompoundTextAtIndexGets the text item corresponding to the specified index from a compound note.  
 MethodGetCompoundTextCountGets the number of text items in a compound note.  
 MethodGetExtentGets the extents of a note or a compound note in sheet space.  
 MethodGetExtentAtIndexGets the extents of the specified piece of text within a compound note.  
 MethodGetFontInfoGets with the note's font information.  
 MethodGetHeightGet the note's height.  
 MethodGetHeightAtIndexGets the specified text item's height in a compound note.  
 MethodGetHeightInPointsGets the height of this note in points (for example, 8, 10, 12, and so on).  
 MethodGetHyperlinkTextGets the hyperlink in a note.  
 MethodGetLeaderAtIndexGets information about the specified leader on this note.  
 MethodGetLeaderCountGets the number of leaders on this note.  
 MethodGetLeaderInfoGets information describing the layout of the note leader lines.  
 MethodGetLineAtIndexGets information for the specified line.  
 MethodGetLineCountGets the number of line segments in this note.  
 MethodGetNameGets the name of this note.  
 MethodGetNextGets the next note in drawing view.  
 MethodGetSketchGets the sketch for the current compound note.  
 MethodGetTextGets this note's text.  
 MethodGetTextAngleAtIndexGets the text angle for the specified piece of text in this note.  
 MethodGetTextAtIndexGets the specified text in this note.  
 MethodGetTextCountGets the number of text items in this note.  
 MethodGetTextFontAtIndexGets the font used by the specified text item in this note.  
 MethodGetTextFormatObsolete. Superseded by IAnnotation::GetTextFormat and IAnnotation::GetTextFormat.  
 MethodGetTextFormatAtIndexObsolete. Superseded by IAnnotation::GetTextFormat and IAnnotation::GetTextFormat.  
 MethodGetTextHeightAtIndexGets the text height for the specified piece of text in this note.  
 MethodGetTextInvertAtIndexGets the specified text item's invert flag.  
 MethodGetTextJustificationGets the text justification of a standard note.  
 MethodGetTextJustificationAtIndexGets the text justification for the specified text item in a compound note.  
 MethodGetTextLineSpacingAtIndexGets the line spacing for this note.  
 MethodGetTextOffsetAtIndexGets whether the text item's offset relative to note's text point in a compound note.  
 MethodGetTextPointObsolete. Superseded by INote::GetTextPoint2 or INote::IGetTextPoint2.  
 MethodGetTextPoint2Gets the note's text reference point (the note origin).  
 MethodGetTextPositionAtIndexGets the text item's offset relative to the document origin.  
 MethodGetTextRefPositionAtIndexGets the specified text item's reference position in this note, for example, the upper left, lower left, or center.  
 MethodGetTriangleAtIndexGets the triangle at the specified index.  
 MethodGetTriangleCountGets the number of triangles in this note.  
 MethodGetUpperRightGets the note's upper-right text point.  
 MethodGetUseDocTextFormatObsolete. Superseded by IAnnotation::GetUSeDocTextFormat.  
 MethodHasBalloonGets whether this note has a balloon.  
 MethodHasExtraLeaderGets whether this note has a bent or straight leaderline.  
 MethodIGetAnnotationGets the annotation for this specific note.  
 MethodIGetArcAtIndexGets information for the specified arc in this note.  
 MethodIGetArrowHeadAtIndexGets information on the specified arrowhead in this note.  
 MethodIGetArrowHeadInfoGets an array of doubles that describe the geometry of the arrowhead on the far end of the leader line.  
 MethodIGetAttachPosGets the attachment point of this note.  
 MethodIGetBalloonInfoGets information describing the geometry of the balloon, if any, that encloses the note text.  
 MethodIGetExtentGets the extents of a note or a compound note in sheet space.  
 MethodIGetExtentAtIndexGets the extents of the specified piece of text within a compound note.  
 MethodIGetFontInfoGets with the note's font information.  
 MethodIGetLeaderAtIndexGets information about the specified leader on this note.  
 MethodIGetLeaderInfoGets information describing the layout of the note leader lines.

   

 MethodIGetLineAtIndexGets information for the specified line.  
 MethodIGetNextGets the next note in drawing view.  
 MethodIGetSketchGets the sketch for the current compound note.  
 MethodIGetTextFormatObsolete. Superseded by IAnnotation::GetTextFormat and IAnnotation::GetTextFormat.  
 MethodIGetTextFormatAtIndexObsolete. Superseded by IAnnotation::GetTextFormat and IAnnotation::GetTextFormat.  
 MethodIGetTextOffsetAtIndexGets whether the text item's offset relative to note's text point in a compound note.  
 MethodIGetTextPointObsolete. Superseded by INote::IGetTextPoint.  
 MethodIGetTextPoint2Gets the note's text reference point (the note origin).  
 MethodIGetTextPositionAtIndexGets the text item's offset relative to the document origin.  
 MethodIGetTriangleAtIndexGets the triangle at the specified index.  
 MethodIGetUpperRightGets the note's upper-right text point.  
 MethodIsAttachedGets whether the note is attached.  
 MethodIsAttributeObsolete. Not superseded.  
 MethodIsBomBalloonGets whether this note has a BOM balloon.  
 MethodIsCompoundNoteGets whether the current note is a compound note.  
 MethodISetTextFormatObsolete. Superseded by IAnnotation::SetTextFormat and IAnnotation::ISetTextFormat.  
 MethodISetTextFormatAtIndexObsolete. Superseded by IAnnotation::SetTextFormat and IAnnotation::ISetTextFormat.  
 MethodIsStackedBalloonGets whether this note is part of a stacked balloon.  
 MethodIsStackedBalloonMasterGets whether this note is the master note of a balloon stack.  
 MethodSetBalloonSets the balloon style, size, and fit for this note.  
 MethodSetBomBalloonTextSets the text for this BOM balloon note.  
 MethodSetHeightSets the height of this note in meters.  
 MethodSetHeightInPointsSets the height of this note in points (for example, 8, 10, 12, and so on).  
 MethodSetHyperlinkTextSets the hyperlink in a note.  
 MethodSetNameSets the name for this note.  
 MethodSetTextSets the text of the note.  
 MethodSetTextAtIndexSets the text value at the specified index within the compound note.  
 MethodSetTextFormatObsolete. Superseded by IAnnotation::SetTextFormat and IAnnotation::ISetTextFormat.  
 MethodSetTextFormatAtIndexObsolete. Superseded by IAnnotation::SetTextFormat and IAnnotation::ISetTextFormat.  
 MethodSetTextJustificationSets the text justification of a standard note.  
 MethodSetTextJustificationAtIndexSets the text justification for the specified text item in a compound note.  
 MethodSetTextOffsetAtIndexRelocates the offset (origin) of the specified piece of text in a compound note.  
 MethodSetTextPointRelocates the note or compound note origin to the specified location.  
 MethodSetZeroLengthLeaderSets a 0-length leader for a compound note.  
Top

See Also



Related SolidWorks Forum Content

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:   INote Interface Members
*Comment:  
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

The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document 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.