TextPrefix Property (ActiveX)

Specifies the dimension value prefix.

Supported platforms: Windows only

Signature

VBA:

object.TextPrefix

object

Type: Dim3PointAngular, DimAligned, DimAngular, DimArcLength, DimDiametric, Dimension, DimOrdinate, DimRadial, DimRadialLarge, DimRotated

The objects this property applies to.

Property Value

Read-only: No

Type: String

The prefix for the dimension value.

Remarks

The initial value for this property is "".

Note: This property overrides the value of the DIMPOST system variable for the given dimension.

Examples

VBA:

Sub Example_TextPrefix()
    ' This example creates an aligned dimension in model space and
    ' uses TextPrefix to allow the user to change the text prefix for the
    ' dimension

    Dim dimObj As AcadDimAligned
    Dim point1(0 To 2) As Double, point2(0 To 2) As Double
    Dim location(0 To 2) As Double
    Dim prefix As String
    
    ' Define the dimension
    point1(0) = 0: point1(1) = 5: point1(2) = 0
    point2(0) = 5: point2(1) = 5: point2(2) = 0
    location(0) = 5: location(1) = 7: location(2) = 0
    
    ' Create an aligned dimension object in model space
    Set dimObj = ThisDrawing.ModelSpace.AddDimAligned(point1, point2, location)
    
    ThisDrawing.Application.ZoomAll

    ' Allow the user to change the text prefix for the dimension
    prefix = InputBox("Enter a new text prefix for the dimension", "Set Dimension Prefix", "PREFIX:")
    dimObj.TextPrefix = prefix   ' Commit changes to prefix
    
    ThisDrawing.Regen acAllViewports
    
    ' Read back and display the dimension text prefix
    prefix = dimObj.TextPrefix
    If prefix <> "" Then
        MsgBox "The prefix of the dimension has been changed to: " & prefix
    Else
        MsgBox "The prefix of the dimension has been removed"
    End If
End Sub

Visual LISP:

(vl-load-com)
(defun c:Example_TextPrefix()
    ;; This example creates an aligned dimension in model space and
    ;; uses TextPrefix to allow the user to change the text prefix for the
    ;; dimension
    (setq acadObj (vlax-get-acad-object))
    (setq doc (vla-get-ActiveDocument acadObj))
    
    ;; Define the dimension
    (setq point1 (vlax-3d-point 0 5 0)
          point2 (vlax-3d-point 5 5 0)
          location (vlax-3d-point 5 7 0))
    
    ;; Create an aligned dimension object in model space
    (setq modelSpace (vla-get-ModelSpace doc))
    (setq dimObj (vla-AddDimAligned modelSpace point1 point2 location))
    
    (vla-ZoomAll acadObj)

    ;; Allow the user to change the text prefix for the dimension
    (setq prefix (vla-GetString (vla-get-Utility doc) :vlax-false "\nEnter a new text prefix for the dimension: "))
    (vla-put-TextPrefix dimObj prefix)   ;; Commit changes to prefix
    
    (vla-Regen doc acAllViewports)
    
    ;; Read back and display the dimension text prefix
    (setq prefix (vla-get-TextPrefix dimObj))
    (if (/= prefix "")
        (alert (strcat "The prefix of the dimension has been changed to: " prefix))
        (alert "The prefix of the dimension has been removed")
    )
)