DXFReaderNETControlAddText Method
|
Adds a new text to the current drawing.
Namespace:
DXFReaderNET
Assembly:
DXFReaderNET (in DXFReaderNET.dll) Version: 20.10.54
Syntax public EntityObject AddText(
string Text,
Vector3 Position,
Vector3 AlignmentPoint,
double Height = 2,5,
double Rotation = 0,
TextAlignment TextAlignment = TextAlignment.BaselineLeft,
string StyleName = "",
short ACIColor = 256,
string LayerName = "",
string LineTypeName = ""
)
Public Function AddText (
Text As String,
Position As Vector3,
AlignmentPoint As Vector3,
Optional Height As Double = 2,5,
Optional Rotation As Double = 0,
Optional TextAlignment As TextAlignment = TextAlignment.BaselineLeft,
Optional StyleName As String = "",
Optional ACIColor As Short = 256,
Optional LayerName As String = "",
Optional LineTypeName As String = ""
) As EntityObject
public:
EntityObject^ AddText(
String^ Text,
Vector3 Position,
Vector3 AlignmentPoint,
double Height = 2,5,
double Rotation = 0,
TextAlignment TextAlignment = TextAlignment::BaselineLeft,
String^ StyleName = L"",
short ACIColor = 256,
String^ LayerName = L"",
String^ LineTypeName = L""
)
member AddText :
Text : string *
Position : Vector3 *
AlignmentPoint : Vector3 *
?Height : float *
?Rotation : float *
?TextAlignment : TextAlignment *
?StyleName : string *
?ACIColor : int16 *
?LayerName : string *
?LineTypeName : string
(* Defaults:
let _Height = defaultArg Height 2,5
let _Rotation = defaultArg Rotation 0
let _TextAlignment = defaultArg TextAlignment TextAlignment.BaselineLeft
let _StyleName = defaultArg StyleName ""
let _ACIColor = defaultArg ACIColor 256
let _LayerName = defaultArg LayerName ""
let _LineTypeName = defaultArg LineTypeName ""
*)
-> EntityObject
METHOD AddText(
Text AS STRING,
Position AS Vector3,
AlignmentPoint AS Vector3,
Height AS REAL8 := 2,5,
Rotation AS REAL8 := 0,
TextAlignment AS TextAlignment := TextAlignment.BaselineLeft,
StyleName AS STRING := "",
ACIColor AS SHORT := 256,
LayerName AS STRING := "",
LineTypeName AS STRING := ""
) AS EntityObject
Parameters
- Text
- Type: SystemString
The text value. - Position
- Type: DXFReaderNETVector3
The position of the text. - AlignmentPoint
- Type: DXFReaderNETVector3
The secon alignmentpoint of the text. Optional, this value is meaningful only Alignment = Fit or Alignment = Aligned. - Height (Optional)
- Type: SystemDouble
The text heigh in drawing's units (Default value = 2.5). - Rotation (Optional)
- Type: SystemDouble
The text rotation in degree (Default value = 0). - TextAlignment (Optional)
- Type: DXFReaderNET.EntitiesTextAlignment
The text alignment (Default value = TextAlignment.BaselineLef). - StyleName (Optional)
- Type: SystemString
The text style name. If omitted the CurrentTextStyle will be used. - ACIColor (Optional)
- Type: SystemInt16
A number for 0 to 256 corresponding to the AutoCAD Color Index (0 = ByBlock; 256 = ByLayer. Default value = 256). - LayerName (Optional)
- Type: SystemString
The layer name. If omitted, or layername doesn't exist, the CurrentLayer will be used. - LineTypeName (Optional)
- Type: SystemString
The linetype name. If omitted, or linetype doesn't exist, the CurrentLineTypeName will be used.
Return Value
Type:
EntityObjectThe new added
TextS.
Remarks The entity is added to the active layout.
See Also