SetBackgroundColor Method (ActiveX)

Signature

VBA:

object.SetBackgroundColor rowTypes, pColor

object

Type: Table, TableStyle

The objects this method applies to.

rowTypes

Access: Input-only

Type: AcRowType enum

The row types to change.

• acDataRow
• acHeaderRow
• acTitleRow
• acUnknownRow

pColor

Access: Input-only

Type: AcCmColor

The AutoCAD true color object to apply to the specified row type.

Return Value (RetVal)

No return value.

Remarks

No additional remarks.

Examples

VBA:

Sub Example_SetBackgroundColor()
    ' This example creates a TableStyle object and sets values for
    ' the style name and other attributes.
    
    Dim dictionaries As AcadDictionaries
    Set dictionaries = ThisDrawing.Database.dictionaries
  
    Dim dictObj As AcadDictionary
    Set dictObj = dictionaries.Item("acad_tablestyle")
  
    ' Get the current TableStyle object
    Dim tableStyle As AcadTableStyle
    Set tableStyle = dictObj.Item(ThisDrawing.GetVariable("CTABLESTYLE"))
  
    Dim colCurrent As AcadAcCmColor, colRowCurrent As AcadAcCmColor, colNoneCurrent As Boolean
    Set colCurrent = tableStyle.GetBackgroundColor(acTitleRow)
    Set colRowCurrent = tableStyle.GetColor(acDataRow)
    colNoneCurrent = tableStyle.GetBackgroundColorNone(acHeaderRow)

    MsgBox "Table colors " & vbLf & _
           "Background ACI value = " & colCurrent.ColorIndex & vbLf & _
           "Row Text ACI value = " & colRowCurrent.ColorIndex & vbLf & _
           "Background None = " & colNoneCurrent
  
    Dim col As AcadAcCmColor
    Set col = tableStyle.GetBackgroundColor(acTitleRow)
    col.SetRGB 0, 0, 255
    tableStyle.SetBackgroundColor acTitleRow, col
    col.SetRGB 255, 0, 0
    tableStyle.SetColor acDataRow, col
    If colNoneCurrent = False Then
        tableStyle.SetBackgroundColorNone acHeaderRow, True
    Else
        tableStyle.SetBackgroundColorNone acHeaderRow, False
    End If
      
    Dim colNew As AcadAcCmColor, colRowNew As AcadAcCmColor, colNoneNew As Boolean
    Set colNew = tableStyle.GetBackgroundColor(acTitleRow)
    Set colRowNew = tableStyle.GetColor(acDataRow)
    colNoneNew = tableStyle.GetBackgroundColorNone(acHeaderRow)

    MsgBox "Table colors " & vbLf & _
           "Background ACI value = " & colNew.ColorIndex & vbLf & _
           "Row Text ACI value = " & colRowNew.ColorIndex & vbLf & _
           "Background None = " & colNoneNew
  
    tableStyle.SetBackgroundColor acTitleRow, colCurrent
    tableStyle.SetColor acDataRow, colRowCurrent
    tableStyle.SetBackgroundColorNone acHeaderRow, colNoneCurrent
    
    MsgBox "Reset the table style back to its original values."
End Sub

Visual LISP:

(vl-load-com)
(defun c:Example_SetBackgroundColor()
    ;; This example creates a TableStyle object and sets values for 
    ;; the style name and other attributes.
    (setq acadObj (vlax-get-acad-object)
          doc (vla-get-ActiveDocument acadObj))

    (setq dictionaries (vla-get-Dictionaries doc)
          dictObj (vla-Item dictionaries "acad_tablestyle"))
    
    ;; Get the current TableStyle object
    (setq tableStyle (vla-Item dictObj (vla-GetVariable doc "CTABLESTYLE")))
      
    (setq colCurrent (vla-GetBackgroundColor tableStyle acTitleRow)
          colRowCurrent (vla-GetColor tableStyle acDataRow)
          colNoneCurrent (vla-GetBackgroundColorNone tableStyle acHeaderRow))

    (alert (strcat "Table colors \n"
                   "Background ACI value = " (itoa (vla-get-ColorIndex colCurrent)) "\n"
                   "Row Text ACI value = " (itoa (vla-get-ColorIndex colRowCurrent)) "\n"
                   "Background None = " (if (= colNoneCurrent :vlax-true) "True" "False")))

    (setq col (vla-GetBackgroundColor tableStyle acTitleRow))
    (vla-SetRGB col 0 0 255)
    (vla-SetBackgroundColor tableStyle acTitleRow col)
    (vla-SetRGB col 255 0 0)
    (vla-SetColor tableStyle acDataRow col)
    (vla-SetBackgroundColorNone tableStyle acHeaderRow (if (= colNoneCurrent :vlax-true) :vlax-false :vlax-true))
  
    (setq colNew (vla-GetBackgroundColor tableStyle acTitleRow)
          colRowNew (vla-GetColor tableStyle acDataRow)
          colNoneNew (vla-GetBackgroundColorNone tableStyle acHeaderRow))

    (alert (strcat "Table colors \n"
                   "Background ACI value = " (itoa (vla-get-ColorIndex colNew)) "\n"
                   "Row Text ACI value = " (itoa (vla-get-ColorIndex colRowNew)) "\n"
                   "Background None = " (if (= colNoneNew :vlax-true) "True" "False")))

    (vla-SetBackgroundColor tableStyle acTitleRow colCurrent)
    (vla-SetColor tableStyle acDataRow colRowCurrent)
    (vla-SetBackgroundColorNone tableStyle acHeaderRow colNoneCurrent)

    (alert "Reset the table style back to its original values.")
)