7b842903 c6b0 2bbf cf6e 794098863001

MText Class

netDxf 3.0.0 Library

Represents a multiline text entity.

Definition

Namespace: netDxf.Entities
Assembly: netDxf (in netDxf.dll) Version: 3.0.0

C#

public class MText : EntityObject

VB

Public Class MText
	Inherits EntityObject

C++

public ref class MText : public EntityObject

F#

type MText = 
    class
        inherit EntityObject
    end

Inheritance

Object → DxfObject → EntityObject → MText

Remarks

Formatting codes for MText, you can use them directly while setting the text value or use the Write() and EndParagraph() methods.
\L Start underline
\l Stop underline
\O Start overstrike
\o Stop overstrike
\K Start strike-through
\k Stop strike-through
\P New paragraph (new line)
\pxi Control codes for bullets, numbered paragraphs and columns
\X Paragraph wrap on the dimension line (only in dimensions)
\Q Slanting (obliquing) text by angle - e.g. \Q30;
\H Text height - e.g. \H3x;
\W Text width - e.g. \W0.8x;
\F Font selection

e.g. \Fgdt;o - GDT-tolerance
e.g. \Fkroeger|b0|i0|c238|p10; - font Kroeger, non-bold, non-italic, code page 238, pitch 10

\S Stacking, fractions

e.g. \SA^B;
A
B
e.g. \SX/Y
X

Y
e.g. \S1#4;
1/4

\A Alignment
\A0; = bottom
\A1; = center
\A2; = top

\C Color change
\C1; = red
\C2; = yellow
\C3; = green
\C4; = cyan
\C5; = blue
\C6; = magenta
\C7; = white

\T Tracking, char.spacing - e.g. \T2;
~ Non-wrapping space, hard space
{} Braces - define the text area influenced by the code
\ Escape character - e.g. \ = "", { = "{"

Codes and braces can be nested up to 8 levels deep.

Constructors

MText()	Initializes a new instance of the MText class.
MText(String)	Initializes a new instance of the MText class.
MText(Vector2, Double)	Initializes a new instance of the MText class.
MText(Vector3, Double)	Initializes a new instance of the MText class.
MText(String, Vector2, Double)	Initializes a new instance of the MText class.
MText(String, Vector3, Double)	Initializes a new instance of the MText class.
MText(Vector2, Double, Double)	Initializes a new instance of the MText class.
MText(Vector3, Double, Double)	Initializes a new instance of the MText class.
MText(String, Vector2, Double, Double)	Initializes a new instance of the MText class.
MText(String, Vector3, Double, Double)	Initializes a new instance of the MText class.
MText(Vector2, Double, Double, TextStyle)	Initializes a new instance of the MText class.
MText(Vector3, Double, Double, TextStyle)	Initializes a new instance of the MText class.
MText(String, Vector2, Double, Double, TextStyle)	Initializes a new instance of the MText class.
MText(String, Vector3, Double, Double, TextStyle)	Initializes a new instance of the MText class.

Properties

AttachmentPoint	Gets or sets the text attachment point.
CodeName	Gets the DXF object name. (Inherited from DxfObject)
Color	Gets or sets the entity color. (Inherited from EntityObject)
DefaultMirrText	Gets or sets if the text will be mirrored when a symmetry is performed, when the current MText entity does not belong to a DXF document.
DrawingDirection	Get or sets the text drawing direction.
Handle	Gets the handle assigned to the DXF object. (Inherited from DxfObject)
Height	Gets or sets the text height.
IsVisible	Gets or set the entity visibility. (Inherited from EntityObject)
Layer	Gets or sets the entity layer. (Inherited from EntityObject)
LineSpacingFactor	Gets or sets the line spacing factor.
LineSpacingStyle	Get or sets the line spacing style.
Linetype	Gets or sets the entity line type. (Inherited from EntityObject)
LinetypeScale	Gets or sets the entity line type scale. (Inherited from EntityObject)
Lineweight	Gets or sets the entity line weight, one unit is always 1/100 mm (default = ByLayer). (Inherited from EntityObject)
Normal	Gets or sets the entity normal. (Inherited from EntityObject)
Owner	Gets the owner of the actual DXF object. (Inherited from EntityObject)
Position	Gets or sets the Text position in world coordinates.
Reactors	Gets the list of DXF objects that has been attached to this entity. (Inherited from EntityObject)
RectangleWidth	Gets or sets the text reference rectangle width.
Rotation	Gets or sets the text rotation in degrees.
Style	Gets or sets the text style.
Transparency	Gets or sets layer transparency (default: ByLayer). (Inherited from EntityObject)
Type	Gets the entity type. (Inherited from EntityObject)
Value	Gets or sets the raw text string.
XData	Gets the entity extended data. (Inherited from DxfObject)

Methods

Clone	Creates a new MText that is a copy of the current instance. (Overrides EntityObject.Clone())
EndParagraph	Ends the current paragraph.
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
PlainText	Obtains the MText text value without the formatting codes, control characters like tab '\t' will be preserved in the result, the new paragraph command "\P" will be converted to new line feed '\r\n'.
StartParagraph()	Starts a new paragraph.
StartParagraph(MTextParagraphOptions)	Starts a new paragraph.
ToString	Converts the value of this instance to its equivalent string representation. (Inherited from EntityObject)
TransformBy(Matrix4)	Moves, scales, and/or rotates the current entity given a 4x4 transformation matrix. (Inherited from EntityObject)
TransformBy(Matrix3, Vector3)	Moves, scales, and/or rotates the current entity given a 3x3 transformation matrix and a translation vector. (Overrides EntityObject.TransformBy(Matrix3, Vector3))
Write(String)	Adds the text to the current paragraph.
Write(String, MTextFormattingOptions)	Adds the text to the current paragraph.
WriteFraction(String, String, FractionFormatType)	Formats a text string to represent a fraction.
WriteFraction(String, String, FractionFormatType, MTextFormattingOptions)	Formats a text string to represent a fraction.

Events

LayerChanged	(Inherited from EntityObject)
LinetypeChanged	(Inherited from EntityObject)
TextStyleChanged
XDataAddAppReg	(Inherited from DxfObject)
XDataRemoveAppReg	(Inherited from DxfObject)

See Also

Reference

netDxf.Entities Namespace