Leader geometry class

Constructors

Leader

#Since v6.0
Constructor
public Leader()

Leader

#
Protected serialization constructor for internal use.
protected Leader(
info,
Serialization data.
context
Serialization stream.
)

Properties

AlternateDimensionLengthDisplay

Alternate length display units and format
public DimensionStyle.LengthDisplay AlternateDimensionLengthDisplay { get; set; }
inherited fromAnnotationBase

AnnotationType

Type of annotation
public virtual AnnotationType AnnotationType { get; }
inherited fromAnnotationBase

Curve

#Since v6.0
Gets the curve used by this leader
public NurbsCurve Curve { get; }

DecimalSeparator

Set or get the decimal separator c
public char DecimalSeparator { get; set; }
inherited fromAnnotationBase

DimensionLengthDisplay

Length display units and format
public DimensionStyle.LengthDisplay DimensionLengthDisplay { get; set; }
inherited fromAnnotationBase

DimensionScale

Gets or sets the dimension scale
public double DimensionScale { get; set; }
inherited fromAnnotationBase

DimensionStyle

If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.
public DimensionStyle DimensionStyle { get; }
inherited fromAnnotationBase

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)
public Guid DimensionStyleId { get; set; }
inherited fromAnnotationBase

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.
public bool Disposed { get; }
inherited fromCommonObject

DrawForward

Gets or sets whether the text is oriented towards the reader when viewed from behind
public bool DrawForward { get; set; }
inherited fromAnnotationBase

DrawTextFrame

Gets or sets whether to draw a frame around a text mask
public bool DrawTextFrame { get; set; }
obsoleteDo not use setter as the MaskFrame is an enum. Use MaskFrame property instead
inherited fromAnnotationBase

FirstCharFont

Returns the font used by the first run of text in an annotation
public Font FirstCharFont { get; }
inherited fromAnnotationBase

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
public Font Font { get; set; }
inherited fromAnnotationBase

FontIndex

Obsolete; use Font property instead
[EditorBrowsable(EditorBrowsableState.Never)] public int FontIndex { get; set; }
obsoleteUse Font property instead. Ex: textEntity.Font = Rhino.DocObjects.Font.FromQuartetProperties("Arial", false, false);
inherited fromAnnotationBase

FormatWidth

Text format width (Wrapping rectangle)
public double FormatWidth { get; set; }
inherited fromAnnotationBase

HasBrepForm

Returns true if the Brep.TryConvertBrep function will be successful for this object
public bool HasBrepForm { get; }
inherited fromGeometryBase

HasPropertyOverrides

public bool HasPropertyOverrides { get; }
inherited fromAnnotationBase

HasUserData

Gets true if this class has any custom information attached to it through UserData.
public bool HasUserData { get; }
inherited fromCommonObject

IsDeformable

true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
public bool IsDeformable { get; }
inherited fromGeometryBase

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.
public sealed override bool IsDocumentControlled { get; }
inherited fromGeometryBase

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)
public bool IsShallowDuplicate { get; }
inherited fromGeometryBase

IsValid

Tests an object to see if it is valid.
public virtual bool IsValid { get; }
inherited fromCommonObject

LeaderArrowBlockId

#Since v6.0
Id of the block used as the arrow for the leader when the arrow type is 'User arrow'
public Guid LeaderArrowBlockId { get; set; }

LeaderArrowSize

#Since v6.0
The size of the leader arrow
public double LeaderArrowSize { get; set; }

LeaderArrowType

#Since v6.0
The arrowhead type for the leader
public DimensionStyle.ArrowType LeaderArrowType { get; set; }

LeaderContentAngleStyle

#Since v6.0
Angle for text of leader text
public DimensionStyle.LeaderContentAngleStyle LeaderContentAngleStyle { get; set; }

LeaderCurveStyle

#Since v6.0
The style of the leader curve: polyline or spline
public DimensionStyle.LeaderCurveStyle LeaderCurveStyle { get; set; }

LeaderHasLanding

#Since v6.0
Returns true if the leader has a landing line
public bool LeaderHasLanding { get; set; }

LeaderLandingLength

#Since v6.0
Gets or sets the length of the landing line
public double LeaderLandingLength { get; set; }

LeaderTextHorizontalAlignment

#Since v6.0
Gets or sets the horizontal alignment of the leader's text
public TextHorizontalAlignment LeaderTextHorizontalAlignment { get; set; }

LeaderTextVerticalAlignment

#Since v6.0
Gets or sets the vertical alignment of the leader's text
public TextVerticalAlignment LeaderTextVerticalAlignment { get; set; }

LineSpaceScale

Scale applied to line spacing
public double LineSpaceScale { get; set; }
inherited fromAnnotationBase

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 Color MaskColor { get; set; }
inherited fromAnnotationBase

MaskColorSource

Gets or sets whether the mask background color is from the background or from a color
public DimensionStyle.MaskType MaskColorSource { get; set; }
inherited fromAnnotationBase

