E-BASIC: CColor, Color Object, RteColor provides expanded colors and HTML color listing [17814]

This article applies to:
E-Prime 3.0
E-Prime 2.0

This item was introduced in E-Prime 2.0 (2.0.1.1).

Detail
CColor provides access to the Color and RteColor objects, as well as the entire HTML color listing.

Color during Experiment Design
During experiment design and development, it is possible to assign HTML colors to individual objects and sub-objects, assuming that their assignable properties permit. For instance, it is possible to assign the ForeColor property of the TextDisplay object to 'MediumSlateBlue'.
 
Alternatively, it is possible to utilize the RGB values for each object within their assignable property. For example, it is possible to assign the BackColor property of the Slide object to '250,128,114' which is the RGB value for the 'Salmon' HTML color. Note the absence of the space between each value.

Color object at Runtime
At runtime, the Color object can be used to gain access to each color. The Color object is a RteCollection of RteColor objects. A color can be accessed by its integer index or text name. A RteColor object is returned from the collection. Its default value is the CColor value that can be assigned by an object's property. In addition, the color can be returned via a . property that represents the name of the color.

RteColor
The RteColor object at runtime has the following properties:

• .Color - Default property returns the CColor value used to assign to object properties
• .Text - The text name of the color
• .Red - The value of the red component of the color
• .Green - The value of the green component of the color
• .Blue - The value of the blue component of the color

Examples

'The following are all the same statement
Stimulus.BackColor = Color.AliceBlue
Stimulus.BackColor = Color(1)
Stimulus.BackColor = Color("AliceBlue")
Stimulus.BackColor = CColor(Color.AliceBlue.Red & "," & Color.AliceBlue.Green & "," & Color.AliceBlue.Blue)

The Colors

The following E-Basic was used to create the table above:

Dim strTextColor As String
Dim str As String

 

'Begin table
str = str & "<table>" & ebCrLf

 

'Heading
str = str & "<tr><th>Color Name</th><th>RGB (Decimal)</th><th>RGB (Hex)</th></tr>" & ebCrLf

Dim nColor As Long
For nColor = 1 To Color.Count

 

'Determine how many components are dark
Dim nNumDark As Long
nNumDark = 0
If Color(nColor).Red < 128 Then nNumDark = nNumDark + 1
If Color(nColor).Green < 128 Then nNumDark = nNumDark + 1
If Color(nColor).Blue < 128 Then nNumDark = nNumDark + 1

 

'Deterimine text color
If nNumDark > 1 Then
strTextColor = "white"
Else
strTextColor = "black"

End If

 

'New Row
str = str & "<tr bgcolor='" & Color(nColor).Text & "'>" & ebCrLf

 

'Text
str = str & "<td><span style='color: " & strTextColor & "';>" & Color(nColor).Text & "</span></td>" & ebCrLf

 

'RGB (Decimal)
str = str & "<td><span style='color: " & strTextColor & "';>" & Color(nColor).Red & ", " & Color(nColor).Green & ", " & Color(nColor).Blue & "</td>" & ebCrLf

 

'RGB (Hex)
str = str & "<td><span style='color: " & strTextColor & "';>0x" & Hex(Color(nColor).Red) & ", 0x" & Hex(Color(nColor).Green) & ", 0x" & Hex(Color(nColor).Blue) & "</td>" & ebCrLf

 

'End Of Row
str = str & "</tr>" & ebCrLf

Next

'End table
str = str & "<table>" & ebCrLf

'Open the file
Dim nFile As Long
nFile = FreeFile
Open "color.html" For Output As #nFile

 

'Write the html
Print #nFile, str

 

'Close
Close nFile

For further information on scripting using E-Basic, please refer to the E-Prime Command Reference (https://pstnet.com/ecr).