Text |
A class representing text note annotations in Revit.
Inheritance Hierarchy Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax The TextNote type exposes the following members.
Properties | Name | Description | |
|---|---|---|
 | AssemblyInstanceId | The id of the assembly instance to which the element belongs. (Inherited from Element ) |
| | BaseDirection | Direction of the base line of the text element. (Inherited from TextElement ) |
| | BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) |
| | Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) |
| | Coord | Position of the text (in model coordinates.) (Inherited from TextElement ) |
| | CreatedPhaseId | Id of a Phase at which the Element was created. (Inherited from Element ) |
| | DemolishedPhaseId | Id of a Phase at which the Element was demolished. (Inherited from Element ) |
| | DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) |
| | Document | Returns the Document in which the Element resides. (Inherited from Element ) |
| | Geometry | Retrieves the geometric representation of the element. (Inherited from Element ) |
| | GroupId | The id of the group to which an element belongs. (Inherited from Element ) |
| | Height | Height of the area of the text content. (Inherited from TextElement ) |
| | HorizontalAlignment | Horizontal alignment of the text content within the text area of the element. (Inherited from TextElement ) |
| | Id | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) |
| | IsModifiable | Identifies if the element is modifiable. (Inherited from Element ) |
| | IsTextWrappingActive | A flag identifying whether text-wrapping is currently active in this text element or not. If text wrapping is active the width of the text box remains constant and the text will wrap. The height of the text box will automatically adjust to accomodate the height of the text. If text wrapping is not active the text does not wrap and the width of the text box adjusts with the width of the longest line of text. As the text width changes, the position of the text may change depending on the HorizontalAlignment (Inherited from TextElement ) |
| | IsTransient | Indicates whether an element is transient or permanent. (Inherited from Element ) |
| | IsValidObject | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) |
| | KeepRotatedTextReadable | A flag to control how text behaves inside a rotated text element. (Inherited from TextElement ) |
| | LeaderCount | Number of leader objects currently attached to the text note. |
| | LeaderLeftAttachment | Attachment position of leaders on the left side of the text note. |
| | LeaderRightAttachment | Attachment position of leaders on the right side of the text note. |
| | LevelId | The id of the level associated with the element. (Inherited from Element ) |
| | Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) |
| | Name | A human readable name for the Element. (Inherited from Element ) |
| | OwnerViewId | The id of the view that owns the element. (Inherited from Element ) |
| | Parameter BuiltInParameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) |
| | Parameter Definition | Retrieves a parameter from the element based on its definition. (Inherited from Element ) |
| | Parameter Guid | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) |
| | Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) |
| | ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) |
| | Pinned | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) |
| | Symbol | Get the type of the TextElement object. (Inherited from TextElement ) |
| | Text | The content of the element as a plain string stripped of all formating. (Inherited from TextElement ) |
| | TextNoteType | Access the type of the TextNote object. |
| | UniqueId | A stable unique identifier for an element within the document. (Inherited from Element ) |
| | UpDirection | Direction along the vertical axis of letters of the text note. (Inherited from TextElement ) |
| | VersionGuid | Get the element version Guid. (Inherited from Element ) |
| | VerticalAlignment | Vertical alignment of the text. (Inherited from TextElement ) |
| | ViewSpecific | Identifies if the element is owned by a view. (Inherited from Element ) |
| | Width | Width of the area of the text content. (Inherited from TextElement ) |
| | WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) |
Methods | Name | Description | |
|---|---|---|
 | AddLeader | Adds a leader to the text note. |
| | ArePhasesModifiable | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) |
| | CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element ) |
| | CanBeLocked | Identifies if the element can be locked. (Inherited from Element ) |
| | CanDeleteSubelement | Checks if given subelement can be removed from the element. (Inherited from Element ) |
| | CanHaveTypeAssigned | Identifies if the element can have a type assigned. (Inherited from Element ) |
| | ChangeTypeId(ElementId) | Changes the type of the element. (Inherited from Element ) |
 | Create(Document, ElementId, XYZ, String, ElementId) | Creates a new unwrapped TextNote element with the given properties. |
