Click or drag to resize

TextEntity Class

Represents text geometry.

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

Inheritance Hierarchy

Namespace:  Rhino.Geometry
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
[SerializableAttribute]
public class TextEntity : AnnotationBase

The TextEntity type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleTextEntity
Initializes a new instance of the TextEntity class.
Protected methodTextEntity(SerializationInfo, StreamingContext)
Protected constructor used in serialization
Top
Properties
  NameDescription
Public propertyAlternateDimensionLengthDisplay
Alternate length display units and format
(Inherited from AnnotationBase.)
Public propertyAnnotationType
Type of annotation
(Inherited from AnnotationBase.)
Public propertyAnnotativeScalingEnabled
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
Public propertyDimensionLengthDisplay
Length display units and format
(Inherited from AnnotationBase.)
Public propertyDimensionScale
Gets or sets the dimension scale
(Inherited from AnnotationBase.)
Public propertyDimensionStyle
If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.
(Inherited from AnnotationBase.)
Public propertyDimensionStyleId
Id of this annotation's parent dimstyle If this annotation has overrides to dimstyle properties, those overrides will be represented in the DimensionStyle returned by DimensionStyle(ParentStyle)
(Inherited from AnnotationBase.)
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyDrawForward
Gets or sets whether the text is oriented towards the reader when viewed from behind
(Inherited from AnnotationBase.)
Public propertyFirstCharFont
Returns the font used by the first run of text in an annotation
(Inherited from AnnotationBase.)
Public propertyFont
The base Font for the text of the annotation. The text string is rich text and therefore a different font that the base font can be associated with sub strings of the text
(Inherited from AnnotationBase.)
Public propertyFontIndex
Gets or sets the index of font in document font table used by the text.


In Rhino for Windows 6.6, this member is inherited from AnnotationBaseFontIndex.
Public propertyFormatWidth
Text format width (Wrapping rectangle)
(Inherited from AnnotationBase.)
Public propertyHasBrepForm
Returns true if the Brep.TryConvertBrep function will be successful for this object
(Inherited from GeometryBase.)
Public propertyHasPropertyOverrides
(Inherited from AnnotationBase.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyIndex
Index of DimensionStyle in document DimStyle table used by the dimension.
(Inherited from AnnotationBase.)
Public propertyIsDeformable
true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
(Inherited from GeometryBase.)
Public propertyIsDocumentControlled
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.)
Public propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyCode exampleJustification
Gets or sets the justification of text in relation to its base point.
Public propertyMaskColor
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


In Rhino for Windows 6.6, this member is inherited from AnnotationBaseMaskColor.
Public propertyMaskColorSource
Gets or sets whether the mask background color is from the background or from a color
(Inherited from AnnotationBase.)
Public propertyMaskEnabled
Determines whether or not to draw a Text Mask


In Rhino for Windows 6.6, this member is inherited from AnnotationBaseMaskEnabled.
Public propertyMaskOffset
distance around text to display mask


In Rhino for Windows 6.6, this member is inherited from AnnotationBaseMaskOffset.
Public propertyMaskUsesViewportColor
If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used


In Rhino for Windows 6.6, this member is inherited from AnnotationBaseMaskUsesViewportColor.
Public propertyNumericValue
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.)
Public propertyObjectType
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
(Inherited from GeometryBase.)
Public propertyParentDimensionStyle
The parent dimension style associated with this annotation
(Inherited from AnnotationBase.)
Public propertyPlainText
Text stripped of RTF formatting information
(Inherited from AnnotationBase.)
Public propertyPlane
Plane that this annotation lies on
(Inherited from AnnotationBase.)
Public propertyRichText
Text including additional RTF formatting information
(Inherited from AnnotationBase.)
Public propertyText
Text including additional RTF formatting information
(Inherited from AnnotationBase.)
Public propertyTextFormula
See RichText
(Inherited from AnnotationBase.)
Public propertyTextHasRtfFormatting
(Inherited from AnnotationBase.)
Public propertyTextHeight
AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle
(Inherited from AnnotationBase.)
Public propertyTextHorizontalAlignment
Public propertyTextIsWrapped
Is text wrapping on
(Inherited from AnnotationBase.)
Public propertyTextModelWidth
Width of text in the model
(Inherited from AnnotationBase.)
Public propertyTextOrientation
Public propertyTextRotationDegrees
Rotation of text in degrees
(Inherited from AnnotationBase.)
Public propertyTextRotationRadians
Rotation of text in radians
(Inherited from AnnotationBase.)
Public propertyTextVerticalAlignment
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
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.)
Public propertyUserStringCount
Gets the amount of user strings.
(Inherited from GeometryBase.)
Top
Methods
  NameDescription