MaskEnabled

Determines whether or not to draw a Text Mask
public bool MaskEnabled { get; set; }
inherited fromAnnotationBase

MaskFrame

Gets or sets whether to draw a frame around a text mask
public DimensionStyle.MaskFrame MaskFrame { get; set; }
inherited fromAnnotationBase

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 double MaskOffset { get; set; }
inherited fromAnnotationBase

MaskUsesViewportColor

If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used
public bool MaskUsesViewportColor { get; set; }
inherited fromAnnotationBase

ObjectType

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
[CLSCompliant(false)] public ObjectType ObjectType { get; }
inherited fromGeometryBase

ParentDimensionStyle

The parent dimension style associated with this annotation
public DimensionStyle ParentDimensionStyle { get; set; }
inherited fromAnnotationBase

PlainText

Text stripped of RTF formatting information
public string PlainText { get; set; }
inherited fromAnnotationBase

PlainTextWithFields

Text stripped of RTF formatting information and with field expressions intact
public string PlainTextWithFields { get; }
inherited fromAnnotationBase

Plane

Plane that this annotation lies on
public Plane Plane { get; set; }
inherited fromAnnotationBase

Points2D

#Since v6.0
Get or set the 2d points defining the curve used by this leader
public Point2d[] Points2D { get; set; }

Points3D

#Since v6.0
Get or set the 3d points defining the curve used by this leader
public Point3d[] Points3D { get; set; }

RichText

Text including additional RTF formatting information
public string RichText { get; set; }
inherited fromAnnotationBase

Text

Text including additional RTF formatting information
public string Text { get; set; }
obsoleteUse RichText or PlainText
inherited fromAnnotationBase

TextFormula

See RichText
public string TextFormula { get; set; }
obsoleteUse RichText
inherited fromAnnotationBase

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.
public bool TextHasRtfFormatting { get; }
inherited fromAnnotationBase

TextHeight

AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle
public double TextHeight { get; set; }
inherited fromAnnotationBase

TextIsWrapped

Is text wrapping on
public bool TextIsWrapped { get; set; }
inherited fromAnnotationBase

TextModelWidth

Width of text in the model
public double TextModelWidth { get; }
inherited fromAnnotationBase

TextRotationDegrees

Rotation of text in degrees
public double TextRotationDegrees { get; set; }
inherited fromAnnotationBase

TextRotationRadians

Rotation of text in radians
public double TextRotationRadians { get; set; }
inherited fromAnnotationBase

UseKerning

Use kerning data in font to set distances between glyphs
public bool UseKerning { get; set; }
inherited fromAnnotationBase

UserData

List of custom information that is attached to this class.
public UserDataList UserData { get; }
inherited fromCommonObject

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.
public ArchivableDictionary UserDictionary { get; }
inherited fromCommonObject

UserStringCount

Gets the amount of user strings.
public int UserStringCount { get; }
inherited fromGeometryBase

Methods

ClearPropertyOverrides

Clears all overridden properties for this annotation
public bool ClearPropertyOverrides()
inherited fromAnnotationBase

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.
[ConstOperation] public ComponentIndex ComponentIndex()
inherited fromGeometryBase
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.
protected void ConstructConstObject(
parentObject,
The parent object.
subobjectIndex
The sub-object index.
)
inherited fromCommonObject

Create

#Since v6.0
Creates a Leader geometry object
public static Leader Create(
text,
plane,
dimstyle,
points
)

CreateWithRichText

#Since v6.0
Creates a Leader geometry object
public static Leader CreateWithRichText(
richText,
plane,
dimstyle,
points
)

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.
[CLSCompliant(false)] public uint DataCRC(
currentRemainder
The current remainder value.
)
inherited fromGeometryBase
CRC of the information the defines the object.

DeleteAllUserStrings

public void DeleteAllUserStrings()
inherited fromGeometryBase

DeleteUserString

public bool DeleteUserString(
key
)
inherited fromGeometryBase

Dispose

Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
inherited fromCommonObject

Dispose

Overridden in order to destroy local display cache information
protected override void Dispose(
disposing
)
inherited fromGeometryBase

Duplicate

Constructs a deep (full) copy of this object.
public virtual GeometryBase Duplicate()
inherited fromGeometryBase
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.
public GeometryBase DuplicateShallow()
inherited fromGeometryBase
An object of the same type as this object.

This behavior is overridden by implementing classes.

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.
public void EnsurePrivateCopy()
inherited fromCommonObject

Explode

#Since v8.0
Explodes this leader into its geometric components.
public GeometryBase[] Explode()
An array of Curve and TextEntity objects. If the leader is using user-defined arrowheads, InstanceReferenceGeometry objects will be included.

GetBoundingBox

Bounding box solver. Gets the world axis aligned bounding box for the geometry.
[ConstOperation] public BoundingBox GetBoundingBox(
accurate
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.
)
inherited fromGeometryBase
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.
[ConstOperation] public BoundingBox GetBoundingBox(
plane,
Orientation plane for BoundingBox.
out Box
worldBox
Aligned box in World coordinates.
)
inherited fromGeometryBase
A BoundingBox in plane coordinates.

