TextNoteCreate(Document, ElementId, XYZ, String, TextNoteOptions) Method

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 

Parameters

document  Document

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

viewId  ElementId

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

position  XYZ

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.

text  String

Text to populate the text note with.

options  TextNoteOptions

Options to control behavior and appearance of the text note.

Return Value

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.

Reference