Constructors
TextEntity
#Protected constructor used in serialization
Parameters:
| info (SerializationInfo) | Serialization data |
| context (StreamingContext) | Serialization stream |
Properties
AlternateDimensionLengthDisplay
Alternate length display units and format
DimensionLengthDisplay
Length display units and format
DimensionStyle
If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.
DimensionStyleId
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)
Disposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
DrawForward
Gets or sets whether the text is oriented towards the reader when viewed from behind
DrawTextFrame
obsoleteDo not use setter as the MaskFrame is an enum. Use MaskFrame property instead
Gets or sets whether to draw a frame around a text mask
FirstCharFont
Returns the font used by the first run of text in an annotation
Font
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
FontIndex
obsoleteUse Font property instead. Ex: textEntity.Font = Rhino.DocObjects.Font.FromQuartetProperties("Arial", false, false);
Obsolete; use Font property instead
HasBrepForm
Returns true if the Brep.TryConvertBrep function will be successful for this object
HasPropertyOverrides
HasUserData
Gets true if this class has any custom information attached to it through UserData.
IsDeformable
true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
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.
Overrides: CommonObject.IsDocumentControlled
IsShallowDuplicate
Is this instance a 'shallow copy'. Shallow copies are no different than regular instances with the exception that they will convert to complete independent 'deep' copies if a non const operation is perform on the instance (something that mutates the internal data)
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
MaskColorSource
Gets or sets whether the mask background color is from the background or from a color
MaskFrame
Gets or sets whether to draw a frame around 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
ObjectType
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
ParentDimensionStyle
The parent dimension style associated with this annotation
PlainTextWithFields
Text stripped of RTF formatting information and with field expressions intact
Text
obsoleteUse RichText or PlainText
Text including additional RTF formatting information
TextHasRtfFormatting
Gets a value indicating whether the annotation's text is formatted as RTF (Rich Text Format). Returns true if the text begins with an RTF header; otherwise, false.
TextHeight
AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle
UseKerning
Use kerning data in font to set distances between glyphs
UserData
List of custom information that is attached to this class.
UserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.
Methods
ClearPropertyOverrides
Clears all overridden properties for this annotation
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.
Returns: This object's component index. If this object is not a sub-piece of a larger geometric entity, then the returned index has m_type = ComponentIndex.InvalidType and m_index = -1.
ConstructConstObject
Assigns a parent object and a sub-object index to this.
public static TextEntity Create(string text, Plane plane, DimensionStyle style, bool wrapped, double rectWidth, double rotationRadians)
Create Text geometry or null if input is invalid
[ConstOperation]
public Curve[] CreateCurves(DimensionStyle dimstyle, bool allowOpen, bool makeSmallCaps, double smallCapsScale, double spacing)
Returns the outline curves.
Parameters:
| dimstyle (DimensionStyle) | |
| allowOpen (bool) | Set to true to prevent forced closing of open curves retrieved from glyphs. |
| makeSmallCaps (bool) | Set to create small caps out of lower case letters. |
| smallCapsScale (double) | If makeSmallCaps is true, this will be the scale factor for small caps. |
| spacing (double) | Set to add additional spacing between glyph output. |
Returns: An array of curves that forms the outline or content of this text entity.
[ConstOperation]
public Curve[] CreateCurves(DimensionStyle dimstyle, bool allowOpen, double smallCapsScale = 1, double spacing = 0)
Returns the outline curves.
Parameters:
| dimstyle (DimensionStyle) | |
| allowOpen (bool) | Set to true to prevent forced closing of open curves retrieved from glyphs. |
| smallCapsScale (double = 1) | Set to create small caps out of lower case letters. |
| spacing (double = 0) | Set to add additional spacing between glyph output. |
Returns: An array of curves that forms the outline or content of this text entity.
public List<Curve[]> CreateCurvesGrouped(DimensionStyle dimstyle, bool allowOpen, bool makeSmallCaps, double smallCapsScale, double spacing)
Creates planar curve from text outline curves. Curves are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| allowOpen (bool) | Set to true to prevent forced closing of open curves retrieved from glyphs. |
| makeSmallCaps (bool) | |
| smallCapsScale (double) | |
| spacing (double) |
public List<Curve[]> CreateCurvesGrouped(DimensionStyle dimstyle, bool allowOpen, double smallCapsScale, double spacing)
Creates planar curve from text outline curves. Curves are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| allowOpen (bool) | Set to true to prevent forced closing of open curves retrieved from glyphs. |
| smallCapsScale (double) | |
| spacing (double) |
[ConstOperation]
public Extrusion[] CreateExtrusions(DimensionStyle dimstyle, double height, bool makeSmallCaps, double smallCapsScale, double spacing)
Creates extrusions from the outline curves with specified height.
Parameters:
| dimstyle (DimensionStyle) | |
| height (double) | Height in direction perpendicular to plane of text. |
| makeSmallCaps (bool) | Set to true to create small caps out of lower case letters. |
| smallCapsScale (double) | Set to create small caps out of lower case letters. |
| spacing (double) | Set to add additional spacing between glyph output. |
Returns: An array of planar breps.
[ConstOperation]
public Extrusion[] CreateExtrusions(DimensionStyle dimstyle, double height, double smallCapsScale = 1, double spacing = 0)
Creates extrusions from the outline curves with specified height.
Parameters:
| dimstyle (DimensionStyle) | |
| height (double) | Height in direction perpendicular to plane of text. |
| smallCapsScale (double = 1) | Set to create small caps out of lower case letters. |
| spacing (double = 0) | Set to add additional spacing between glyph output. |
Returns: An array of planar breps.
[ConstOperation]
public List<Extrusion[]> CreateExtrusionsGrouped(DimensionStyle dimstyle, bool makeSmallCaps, double smallCapsScale, double height, double spacing)
Creates 3d Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| makeSmallCaps (bool) | |
| smallCapsScale (double) | |
| height (double) | |
| spacing (double) |
[ConstOperation]
public List<Extrusion[]> CreateExtrusionsGrouped(DimensionStyle dimstyle, double smallCapsScale, double height, double spacing)
Creates 3d Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| smallCapsScale (double) | |
| height (double) | |
| spacing (double) |
[ConstOperation]
public Brep[] CreatePolySurfaces(DimensionStyle dimstyle, double height, bool makeSmallCaps, double smallCapsScale, double spacing)
Creates breps from the outline curves with specified height.
Parameters:
| dimstyle (DimensionStyle) | |
| height (double) | Height in direction perpendicular to plane of text. |
| makeSmallCaps (bool) | Set to true to create small caps out of lower case letters. |
| smallCapsScale (double) | Set to create small caps out of lower case letters. |
| spacing (double) | Set to add additional spacing between glyph output. |
Returns: An array of planar breps.
[ConstOperation]
public Brep[] CreatePolySurfaces(DimensionStyle dimstyle, double height, double smallCapsScale = 1, double spacing = 0)
Creates breps from the outline curves with specified height.
Parameters:
| dimstyle (DimensionStyle) | |
| height (double) | Height in direction perpendicular to plane of text. |
| smallCapsScale (double = 1) | Set to create small caps out of lower case letters. |
| spacing (double = 0) | Set to add additional spacing between glyph output. |
Returns: An array of planar breps.
[ConstOperation]
public List<Brep[]> CreatePolysurfacesGrouped(DimensionStyle dimstyle, bool makeSmallCaps, double smallCapsScale, double height, double spacing)
Creates 3d Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| makeSmallCaps (bool) | |
| smallCapsScale (double) | |
| height (double) | |
| spacing (double) |
[ConstOperation]
public List<Brep[]> CreatePolysurfacesGrouped(DimensionStyle dimstyle, double smallCapsScale, double height, double spacing)
Creates 3d Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| smallCapsScale (double) | |
| height (double) | |
| spacing (double) |
[ConstOperation]
public Brep[] CreateSurfaces(DimensionStyle dimstyle, bool makeSmallCaps, double smallCapsScale, double spacing)
Creates planar breps from the outline curves.
Parameters:
| dimstyle (DimensionStyle) | |
| makeSmallCaps (bool) | Set to true to create small caps out of lower case letters. |
| smallCapsScale (double) | Set to create small caps out of lower case letters. |
| spacing (double) | Set to add additional spacing between glyph output. |
Returns: An array of planar breps.
[ConstOperation]
public Brep[] CreateSurfaces(DimensionStyle dimstyle, double smallCapsScale = 1, double spacing = 0)
Creates planar breps from the outline curves.
Parameters:
| dimstyle (DimensionStyle) | |
| smallCapsScale (double = 1) | Set to create small caps out of lower case letters. |
| spacing (double = 0) | Set to add additional spacing between glyph output. |
Returns: An array of planar breps.
[ConstOperation]
public List<Brep[]> CreateSurfacesGrouped(DimensionStyle dimstyle, bool makeSmallCaps, double smallCapsScale, double spacing)
Creates planar Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| makeSmallCaps (bool) | |
| smallCapsScale (double) | |
| spacing (double) |
[ConstOperation]
public List<Brep[]> CreateSurfacesGrouped(DimensionStyle dimstyle, double smallCapsScale, double spacing)
Creates planar Breps from text outline curves. Breps are grouped such that each element in the list being returned represents a single character.
Parameters:
| dimstyle (DimensionStyle) | |
| smallCapsScale (double) | |
| spacing (double) |
public static TextEntity CreateWithRichText(string richTextString, Plane plane, DimensionStyle style, bool wrapped, double rectWidth, double rotationRadians)
Create RichText geometry or null if input is invalid
DataCRC
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.
Parameters:
| currentRemainder (uint) | The current remainder value. |
Returns: CRC of the information the defines the object.
DeleteAllUserStrings
public void DeleteAllUserStrings()
Parameters:
| key (string) |
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
Dispose
Overridden in order to destroy local display cache information
Parameters:
| disposing (bool) |
Overrides: CommonObject.Dispose
Returns: An object of the same type as this, with the same properties and behavior.
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.
Returns: An object of the same type as this object.
This behavior is overridden by implementing classes.
EnsurePrivateCopy
public void 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.
Explodes this text entity into an array of curves.
Returns: An array of curves that forms the outline or content of this text entity.
GetBoundingBox
Bounding box solver. Gets the world axis aligned bounding box for the geometry.
Parameters:
| accurate (bool) | If true, a physically accurate bounding box will be computed. If not, a bounding box estimate will be computed. For some geometry types there is no difference between the estimate and the accurate bounding box. Estimated bounding boxes can be computed much (much) faster than accurate (or "tight") bounding boxes. Estimated bounding boxes are always similar to or larger than accurate bounding boxes. |
Returns: The bounding box of the geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.
GetBoundingBox
Aligned Bounding box solver. Gets the plane aligned bounding box.
GetBoundingBox
Aligned Bounding box solver. Gets the plane aligned bounding box.
Parameters:
| plane (Plane) | Orientation plane for BoundingBox. |
Returns: A BoundingBox in plane coordinates.
GetBoundingBox
Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
Parameters:
| xform (Transform) | Transformation to apply to bounding box after calculation. The geometry is not modified. |
Returns: The bounding box of the transformed geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.
Overrides: GeometryBase.GetBoundingBox
GetDimensionStyle
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
Parameters:
| parentDimStyle (DimensionStyle) |
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
GetPlainTextWithRunMap
Return plain text string for this annotation with field expressions unevaluated.
Parameters:
| map (ref int[]) | an array of int values in groups of 3: run index, character start position, and length. |
Returns: A plain text string.
Get the transform for this text object's text geometry
Parameters:
| textscale (double) | |
| dimstyle (DimensionStyle) |
[ConstOperation]
public Transform GetTextTransform(ViewportInfo viewport, double textscale, DimensionStyle dimstyle)
Get the transform for this text object's text geometry as it is drawn in a particular viewport. Unlike the parameterless-viewport overload, this honors the dimension style's TextOrientation (for example "Horizontal to view") and DrawForward, orienting the text against the viewport exactly as the display pipeline does. Use this when previewing text so the preview matches how the placed object will be drawn.
Parameters:
| viewport (ViewportInfo) | Viewport the text is being drawn in. |
| textscale (double) | Scale to apply to the text. |
| dimstyle (DimensionStyle) | The text's dimension style. |
Parameters:
| key (string) | id used to retrieve the string. |
Returns: string associated with the key if successful. null if no key was found.
GetUserStrings
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Returns: A new collection.
IsAllBold
Returns true if all of the text in the annotation is Bold, otherwise returns false
IsAllItalic
Returns true if all of the text in the annotation is Italic, otherwise returns false
IsAllUnderlined
Returns true if all of the text in the annotation is Underlined, otherwise returns false
IsPropertyOverridden
Returns true if a property is overridden
Parameters:
| field (DimensionStyle.Field) |
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: true if this object is valid; false otherwise.
MakeDeformable
If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
Returns: false if object cannot be converted to a deformable object. true if object was already deformable or was converted into a deformable object.
MemoryEstimate
Computes an estimate of the number of bytes that this object is using in memory.
Returns: An estimated memory footprint.
NonConstOperation
protected override void NonConstOperation()
Destroy cache handle
Overrides: CommonObject.NonConstOperation
OnSwitchToNonConst
protected override void OnSwitchToNonConst()
Is called when a non-constant operation occurs.
Overrides: CommonObject.OnSwitchToNonConst
Rotate
Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
Scale
Scales the object by the specified factor. The scale is centered at the origin.
Parameters:
| scaleFactor (double) | The uniform scaling factor. |
Returns: true if geometry successfully scaled.
Parameters:
| set_on (bool) |
Parameters:
| set_on (bool) |
SetOverrideDimStyle
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 DimensionStyle.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
Parameters:
| OverrideStyle (DimensionStyle) |
SetRichText
Sets the annotation's text as rich text (RTF), optionally using a specified dimension style for formatting overrides.
Parameters:
| rtfText (string) | The RTF (Rich Text Format) string to assign to the annotation. |
| dimstyle (DimensionStyle) | The dimension style to use for formatting overrides, or null to use the current style. |
Parameters:
| set_on (bool) |
SetUserString
Attach a user string (key,value combination) to this geometry.
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |
Transform the object by a 4x4 transform matrix and change text height override to accommodate scaling in the transform if necessary
Parameters:
| transform (Transform) | An Transform with the transformation information |
| style (DimensionStyle) |
Returns: Returns true on success otherwise returns false.
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.
Parameters:
| xform (Transform) | Transformation to apply to geometry. |
Returns: true if geometry successfully transformed.
Translate
Translates the object along the specified vector.
Translate
Translates the object along the specified vector.
Parameters:
| translationVector (Vector3d) | A moving vector. |
Returns: true if geometry successfully translated.
WrapText
public void WrapText()
Wrap text