Class Text
Inheritance
System.Object
Text
Implements
System.IComparable
System.ICloneable
System.Runtime.Serialization.ISerializable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: CADability.dll
Syntax
[Serializable]
public class Text : IGeoObjectImpl, IGeoObject, ILayer, IStyle, IOctTreeInsertable, IComparable, IFeedBack, ICloneable, IColorDef, ISerializable, IJsonSerialize
Constructors
|
Improve this Doc
View Source
Text()
Declaration
|
Improve this Doc
View Source
Text(SerializationInfo, StreamingContext)
Constructor required by deserialization
Declaration
protected Text(SerializationInfo info, StreamingContext context)
Parameters
| Type |
Name |
Description |
| System.Runtime.Serialization.SerializationInfo |
info |
SerializationInfo
|
| System.Runtime.Serialization.StreamingContext |
context |
StreamingContext
|
Fields
|
Improve this Doc
View Source
Constructor
Declaration
public static Text.ConstructionDelegate Constructor
Field Value
|
Improve this Doc
View Source
OnPaintTo3D
Declaration
public static Text.PaintTo3DDelegate OnPaintTo3D
Field Value
Properties
|
Improve this Doc
View Source
Alignment
Sets or gets the horizontal (or in direction of LineDirection) alignement of the text.
Declaration
public Text.AlignMode Alignment { get; set; }
Property Value
|
Improve this Doc
View Source
Bold
Gets or sets the bold property of the text font.
Declaration
public bool Bold { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
ColorDef
Declaration
public ColorDef ColorDef { get; set; }
Property Value
|
Improve this Doc
View Source
Font
Gets or sets the font used for this text object
Declaration
public string Font { get; set; }
Property Value
| Type |
Description |
| System.String |
|
|
Improve this Doc
View Source
GlyphAngle
Gets or sets the angle of the characters vertical direction in respect to the horizontal direction.
The default value is 90°, different angles create different italic fonts.
Declaration
public Angle GlyphAngle { get; set; }
Property Value
|
Improve this Doc
View Source
GlyphDirection
Gets or sets the direction of the vertical character parts. This direction is usually perpendicular to the
LineDirection, but can be modified to produce italic characters of any angle.
The Italic property in contrary uses the typefont italic capabilities which are more sophisticated.
Declaration
public GeoVector GlyphDirection { get; set; }
Property Value
|
Improve this Doc
View Source
GlyphDirectionKeepSize
Declaration
public GeoVector GlyphDirectionKeepSize { get; set; }
Property Value
|
Improve this Doc
View Source
Italic
Gets or sets the italic property of the text font.
Declaration
public bool Italic { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
LineAlignment
Sets or gets the vertical alignement of the text.
Declaration
public Text.LineAlignMode LineAlignment { get; set; }
Property Value
|
Improve this Doc
View Source
LineDirection
Gets or sets the line direction of the text. Default is XAxis. Setting the line
direction does not modify the GlyphDirection of the text, so you usually will have to change both.
It also affects the aspect ratio of the text, which is defined by the length of the line direction
and the length of the glyph direction. To simply rotate a text better use Modify(ModOp)
with a CADability.ModOp.Rotate(System.Int32,CADability.SweepAngle) rotation.
Declaration
public GeoVector LineDirection { get; set; }
Property Value
|
Improve this Doc
View Source
Location
Gets or sets the location of the text. The value of this point is interpreted according to the values of the
Alignmentand LineAlignment properties.
Declaration
public GeoPoint Location { get; set; }
Property Value
|
Improve this Doc
View Source
PreferredStyle
Declaration
public override Style.EDefaultFor PreferredStyle { get; }
Property Value
Overrides
|
Improve this Doc
View Source
Strikeout
Gets or sets the strikeout property of the text font.
Declaration
public bool Strikeout { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
TextSize
Gets or sets the size of this text object.
Declaration
public double TextSize { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
|
Improve this Doc
View Source
TextString
Gets or sets the text string that is displayed with this object.
Declaration
public string TextString { get; set; }
Property Value
| Type |
Description |
| System.String |
|
|
Improve this Doc
View Source
Underline
Gets or sets the underline property of the text font.
Declaration
public bool Underline { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Methods
|
Improve this Doc
View Source
Clone()
Declaration
public override IGeoObject Clone()
Returns
Overrides
|
Improve this Doc
View Source
Construct()
Declaration
public static Text Construct()
Returns
|
Improve this Doc
View Source
CopyGeometry(IGeoObject)
Declaration
public override void CopyGeometry(IGeoObject ToCopyFrom)
Parameters
Overrides
|
Improve this Doc
View Source
GetAttributeProperties(IFrame)
Declaration
public override IShowProperty[] GetAttributeProperties(IFrame Frame)
Parameters
| Type |
Name |
Description |
| IFrame |
Frame |
|
Returns
Overrides
|
Improve this Doc
View Source
GetBoundingCube()
Declaration
public override BoundingCube GetBoundingCube()
Returns
Overrides
|
Improve this Doc
View Source
GetCenterline()
Declaration
public virtual GeoObjectList GetCenterline()
Returns
|
Improve this Doc
View Source
GetExtent(Projection, ExtentPrecision)
Declaration
public override BoundingRect GetExtent(Projection projection, ExtentPrecision extentPrecision)
Parameters
Returns
Overrides
|
Improve this Doc
View Source
GetExtent(Double)
Declaration
public override BoundingCube GetExtent(double precision)
Parameters
| Type |
Name |
Description |
| System.Double |
precision |
|
Returns
Overrides
|
Improve this Doc
View Source
GetObjectData(SerializationInfo, StreamingContext)
Implements System.Runtime.Serialization.ISerializable.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)
Declaration
public override void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
| Type |
Name |
Description |
| System.Runtime.Serialization.SerializationInfo |
info |
The System.Runtime.Serialization.SerializationInfo to populate with data.
|
| System.Runtime.Serialization.StreamingContext |
context |
The destination (System.Runtime.Serialization.StreamingContext) for this serialization.
|
Overrides
|
Improve this Doc
View Source
GetOutline()
Returns a list of objects that define the outline (and holes) of this text. The global setting "Font.Precision"
defines the precision of the outline, if the precision is 3 (fine) then splines can occur in the outline.
If the precision is 1 or 2 (raw, middle) the splines are approximated.
Declaration
public virtual GeoObjectList GetOutline()
Returns
| Type |
Description |
| GeoObjectList |
List of curves describing the outline of this text object
|
|
Improve this Doc
View Source
GetQuadTreeItem(Projection, ExtentPrecision)
Declaration
public override IQuadTreeInsertableZ GetQuadTreeItem(Projection projection, ExtentPrecision extentPrecision)
Parameters
Returns
Overrides
|
Improve this Doc
View Source
GetShapes()
Returns the shapes of all characters of this text. The characters are appropriatly spaced, but the text size and glyphdirection is not taken into account
Declaration
public CompoundShape[] GetShapes()
Returns
|
Improve this Doc
View Source
GetShowProperties(IFrame)
Declaration
public override IShowProperty GetShowProperties(IFrame Frame)
Parameters
| Type |
Name |
Description |
| IFrame |
Frame |
|
Returns
Overrides
|
Improve this Doc
View Source
HitTest(ref BoundingCube, Double)
Declaration
public override bool HitTest(ref BoundingCube cube, double precision)
Parameters
| Type |
Name |
Description |
| BoundingCube |
cube |
|
| System.Double |
precision |
|
Returns
| Type |
Description |
| System.Boolean |
|
Overrides
|
Improve this Doc
View Source
HitTest(Projection, BoundingRect, Boolean)
Declaration
public override bool HitTest(Projection projection, BoundingRect rect, bool onlyInside)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Overrides
|
Improve this Doc
View Source
HitTest(Projection.PickArea, Boolean)
Declaration
public override bool HitTest(Projection.PickArea area, bool onlyInside)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Overrides
|
Improve this Doc
View Source
Modify(ModOp)
Declaration
public override void Modify(ModOp m)
Parameters
| Type |
Name |
Description |
| ModOp |
m |
|
Overrides
|
Improve this Doc
View Source
PaintTo3D(IPaintTo3D)
Declaration
public override void PaintTo3D(IPaintTo3D paintTo3D)
Parameters
Overrides
|
Improve this Doc
View Source
PaintTo3DList(IPaintTo3D, ICategorizedDislayLists)
Declaration
public override void PaintTo3DList(IPaintTo3D paintTo3D, ICategorizedDislayLists lists)
Parameters
Overrides
|
Improve this Doc
View Source
Position(GeoPoint, GeoVector, Double)
Declaration
public override double Position(GeoPoint fromHere, GeoVector direction, double precision)
Parameters
Returns
| Type |
Description |
| System.Double |
|
Overrides
|
Improve this Doc
View Source
PrePaintTo3D(IPaintTo3D)
Declaration
public override void PrePaintTo3D(IPaintTo3D paintTo3D)
Parameters
Overrides
|
Improve this Doc
View Source
PrepareDisplayList(Double)
Declaration
public override void PrepareDisplayList(double precision)
Parameters
| Type |
Name |
Description |
| System.Double |
precision |
|
Overrides
|
Improve this Doc
View Source
SetBounds(GeoPoint, GeoPoint, GeoPoint)
Modifies the direction, size and aspect ratio of the text so that the text will fit
inside the parallelogram defined by the provided parameters.
Declaration
public void SetBounds(GeoPoint ll, GeoPoint lr, GeoPoint ul)
Parameters
| Type |
Name |
Description |
| GeoPoint |
ll |
Point for the lower left position of the text
|
| GeoPoint |
lr |
Point for the lower right position of the text
|
| GeoPoint |
ul |
Point for the upper left position of the text
|
|
Improve this Doc
View Source
SetDirections(GeoVector, GeoVector)
Declaration
public void SetDirections(GeoVector lineDirection, GeoVector glyphDirection)
Parameters
|
Improve this Doc
View Source
SetLineDirKeepGlyphAngle(GeoVector)
Declaration
public void SetLineDirKeepGlyphAngle(GeoVector ld)
Parameters
Explicit Interface Implementations
|
Improve this Doc
View Source
IColorDef.SetTopLevel(ColorDef)
Declaration
void IColorDef.SetTopLevel(ColorDef newValue)
Parameters
|
Improve this Doc
View Source
IColorDef.SetTopLevel(ColorDef, Boolean)
Declaration
void IColorDef.SetTopLevel(ColorDef newValue, bool overwriteChildNullColor)
Parameters
| Type |
Name |
Description |
| ColorDef |
newValue |
|
| System.Boolean |
overwriteChildNullColor |
|
|
Improve this Doc
View Source
IJsonSerialize.GetObjectData(IJsonWriteData)
Declaration
void IJsonSerialize.GetObjectData(IJsonWriteData data)
Parameters
|
Improve this Doc
View Source
IJsonSerialize.SetObjectData(IJsonReadData)
Declaration
void IJsonSerialize.SetObjectData(IJsonReadData data)
Parameters
Implements
System.IComparable
System.ICloneable
System.Runtime.Serialization.ISerializable