M

TextNote.Create

Description:
Creates a new unwrapped TextNote element with the given properties.

Remarks:

The new TextNote will consist of a single line of text unless there are carriage return ('\r') or vertical tab ('\v') characters in the given string. Once the text note is created its width gets adjusted to fit the longest (or the single one) line of text.

As a view-specific element the TextNote will be visible only in the specified view.

The new TextNote will be created using the given text type, which defines the style. The currently default style can be obtained from the Document.GetDefaultElementTypeId method.

Overloads (4):

Create(Document,ElementId,XYZ,Double,String,ElementId)

Create(Document,ElementId,XYZ,Double,String,TextNoteOptions)

Create(Document,ElementId,XYZ,String,ElementId)

Create(Document,ElementId,XYZ,String,TextNoteOptions)

public static TextNote Create(
	Document document,
	ElementId viewId,
	XYZ position,
	string text,
	ElementId typeId
)

Public Shared Function Create ( _
	document As Document, _
	viewId As ElementId, _
	position As XYZ, _
	text As String, _
	typeId As ElementId _
) As TextNote

public:
static TextNote^ Create(
	Document^ document, 
	ElementId^ viewId, 
	XYZ^ position, 
	String^ text, 
	ElementId^ typeId
)

Autodesk.Revit.DB.Document

document

A valid Revit document that is currently modifiable (i.e. with an open transaction).
Autodesk.Revit.DB.ElementId

viewId

Id of the graphic view in which the note is to be created.
Autodesk.Revit.DB.XYZ

position

A model position of the new note.
For a left-aligned text (default), the origin is set at the top-left corner of the note's bounding box.
String

text

Text to populate the text note with.
Autodesk.Revit.DB.ElementId

typeId

Id of the text type to use for the new text note.

Return Value TextNote The newly created text note.

Autodesk.Revit.Exceptions.ArgumentException

The document is a family that cannot contain text notes. -or- The viewId does not represent a valid graphic view element in the given document. -or- The typeId does not represent a valid text type in the given document. -or- A valid point must not be father then 10 miles (approx. 16 km) from the origin.
Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was null