M

TextNote.Create

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

Remarks:

The new text note will consist of a single line of text unless there are line-break characters (CR) 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 text note will be visible only in the specified view.

The new text note 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

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,
	TextNoteOptions options
)

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

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

static member Create : 
        document : Document * 
        viewId : ElementId * 
        position : XYZ * 
        text : string * 
        options : TextNoteOptions -> TextNote

Document

document

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

viewId

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

position

A model position of the new note.
Note that the position's relation to the text's bounding box depends on the requested text alignment (set via the Options argument). It will be the box' top-left corner for a left-aligned text, the top-right corner for a right-aligned text, and middle-top point if the text is to be centered.
String

text

Text to populate the text note with.
TextNoteOptions

options

Options to control behavior and appearance of the text note.

Return Value TextNote The newly created text note.

ArgumentException

The document is a family that cannot contain text notes or annotation labels. -or- The viewId does not represent a valid graphic view element in the given document. -or- The options structure does not contain a valid text type to use for a new text note in the given document. -or- A valid point must not be father then 10 miles (approx. 16 km) from the origin.
ArgumentNullException

A non-optional argument was null