GradientName Property (ActiveX)

Specifies the pattern name of the gradient.

Supported platforms: Windows only

Signature

VBA:

object.GradientName

object

Type: Hatch

The object this property applies to.

Property Value

Read-only: No

Type: String

The pattern name of the gradient, which can be

• "Linear"
• "Cylinder"
• "InvCylinder"
• "Spherical"
• "HemiSpherical"
• "Curved"
• "InvSpherical"
• "InvHemiSpherical"
• "InvCurved"

Remarks

No additional remarks.

Examples

VBA:

Sub Example_GradientName()
    ' This example changes the value of the GradientName property.
    
    Dim hatchObj As AcadHatch
    Dim patternName As String
    Dim PatternType As Long
    Dim bAssociativity As Boolean
    
    ' Define the hatch
    patternName = "CYLINDER"
    PatternType = acPreDefinedGradient '0
    bAssociativity = True
    
    ' Create the associative Hatch object in model space
    Set hatchObj = ThisDrawing.ModelSpace.AddHatch(PatternType, patternName, bAssociativity, acGradientObject)
    Dim col1 As AcadAcCmColor, col2 As AcadAcCmColor
    Set col1 = AcadApplication.GetInterfaceObject("AutoCAD.AcCmColor.20")
    Set col2 = AcadApplication.GetInterfaceObject("AutoCAD.AcCmColor.20")
    col1.SetRGB 255, 0, 0
    col2.SetRGB 0, 255, 0
    hatchObj.GradientColor2 = col1
    hatchObj.GradientColor2 = col2
    
    ' Create the outer boundary for the hatch (a circle)
    Dim outerLoop(0 To 0) As AcadEntity
    Dim center(0 To 2) As Double
    Dim radius As Double
    center(0) = 3: center(1) = 3: center(2) = 0
    radius = 1
    Set outerLoop(0) = ThisDrawing.ModelSpace.AddCircle(center, radius)
    
    ' Append the outerboundary to the hatch object, and display the hatch
    hatchObj.AppendOuterLoop (outerLoop)
    hatchObj.Evaluate
    ThisDrawing.Regen True
    MsgBox "Initial value of GradientName is " & hatchObj.GradientName
    hatchObj.GradientName = "SPHERICAL"
    MsgBox "New value of GradientName is " & hatchObj.GradientName
End Sub

Visual LISP:

(vl-load-com)
(defun c:Example_GradientName()
    ;; This example changes the value of the GradientColor1 property.
    (setq acadObj (vlax-get-acad-object))
    (setq doc (vla-get-ActiveDocument acadObj))    
    
    ;; Define the hatch
    (setq patternName "CYLINDER")
    (setq patternType acPreDefinedGradient)
    (setq bAssociativity :vlax-true)
    
    ;; Create the associative Hatch object in model space
    (setq modelSpace (vla-get-ModelSpace doc))  
    (setq hatchObj (vla-AddHatch modelSpace patternType patternName bAssociativity acGradientObject))

    (setq col1 (vlax-create-object "AutoCAD.AcCmColor.20"))
    (setq col2 (vlax-create-object "AutoCAD.AcCmColor.20"))

    (vla-SetRGB col1 255 0 0)
    (vla-SetRGB col2 0 255 0)

    (vla-put-GradientColor1 hatchObj col1)
    (vla-put-GradientColor2 hatchObj col2)
    
    ;; Create the outer boundary for the hatch (a circle)
    (setq center (vlax-3d-point 3 3 0)
          radius 1)
    (setq circle (vla-AddCircle modelSpace center radius))

    (setq outerLoop (vlax-make-safearray vlax-vbObject '(0 . 0)))
    (vlax-safearray-put-element outerLoop 0 circle)
    
    ;; Append the outerboundary to the hatch object, and display the hatch
    (vla-AppendOuterLoop hatchObj outerLoop)
    (vla-Evaluate hatchObj)
    (vla-Regen doc :vlax-true)

    (alert (strcat "Initial value of GradientName is " (vla-get-GradientName hatchObj)))
    (vla-put-GradientName hatchObj "SPHERICAL")
    (alert (strcat "New value of GradientName is " (vla-get-GradientName hatchObj)))

    (vlax-release-object col1)
    (vlax-release-object col2)
)