ImageVisibility Property (ActiveX)

Specifies whether image visibility is on or off.

Supported platforms: Windows only

Signature

VBA:

object.ImageVisibility

object

Type: GeomapImage, RasterImage, Wipeout

The objects this property applies to.

Property Value

Read-only: No

Type: Boolean

• True: The image is visible.
• False: The image is hidden.

Remarks

You can increase redrawing speed by turning the image visibility off when you do not need it in the current drawing session. Hidden images are not displayed or plotted; only the drawing boundary is displayed. You can choose to hide an image regardless of the current viewport coordinate system, or specifically when the image is not orthogonal (aligned) with the current viewport coordinate system.

Examples

VBA:

Sub Example_ImageVisibility()
    ' This example inserts a raster image and finds the current status
    ' of ImageVisibility for the image. It then changes the ImageVisibility
    ' status of the image.
    
    ' This example uses the "2d Projected Polylines.jpg" found in the Sample
    ' directory. If you do not have the image, or if it is located
    ' in a different directory, insert a valid path and name for the
    ' imageName variable below.
    Dim insertionPoint(0 To 2) As Double
    Dim scalefactor As Double
    Dim rotAngleInDegree As Double, rotAngle As Double
    Dim imageName As String
    Dim raster As AcadRasterImage
    imageName = "C:\AutoCAD\sample\2d Projected Polylines.jpg"
    insertionPoint(0) = 2#: insertionPoint(1) = 2#: insertionPoint(2) = 0#
    scalefactor = 1#
    rotAngleInDegree = 0#
    rotAngle = rotAngleInDegree * 3.141592 / 180#
    
    On Error Resume Next
    
    ' Creates a raster image in model space
    Set raster = ThisDrawing.ModelSpace.AddRaster(imageName, insertionPoint, scalefactor, rotAngle)
    If Err.Description = "File error" Then
        MsgBox imageName & " could not be found."
        Exit Sub
    End If

    ' Find the current ImageVisibility
    ThisDrawing.Regen True
    MsgBox "The ImageVisibility is currently set to: " & raster.ImageVisibility, vbInformation
    
    ' Change the ImageVisibility
    If (raster.ImageVisibility) Then
        raster.ImageVisibility = False
    Else
        raster.ImageVisibility = True
    End If
    ThisDrawing.Regen True
    MsgBox "The ImageVisibility is now set to: " & raster.ImageVisibility, vbInformation
End Sub

Visual LISP:

(vl-load-com)
(defun c:Example_ImageVisibility()
    ;; This example inserts a raster image and finds the current status
    ;; of ImageVisibility for the image. It then changes the ImageVisibility
    ;; status of the image.
    (setq acadObj (vlax-get-acad-object))
    (setq doc (vla-get-ActiveDocument acadObj))
    
    ;; This example uses the "2d Projected Polylines.jpg" found in the Sample
    ;; directory. If you do not have the image, or if it is located
    ;; in a different directory, insert a valid path and name for the
    ;; imageName variable below.
    (setq insertionPoint (vlax-3d-point 2 2 0)
          imageName ".\\Sample\\VBA\\2d Projected Polylines.jpg"
          scalefactor 1
          rotAngle (/ (* 0 3.141592 180)))
    
    ;; Creates a raster image in model space
    (if (/= (findfile imageName) nil)
        (progn
            (setq modelSpace (vla-get-ModelSpace doc))
            (setq raster (vla-AddRaster modelSpace (findfile imageName) insertionPoint scalefactor rotAngle))
	    
	           ;; Find the current ImageVisibility
	           (vla-Regen doc :vlax-true)
	           (alert (strcat "The ImageVisibility is currently set to: " (if (= (vla-get-ImageVisibility raster) :vlax-true) "True" "False")))
	    
	           ;; Change the ImageVisibility
	           (if (= (vla-get-ImageVisibility raster) :vlax-true)
	               (vla-put-ImageVisibility raster :vlax-false)
	               (vla-put-ImageVisibility raster :vlax-true)
	           )
	           (vla-Regen doc :vlax-true)
	           (alert (strcat "The ImageVisibility is now set to: " (if (= (vla-get-ImageVisibility raster) :vlax-true) "True" "False")))
        )
        (alert (strcat imageName " could not be found."))
    )
)