Hide Table of Contents
INote Interface Methods

For a list of all members of this type, see INote members.

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.  
MethodGetBalloonPaddingGets the balloon padding of this note.  
MethodGetBalloonSizeGets the balloon size or fit of this note.  
MethodGetBalloonStackGets the balloon stack for 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.  
MethodGetLeaderNumPointsAtGets the number of points in the specified leader of this note.  
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::IGetTextFormat.  
MethodGetTextFormatAtIndexObsolete. Superseded by IAnnotation::GetTextFormat and IAnnotation::IGetTextFormat.  
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 (i.e., 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.  
MethodGetTextVerticalJustificationGets the vertical justification of a standard note.  
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 (i.e., 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.  
MethodSetBalloonPaddingSets the padding for this balloon 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.  
MethodSetTextVerticalJustificationSets the vertical justification of a standard note.  
MethodSetZeroLengthLeaderSets a 0-length leader for a compound note.  
Top

See Also



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 Methods
*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) 2018 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.

0.20.53