GetBoundingBox

Aligned Bounding box solver. Gets the plane aligned bounding box.
[ConstOperation] public BoundingBox GetBoundingBox(
plane
Orientation plane for BoundingBox.
)
inherited fromGeometryBase
A BoundingBox in plane coordinates.

GetBoundingBox

Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
public override BoundingBox GetBoundingBox(
xform
Transformation to apply to bounding box after calculation. The geometry is not modified.
)
inherited fromAnnotationBase
The bounding box of the transformed geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.

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
[ConstOperation] public DimensionStyle GetDimensionStyle(
parentDimStyle
)
inherited fromAnnotationBase

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] public virtual void GetObjectData(
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
)
inherited fromCommonObject

GetPlainTextWithRunMap

Return plain text string for this annotation with field expressions unevaluated.
public string GetPlainTextWithRunMap(
ref int[]
map
an array of int values in groups of 3: run index, character start position, and length.
)
inherited fromAnnotationBase
A plain text string.

GetUserString

Gets user string from this geometry.
public string GetUserString(
key
id used to retrieve the string.
)
inherited fromGeometryBase
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.
public NameValueCollection GetUserStrings()
inherited fromGeometryBase
A new collection.

IsAllBold

Returns true if all of the text in the annotation is Bold, otherwise returns false
public bool IsAllBold()
inherited fromAnnotationBase

IsAllItalic

Returns true if all of the text in the annotation is Italic, otherwise returns false
public bool IsAllItalic()
inherited fromAnnotationBase

IsAllUnderlined

Returns true if all of the text in the annotation is Underlined, otherwise returns false
public bool IsAllUnderlined()
inherited fromAnnotationBase

IsPropertyOverridden

Returns true if a property is overridden
[ConstOperation] public bool IsPropertyOverridden(
Field
field
)
inherited fromAnnotationBase

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
public bool IsValidWithLog(
out string
log
A textual log. This out parameter is assigned during this call.
)
inherited fromCommonObject
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.
public bool MakeDeformable()
inherited fromGeometryBase
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.
[CLSCompliant(false)] [ConstOperation] public uint MemoryEstimate()
inherited fromGeometryBase
An estimated memory footprint.

NonConstOperation

Destroy cache handle
protected override void NonConstOperation()
inherited fromGeometryBase

OnSwitchToNonConst

Is called when a non-constant operation occurs.
protected override void OnSwitchToNonConst()
inherited fromGeometryBase

Rotate

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
public bool Rotate(
angleRadians,
Angle of rotation in radians.
rotationAxis,
Direction of the axis of rotation.
rotationCenter
Point on the axis of rotation.
)
inherited fromGeometryBase
true if geometry successfully rotated.

RunReplace

Replace text within a formatted string
public bool RunReplace(
replaceString,
startRunIndex,
startRunPosition,
endRunIndex,
endRunPosition
)
inherited fromAnnotationBase

Scale

Scales the object by the specified factor. The scale is centered at the origin.
public bool Scale(
scaleFactor
The uniform scaling factor.
)
inherited fromGeometryBase
true if geometry successfully scaled.

SetBold

public virtual bool SetBold(
set_on
)
inherited fromAnnotationBase

SetFacename

public virtual bool SetFacename(
set_on,
facename
)
inherited fromAnnotationBase

SetItalic

public virtual bool SetItalic(
set_on
)
inherited fromAnnotationBase

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
public bool SetOverrideDimStyle(
OverrideStyle
)
inherited fromAnnotationBase

SetRichText

Sets the annotation's text as rich text (RTF), optionally using a specified dimension style for formatting overrides.
public void SetRichText(
rtfText,
The RTF (Rich Text Format) string to assign to the annotation.
dimstyle
The dimension style to use for formatting overrides, or null to use the current style.
)
inherited fromAnnotationBase

SetUnderline

public virtual bool SetUnderline(
set_on
)
inherited fromAnnotationBase

SetUserString

Attach a user string (key,value combination) to this geometry.
public bool SetUserString(
key,
id used to retrieve this string.
value
string associated with key.
)
inherited fromGeometryBase
true on success.

ToJSON

Create a JSON string representation of this object
public string ToJSON()
inherited fromCommonObject

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.
public bool Transform(
Transform
xform
Transformation to apply to geometry.
)
inherited fromGeometryBase
true if geometry successfully transformed.

Translate

Translates the object along the specified vector.
public bool Translate(
x,
The X component.
y,
The Y component.
z
The Z component.
)
inherited fromGeometryBase
true if geometry successfully translated.

Translate

Translates the object along the specified vector.
public bool Translate(
translationVector
A moving vector.
)
inherited fromGeometryBase
true if geometry successfully translated.

WrapText

Wrap text
public void WrapText()
inherited fromAnnotationBase