Public methodClearPropertyOverrides
Clears all overriden properties for this annotation
(Inherited from AnnotationBase.)
Public methodComponentIndex
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.)
Protected methodConstructConstObject
Assigns a parent object and a subobject index to this.
(Inherited from CommonObject.)
Public methodStatic memberCreate
Create Text geometry or null if input is invalid
Public methodCreateCurves
Returns the outline curves.
Public methodCreateExtrusions
Creates extrusions from the outline curves with specified height.
Public methodCreatePolySurfaces
Creates breps from the outline curves with specified height.
Public methodCreateSurfaces
Creates planar breps from the outline curves.
Public methodStatic memberCreateWithRichText
Create RichText geometry or null if input is invalid
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Protected methodDispose(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.)

In Rhino for Windows, this member is overridden by Dispose(Boolean).
Public methodDuplicate
Constructs a deep (full) copy of this object.
(Inherited from GeometryBase.)
Public methodDuplicateShallow
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.)
Public methodEnsurePrivateCopy
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.)
Public methodEquals (Inherited from Object.)
Public methodExplode
Explodes this text entity into an array of curves.
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.)
Public methodCode exampleGetBoundingBox(Boolean)
Boundingbox solver. Gets the world axis aligned boundingbox for the geometry.
(Inherited from GeometryBase.)
Public methodCode exampleGetBoundingBox(Plane)
Aligned Boundingbox solver. Gets the plane aligned boundingbox.
(Inherited from GeometryBase.)
Public methodGetBoundingBox(Transform)
Aligned Boundingbox solver. Gets the world axis aligned boundingbox for the transformed geometry.
(Inherited from GeometryBase.)
Public methodGetBoundingBox(Plane, Box)
Aligned Boundingbox solver. Gets the plane aligned boundingbox.
(Inherited from GeometryBase.)
Public methodGetDimensionStyle
Return the proper dimension style from which to get properties for this annotation object If this object has style overrides, those will be included in the returned dimension style and the style will be updated to include the current state of the parent style for non-overridden fields
(Inherited from AnnotationBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetTextTransform
Get the transform for this text object's text geometry
Public methodGetType (Inherited from Object.)
Public methodGetUserString
Gets user string from this geometry.
(Inherited from GeometryBase.)
Public methodGetUserStrings
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
(Inherited from GeometryBase.)
Public methodIsPropertyOverridden
Returns true if a property is overridden
(Inherited from AnnotationBase.)
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Public methodMakeDeformable
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.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMemoryEstimate
Computes an estimate of the number of bytes that this object is using in memory.
(Inherited from GeometryBase.)
Protected methodNonConstOperation
For derived classes implementers.

Defines the necessary implementation to free the instance from being const.

(Inherited from CommonObject.)

In Rhino for Windows, this member is overridden by NonConstOperation.
Protected methodOnSwitchToNonConst
Is called when a non-const operation occurs.
(Inherited from GeometryBase.)
Public methodRotate
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.)
Public methodScale
Scales the object by the specified factor. The scale is centered at the origin.
(Inherited from GeometryBase.)
Public methodSetBold
(Inherited from AnnotationBase.)
Public methodSetFacename
(Inherited from AnnotationBase.)
Public methodSetItalic
(Inherited from AnnotationBase.)
Public methodSetOverrideDimStyle
Set a style including overrides for this annotation object. The DimensionStyle OverrideStyle must have the override fields marked as overridden and must have it's Id set to nil. Use DimensinoStyle.SetFieldOverride(Field field) and related functions to manage override settings. To override a field, the field value must be set and the field must be marked as an override. The DimensionStyle passed in here must not be in the dimstyle table
(Inherited from AnnotationBase.)
Public methodSetRichText
(Inherited from AnnotationBase.)
Public methodSetUnderline
(Inherited from AnnotationBase.)
Public methodSetUserString
Attach a user string (key,value combination) to this geometry.
(Inherited from GeometryBase.)
Public methodToString (Inherited from Object.)
Public methodTransform(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.)
Public methodTransform(Transform, DimensionStyle)
Transform the object by a 4x4 transform matrix and change text height override to accommodate scaling in the transform if necessary
Public methodTranslate(Vector3d)
Translates the object along the specified vector.
(Inherited from GeometryBase.)
Public methodTranslate(Double, Double, Double)
Translates the object along the specified vector.
(Inherited from GeometryBase.)
Public methodWrapText
Wrap text
(Inherited from AnnotationBase.)
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.6
See Also