Change Colors of User-interface Elements Example (VBA)

This example shows how to change the colors of user-interface elements.

'--------------------------------------------------------------
' Preconditions:
' 1. Create a VBA macro in a software product in which VBA is
'    embedded.
' 2. Copy and paste this example into the Visual Basic IDE.
' 3. Add a reference to install_dir\bin\dsAutomation.dll.
' 4. Start DraftSight and open a document.
' 5. Run the macro.
'
' Postconditions:
' 1. Message boxes pop up before and after the colors of
'    DraftSight user-interface elements change.
' 2. Click OK to close each message box.
' 3. Examine and experiment with the user-interface 
'    elements whose colors changed:
'    * Text in command window
'    * Crosshair
'    * Background of model
' 4. Run the macro again to reset the colors of the user-interface
'    elements to their former colors.
'----------------------------------------------------------------
Option Explicit

    Sub main()

        Dim dsApp As DraftSight.Application

        'Connect to DraftSight application
        Set dsApp = GetObject(, "DraftSight.Application")

        'Abort any command currently running in DraftSight
        'to avoid nested commands
        dsApp.AbortRunningCommand        

        If dsApp Is Nothing Then
            Return
        End If

        Dim dsApplicationOptions As ApplicationOptions
        Set dsApplicationOptions = dsApp.GetApplicationOptions()

        'Change colors of user-interface elements

        'Set color of text of command window to blue or black, dependent on current color
        Dim dsColor As Color
        Set dsColor = dsApplicationOptions.GetElementColor(dsElementColor_e.dsElementColor_CommandWindowText)
        MsgBox ("Color of text command window before changing its color: " & dsColor.GetNamedColor())
        If dsColor.GetNamedColor() = dsNamedColor_e.dsNamedColor_Blue Then
            dsColor.SetRGBColor 0, 0, 0
        Else
            dsColor.SetNamedColor (dsNamedColor_e.dsNamedColor_Blue)
        End If
        dsApplicationOptions.SetElementColor dsElementColor_e.dsElementColor_CommandWindowText, dsColor
        MsgBox ("Color of text of command window after changing its color: " & dsColor.GetNamedColor())

        'Set color of model crosshair to red or white, dependent on current color
        Set dsColor = dsApplicationOptions.GetElementColor(dsElementColor_e.dsElementColor_ModelCrosshair)
        MsgBox ("Color of crosshair before changing its color: " & dsColor.GetNamedColor())
        If dsColor.GetNamedColor() = dsNamedColor_e.dsNamedColor_Red Then
            dsColor.SetNamedColor (dsNamedColor_e.dsNamedColor_White)
        Else
            dsColor.SetNamedColor (dsNamedColor_e.dsNamedColor_Red)
        End If
        dsApplicationOptions.SetElementColor dsElementColor_e.dsElementColor_ModelCrosshair, dsColor
        MsgBox ("Color of crosshair after changing its color: " & dsColor.GetNamedColor())

        'Set color of background of model to white or black, dependent on current color
        Set dsColor = dsApplicationOptions.GetElementColor(dsElementColor_e.dsElementColor_ModelBackground)
        MsgBox ("Color of model background before changing its color: " & dsColor.GetNamedColor())
        If dsColor.GetNamedColor() = dsNamedColor_e.dsNamedColor_White Then
            dsColor.SetRGBColor 0, 0, 0
        Else
            dsColor.SetNamedColor (dsNamedColor_e.dsNamedColor_White)
        End If
        dsApplicationOptions.SetElementColor dsElementColor_e.dsElementColor_ModelBackground, dsColor
        MsgBox ("Color of model background after changing its color: " & dsColor.GetNamedColor())

    End Sub