Properties_T_Rhino_Geometry_TextEntity - mcneel/rhinocommon-api-docs GitHub Wiki

TextEntity Properties

The TextEntity type exposes the following members.

Properties

 

Name Description
Public property 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
Public property FontIndex Gets or sets the index of font in document font table used by the text.
Public property HasBrepForm Returns true if the Brep.TryConvertBrep function will be successful for this object (Inherited from GeometryBase.)
Public property HasUserData Gets true if this class has any custom information attached to it through UserData. (Inherited from CommonObject.)
Public property Index Index of DimensionStyleV5 in document DimStyle table used by the dimension. (Inherited from AnnotationBase.)
Public property IsDeformable true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling. (Inherited from GeometryBase.)
Public property 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.)
Public property IsValid Tests an object to see if it is valid. (Inherited from CommonObject.)
Public propertyCode example Justification Gets or sets the justification of text in relation to its base point.
Public property 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
Public property MaskEnabled Determines whether or not to draw a Text Mask
Public property 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.
Public property MaskUsesViewportColor If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used
Public property 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.)

Public property ObjectType Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. (Inherited from GeometryBase.)
Public property Plane Gets or sets the plane containing the annotation. (Inherited from AnnotationBase.)
Public propertyCode example Text Gets or sets the text for this annotation. (Inherited from AnnotationBase.)
Public property TextFormula Gets or sets a formula for this annotation. (Inherited from AnnotationBase.)
Public property TextHeight Gets or sets the text height in model units. (Inherited from AnnotationBase.)
Public property UserData List of custom information that is attached to this class. (Inherited from CommonObject.)
Public property 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.)
Public property UserStringCount Gets the amount of user strings. (Inherited from GeometryBase.)
  Back to Top

See Also

Reference

TextEntity Class
Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️