Hide Table of Contents
SetTextAtIndex Method (INote)

Obsolete for documents created in SOLIDWORKS 2016 and later. Sets the text value at the specified index within the compound note.

.NET Syntax

Visual Basic (Declaration) 
Function SetTextAtIndex( _
   ByVal Index As System.Integer, _
   ByVal Txt As System.String _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As INote
Dim Index As System.Integer
Dim Txt As System.String
Dim value As System.Boolean
 
value = instance.SetTextAtIndex(Index, Txt)
C# 
System.bool SetTextAtIndex( 
   System.int Index,
   System.string Txt
)
C++/CLI 
System.bool SetTextAtIndex( 
&   System.int Index,
&   System.String^ Txt
) 

Parameters

Index

Index position of the text within the compound note; an invalid index value causes false to be returned

Txt

Text to replace the current note text

Return Value

True if the text change is made successfully, false if not

Remarks

Because a compound note can have multiple pieces of text, many of the compound note methods require you to specify the index value of the desired text. For example, the first piece of text added to the compound note using INote::AddText has an index number of 1, the second text added has an index number of 2, and so on.

After completing any note changes, you must perform an IModelDoc2::EditRebuild3.

If you use this method on a standard note (not a compound note), then the index value should be set to 1. Use INote::SetText for modifying text in a standard note.

 

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:   SetTextAtIndex Method (INote)
*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.