IManagedLeaderNotes.Add Method

Namespace:  Autodesk.iLogic.Interfaces
Assembly:  Autodesk.iLogic.Interfaces (in Autodesk.iLogic.Interfaces.dll) Version: 30.0

Syntax

VB

Function Add ( 
	name As String,
	leaderPoints As IEnumerable(Of DocumentUnitsPoint2d),
	attachTo As GeometryIntent,
	formattedText As String,
	Optional dimensionStyle As Object = Nothing
) As IManagedLeaderNote

C#

IManagedLeaderNote Add(
	string name,
	IEnumerable<DocumentUnitsPoint2d> leaderPoints,
	GeometryIntent attachTo,
	string formattedText,
	Object dimensionStyle = null
)

Parameters

name

Type: System.String
The name of the managed leader note.

leaderPoints

Type: System.Collections.Generic.IEnumerable(DocumentUnitsPoint2d)
A list of points representing the leader originating at the note. The first item (if present) specifies the text position. This can be empty (or Nothing) if no leader is wanted. Note: this does not include a GeometryIntent to attach the leader to.

attachTo

Type: GeometryIntent
The geometry to attach the leader to.

formattedText

Type: System.String
Specifies the text of the general note. This string can contain tags that define internal formatting changes, which override the text style associated with the general note. The formatting is specified using XML tags within the string. By default, all text in the string will be displayed using the text style assigned to the note. You can use the XML tags to override the default style and apply style overrides for all or portions of the text. The formatting overrides are defined using tags. There is an opening tag and closing tag for each formatting override you define. The text between the opening and closing tags is affected by the override. See the list of XML text formatting tags under Reference Topics in the Overviews section in the Inventor API help.

dimensionStyle (Optional)

Type: System.Object
Specifies which dimension style to use for the leader note. The dimension style can be specified by providing the name of an existing style or by supplying a DimensionStyle object. Default = Nothing : uses the default leader note style.

Return Value

Type: IManagedLeaderNote
The managed leader note.

See Also

Reference