InsertNoteWithParameters Method (ISketchManager)

InsertNoteWithParameters Method (ISketchManager) | Send Feedback
See Also Example

Note[out]
  Note

X1
  x coordinate of the upper-left corner of the Note

Y1
  y coordinate of the upper-left corner of the Note

Z1
  z coordinate of the upper-left corner of the Note

X2
  x coordinate of the lower-right corner of the Note

Y2
  y coordinate of the lower-right corner of the Note

Z2
  z coordinate of the lower-right corner of the Note

StrArray
  Array of strings constituting the text of the Note

Angle
  Angle of rotation of the Note

Height
  Height of text in the Note

Justify
  Justification as defined in dsNoteJustification_e

LineSpacingStyle
  Line spacing style as defined in dsNoteLineSpacingStyle_e

LineSpaceDistance
  Distance between each line in the Note

TextStyle
  TextStyle in the Note

Width
  Width of the Note

Inserts and formats the Note as specified.

# Syntax

Visual Basic |
--- | ---
    Function InsertNoteWithParameters( _
       ByVal X1 As System.Double, _
       ByVal Y1 As System.Double, _
       ByVal Z1 As System.Double, _
       ByVal X2 As System.Double, _
       ByVal Y2 As System.Double, _
       ByVal Z2 As System.Double, _
       ByVal StrArray As System.Object, _
       ByVal Angle As System.Double, _
       ByVal Height As System.Double, _
       ByVal Justify As dsNoteJustification_e, _
       ByVal LineSpacingStyle As dsNoteLineSpacingStyle_e, _
       ByVal LineSpaceDistance As System.Double, _
       ByVal TextStyle As System.String, _
       ByVal Width As System.Double _
    ) As Note

C# |
--- | ---
    Note InsertNoteWithParameters(
       System.double X1,
       System.double Y1,
       System.double Z1,
       System.double X2,
       System.double Y2,
       System.double Z2,
       System.object StrArray,
       System.double Angle,
       System.double Height,
       dsNoteJustification_e Justify,
       dsNoteLineSpacingStyle_e LineSpacingStyle,
       System.double LineSpaceDistance,
       System.string TextStyle,
       System.double Width
    )

JavaScript |
--- | ---
    InsertNoteWithParameters(
       X1 : Number,
       Y1 : Number,
       Z1 : Number,
       X2 : Number,
       Y2 : Number,
       Z2 : Number,
       StrArray : Array,
       Angle : Number,
       Height : Number,
       Justify : String,
       LineSpacingStyle : String,
       LineSpaceDistance : Number,
       TextStyle : String,
       Width : Number
    ) : dsNote

COM native C++ |
--- | ---
    HRESULT InsertNoteWithParameters(
       DOUBLE X1,
       DOUBLE Y1,
       DOUBLE Z1,
       DOUBLE X2,
       DOUBLE Y2,
       DOUBLE Z2,
       VARIANT StrArray,
       DOUBLE Angle,
       DOUBLE Height,
       dsNoteJustification_e Justify,
       dsNoteLineSpacingStyle_e LineSpacingStyle,
       DOUBLE LineSpaceDistance,
       BSTR TextStyle,
       DOUBLE Width,
       INote** Note
    )

C++ |
--- | ---
    DSRESULT InsertNoteWithParameters(
       double X1,
       double Y1,
       double Z1,
       double X2,
       double Y2,
       double Z2,
       const dsStringArray& StrArray,
       double Angle,
       double Height,
       dsNoteJustification_e Justify,
       dsNoteLineSpacingStyle_e LineSpacingStyle,
       double LineSpaceDistance,
       const dsString& TextStyle,
       double Width,
       dsNote** Note
    )

#### Parameters

X1
  x coordinate of the upper-left corner of the Note
Y1
  y coordinate of the upper-left corner of the Note
Z1
  z coordinate of the upper-left corner of the Note
X2
  x coordinate of the lower-right corner of the Note
Y2
  y coordinate of the lower-right corner of the Note
Z2
  z coordinate of the lower-right corner of the Note
StrArray
  Array of strings constituting the text of the Note
Angle
  Angle of rotation of the Note
Height
  Height of text in the Note
Justify
  Justification as defined in dsNoteJustification_e
LineSpacingStyle
  Line spacing style as defined in dsNoteLineSpacingStyle_e
LineSpaceDistance
  Distance between each line in the Note
TextStyle
  TextStyle in the Note
Width
  Width of the Note
Note[out] or Return Value
  Note

# Example

Insert Notes with Parameters (C#)
Insert Notes with Parameters (VB.NET)
Insert Notes with Parameters (VBA)
Insert Block, Notes, and Sketch Entities (JavaScript)

# Remarks

DraftSight automatically calculates the height of the note's bounding box and modifies it based on the Justify parameter.

This bounding box boundary... | Is calculated when Justify is... |
Top | dsNoteJustification_BottomLeft, dsNoteJustification_BottomCenter, or dsNoteJustification_BottomRight |
Bottom | dsNoteJustification_TopLeft, dsNoteJustification_TopCenter, or dsNoteJustification_TopRight |
Top and bottom | dsNoteJustification_MiddleLeft, dsNoteJustification_MiddleCenter, or dsNoteJustification_MiddleRight |

The Width parameter setting determines word wrapping. The Height parameter is the default height of the note's text.

# See Also

####

ISketchManager Interface
ISketchManager Members
INote:InsertNote Method

# Availability

DraftSight V1R1.1