TextEntity Class

Initializes a new instance of the TextEntity class.

Protected constructor used in serialization

Alternate length display units and format

Type of annotation

Set or get the decimal separator c

Length display units and format

Gets or sets the dimension scale

If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.

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)

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

Gets or sets whether the text is oriented towards the reader when viewed from behind

Gets or sets whether to draw a frame around a text mask

Returns the font used by the first run of text in an annotation

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

Text format width (Wrapping rectangle)

Returns true if the Brep.TryConvertBrep function will be successful for this object

(Inherited from AnnotationBase.)

Gets true if this class has any custom information attached to it through UserData.

true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.

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.

Tests an object to see if it is valid.

Gets or sets the justification of text in relation to its base point.

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

Gets or sets whether the mask background color is from the background or from a color

Determines whether or not to draw a Text Mask

Gets or sets whether to draw a frame around a text mask

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.

If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

The parent dimension style associated with this annotation

Text stripped of RTF formatting information

Text stripped of RTF formatting information and with field expressions intact

Plane that this annotation lies on

Text including additional RTF formatting information

Text including additional RTF formatting information

See RichText

(Inherited from AnnotationBase.)

AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle

Is text wrapping on

Width of text in the model

Rotation of text in degrees

Rotation of text in radians

List of custom information that is attached to this class.

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

Gets the amount of user strings.

Clears all overridden properties for this annotation

If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.

Assigns a parent object and a sub-object index to this.

Create Text geometry or null if input is invalid

Returns the outline curves.

Creates planar curve from text outline curves. Curves are grouped such that each element in the list being returned represents a single character.

Creates extrusions from the outline curves with specified height.

Creates 3d Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.

Creates breps from the outline curves with specified height.

Creates 3d Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.

Creates planar breps from the outline curves.

Creates planar Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.

Create RichText geometry or null if input is invalid

Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical.

Actively reclaims unmanaged resources that this instance uses.

Overridden in order to destroy local display cache information

Constructs a deep (full) copy of this object.

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.

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.

Determines whether the specified object is equal to the current object.

Explodes this text entity into an array of curves.

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

Bounding box solver. Gets the world axis aligned bounding box for the geometry.

Aligned Bounding box solver. Gets the plane aligned bounding box.

Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.

Aligned Bounding box solver. Gets the plane aligned bounding box.

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

Serves as the default hash function.

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Return plain text string for this annotation with field expressions unevaluated.

Get the transform for this text object's text geometry

Gets the Type of the current instance.

Gets user string from this geometry.

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

Returns true if all of the text in the annotation is Bold, otherwise returns false

Returns true if all of the text in the annotation is Italic, otherwise returns false

Returns true if all of the text in the annotation is Underlined, otherwise returns false

Returns true if a property is overridden

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.

Creates a shallow copy of the current Object.

Computes an estimate of the number of bytes that this object is using in memory.

Destroy cache handle

Is called when a non-constant operation occurs.

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).

Replace text within a formatted string

Scales the object by the specified factor. The scale is centered at the origin.

(Inherited from AnnotationBase.)

(Inherited from AnnotationBase.)

(Inherited from AnnotationBase.)

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.)

(Inherited from AnnotationBase.)

Attach a user string (key,value combination) to this geometry.

Create a JSON string representation of this object

Returns a string that represents the current object.

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.

Transform the object by a 4x4 transform matrix and change text height override to accommodate scaling in the transform if necessary

Translates the object along the specified vector.

Translates the object along the specified vector.

Wrap text