T_Rhino_Geometry_TextEntity

TextEntity Class

Represents text geometry. This class refers to the geometric element that is independent from the document.

Inheritance Hierarchy

System.Object
  Rhino.Runtime.CommonObject
    Rhino.Geometry.GeometryBase
      Rhino.Geometry.AnnotationBase
        Rhino.Geometry.TextEntity
Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

[SerializableAttribute]
public class TextEntity : AnnotationBase

VB

<SerializableAttribute>
Public Class TextEntity
	Inherits AnnotationBase

The TextEntity type exposes the following members.

Constructors

 

	Name	Description
	TextEntity()	Initializes a new instance of the TextEntity class.
	TextEntity(SerializationInfo, StreamingContext)	Protected constructor used in serialization.

  Back to Top

Properties

 

	Name	Description
	AnnotativeScalingEnabled	Scale annotation according to detail scale factor in paperspace or by 1.0 in paperspace and not in a detail Otherwise, dimscale or text scale is used
	FontIndex	Gets or sets the index of font in document font table used by the text.
	HasBrepForm	Returns true if the Brep.TryConvertBrep function will be successful for this object (Inherited from GeometryBase.)
	HasUserData	Gets true if this class has any custom information attached to it through UserData. (Inherited from CommonObject.)
	Index	Index of DimensionStyleV5 in document DimStyle table used by the dimension. (Inherited from AnnotationBase.)
	IsDeformable	true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling. (Inherited from GeometryBase.)
	IsDocumentControlled	If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException. (Inherited from GeometryBase.)
	IsValid	Tests an object to see if it is valid. (Inherited from CommonObject.)
	Justification	Gets or sets the justification of text in relation to its base point.
	MaskColor	Color to use for drawing a text mask when it is enabled. If the mask is enabled and MaskColor is System.Drawing.Color.Transparent, then the viewport's color will be used for the MaskColor
	MaskEnabled	Determines whether or not to draw a Text Mask
	MaskOffset	Offset for the border around text of the rectangle used to draw the mask. This value multiplied by TextHeight is the offset on each side of the tight rectangle around the text characters to the mask rectangle. The default value is 0.1.
	MaskUsesViewportColor	If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used
	NumericValue	Gets the numeric value, depending on geometry type. LinearDimension: distance between arrow tips RadialDimension: radius or diamater depending on type AngularDimension: angle in degrees Leader or Text: UnsetValue (Inherited from AnnotationBase.)
	ObjectType	Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. (Inherited from GeometryBase.)
	Plane	Gets or sets the plane containing the annotation. (Inherited from AnnotationBase.)
	Text	Gets or sets the text for this annotation. (Inherited from AnnotationBase.)
	TextFormula	Gets or sets a formula for this annotation. (Inherited from AnnotationBase.)
	TextHeight	Gets or sets the text height in model units. (Inherited from AnnotationBase.)
	UserData	List of custom information that is attached to this class. (Inherited from CommonObject.)
	UserDictionary	Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information. (Inherited from CommonObject.)
	UserStringCount	Gets the amount of user strings. (Inherited from GeometryBase.)

  Back to Top

Methods

 

	Name	Description
	ComponentIndex	If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index. (Inherited from GeometryBase.)
	ConstructConstObject	Assigns a parent object and a subobject index to this. (Inherited from CommonObject.)
	Dispose()	Actively reclaims unmanaged resources that this instance uses. (Inherited from CommonObject.)
	Dispose(Boolean)	For derived class implementers. This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method. You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. Also, you must call the base virtual method within your overriding method. (Inherited from CommonObject.)
	Duplicate	Constructs a deep (full) copy of this object. (Inherited from GeometryBase.)
	DuplicateShallow	Constructs a light copy of this object. By "light", it is meant that the same underlying data is used until something is done to attempt to change it. For example, you could have a shallow copy of a very heavy mesh object and the same underlying data will be used when doing things like inspecting the number of faces on the mesh. If you modify the location of one of the mesh vertices, the shallow copy will create a full duplicate of the underlying mesh data and the shallow copy will become a deep copy. (Inherited from GeometryBase.)
	EnsurePrivateCopy	If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want. (Inherited from CommonObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Explode	Explodes this text entity into an array of curves.
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Finalize()	Passively reclaims unmanaged resources when the class user did not explicitly call Dispose(). (Inherited from CommonObject.)
	GetBoundingBox(Boolean)	Boundingbox solver. Gets the world axis aligned boundingbox for the geometry. (Inherited from GeometryBase.)
	GetBoundingBox(Plane)	Aligned Boundingbox solver. Gets the plane aligned boundingbox. (Inherited from GeometryBase.)
	GetBoundingBox(Transform)	Aligned Boundingbox solver. Gets the world axis aligned boundingbox for the transformed geometry. (Inherited from GeometryBase.)
	GetBoundingBox(Plane, Box)	Aligned Boundingbox solver. Gets the plane aligned boundingbox. (Inherited from GeometryBase.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. (Inherited from CommonObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUserString	Gets user string from this geometry. (Inherited from GeometryBase.)
	GetUserStrings	Gets a copy of all (user key string, user value string) pairs attached to this geometry. (Inherited from GeometryBase.)
	IsValidWithLog	Determines if an object is valid. Also provides a report on errors if this object happens not to be valid. (Inherited from CommonObject.)
	MakeDeformable	If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling. (Inherited from GeometryBase.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemoryEstimate	Computes an estimate of the number of bytes that this object is using in memory. (Inherited from GeometryBase.)
	NonConstOperation	For derived classes implementers. Defines the necessary implementation to free the instance from being const. (Inherited from CommonObject.)
	OnSwitchToNonConst	Is called when a non-const operation occurs. (Inherited from GeometryBase.)
	Rotate	Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). (Inherited from GeometryBase.)
	Scale	Scales the object by the specified factor. The scale is centered at the origin. (Inherited from GeometryBase.)
	SetUserString	Attach a user string (key,value combination) to this geometry. (Inherited from GeometryBase.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Transform	Transforms the geometry. If the input Transform has a SimilarityType of OrientationReversing, you may want to consider flipping the transformed geometry after calling this function when it makes sense. For example, you may want to call Flip() on a Brep after transforming it. (Inherited from GeometryBase.)
	Translate(Vector3d)	Translates the object along the specified vector. (Inherited from GeometryBase.)
	Translate(Double, Double, Double)	Translates the object along the specified vector. (Inherited from GeometryBase.)

  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace