Hide Table of Contents
IGetExtentAtIndex Method (INote)

Gets the extents of the specified piece of text within a compound note.

.NET Syntax

Visual Basic (Declaration) 
Function IGetExtentAtIndex( _
   ByVal Index As System.Integer _
) As System.Double
Visual Basic (Usage) 
Dim instance As INote
Dim Index As System.Integer
Dim value As System.Double
 
value = instance.IGetExtentAtIndex(Index)
C# 
System.double IGetExtentAtIndex( 
   System.int Index
)
C++/CLI 
System.double IGetExtentAtIndex( 
&   System.int Index
) 

Parameters

Index
Index number of text

Return Value

  • in-process, unmanaged C++: Pointer to an array of doubles (see Remarks)
  • VBA, VB.NET, C#, and C++/CLI: Not supported

See In-process Methods for details about this type of method.

Remarks

The data returned is an array of 6 doubles that describe the lower-left and upper-right box extents of the text string. The values (X,Y,Z) are in sheet space. In other words, they are in relation to the origin of the drawing document which is in the lower-left corner of the drawing.

In a compound note, this method determines the text item's offset relative to note's text point.

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 2, and so on.

If you use this method on a standard note (not a compound note), then the index value should be set to 1.

 

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:   IGetExtentAtIndex 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) 2017 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.