| | Create(Document, ElementId, XYZ, String, TextNoteOptions) | Creates a new unwrapped text note element with the given properties. |
| | Create(Document, ElementId, XYZ, Double, String, ElementId) | Creates a new line-wrapping text note element of the given width and properties. |
| | Create(Document, ElementId, XYZ, Double, String, TextNoteOptions) | Creates a new line-wrapping text note element of the given width and properties. |
| | DeleteEntity | Deletes the existing entity created by %schema% in the element (Inherited from Element ) |
| | DeleteSubelement | Removes a subelement from the element. (Inherited from Element ) |
| | DeleteSubelements | (Inherited from Element ) |
| | Dispose | (Inherited from Element ) |
| | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) |
| | EvaluateAllParameterValues | Evaluates all the parameters' values of the element. (Inherited from Element ) |
| | EvaluateParameterValues | (Inherited from Element ) |
| | GetDependentElements | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) |
| | GetEntity | Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. (Inherited from Element ) |
| | GetEntitySchemaGuids | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) |
| | GetExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) |
| | GetExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) |
| | GetExternalResourceReferenceExpanded | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) |
| | GetExternalResourceReferences | Gets the map of the external resource references referenced by the element. (Inherited from Element ) |
| | GetExternalResourceReferencesExpanded | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) |
| | GetFormattedText | Returns an object that contains text and associated formatting of this note. |
| | GetGeneratingElementIds | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) |
| | GetGeometryObjectFromReference | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) |
| | GetHashCode | Serves as the default hash function. (Inherited from Object ) |
| | GetLeaders | Returns a collection of leaders currently attached to the text note. |
| | GetMaterialArea | Gets the area of the material with the given id. (Inherited from Element ) |
| | GetMaterialIds | Gets the element ids of all materials present in the element. (Inherited from Element ) |
| | GetMaterialVolume | Gets the volume of the material with the given id. (Inherited from Element ) |
| | GetMaximumAllowedWidth | Returns the maximum width the text element can be assigned. (Inherited from TextElement ) |
| | GetMinimumAllowedWidth | Returns the minimum width the text element can be assigned. (Inherited from TextElement ) |
| | GetMonitoredLinkElementIds | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) |
| | GetMonitoredLocalElementIds | Provides the local element IDs when the element is monitoring. (Inherited from Element ) |
| | GetOrderedParameters | Gets the parameters associated to the element in order. (Inherited from Element ) |
| | GetParameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) |
| | GetParameterFormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) |
| | GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element ) |
| | GetPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) |
| | GetSubelements | Returns the collection of element subelements. (Inherited from Element ) |
| | GetType | Gets the Type of the current instance. (Inherited from Object ) |
| | GetTypeId | Returns the identifier of this element's type. (Inherited from Element ) |
| | GetValidTypes | Obtains a set of types that are valid for this element. (Inherited from Element ) |
| | HasPhases | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) |
| | IsCreatedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) |
| | IsDemolishedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) |
| | IsExternalFileReference | Determines whether this Element represents an external file. (Inherited from Element ) |
| | IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) |
| | IsMonitoringLinkElement | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) |
| | IsMonitoringLocalElement | Indicate whether an element is monitoring other local elements. (Inherited from Element ) |
| | IsPhaseCreatedValid | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) |
| | IsPhaseDemolishedValid | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) |
| | IsValidType(ElementId) | Checks if given type is valid for this element. (Inherited from Element ) |
| | LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) |
| | RefersToExternalResourceReference | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) |
| | RefersToExternalResourceReferences | Determines whether this Element uses external resources. (Inherited from Element ) |
| | RemoveLeaders | Removes all leaders currently attached to the text note. |
| | SetEntity | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) |
| | SetFormattedText | Sets the text and associated formatting of the text of in this text note with a given FormattedText object. |
| | ToString | Returns a string that represents the current object. (Inherited from Object ) |
See Also