poIRenderOptions SetBackgroundColor
Sets the background color(s).
Syntax
poIRenderOptions_handle SetBackgroundColorr1 g1 b1 (r2 g2 b2)
poIRenderOptions_handle SetBackgroundColorindex1 (index2)
poIRenderOptions_handle SetBackgroundColorcolor1 (color2)
The colors can be set using two sets of rgb values, two index values, or the name of each color.
Application
HyperView Tcl Modify
Description
This command sets the background color(s).
Inputs
- r1 g1 b1 (r2 g2 b2)
- The red, green, and blue values (each ranging from 0 to 255).
- index1 (index2)
- The location in the color table.
- color1 (color2)
- The name of the color.
Example
To set the background to a solid
color:
hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetRenderOptionsHandle render_options
render_options SetBackgroundColor “100 200 100”
hwi CloseStack
To set the background to a gradient:
hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetRenderOptionsHandle render_options
render_options SetBackgroundColor “0 0 0” “255 255 255”
hwi CloseStack
…
render_options SetBackgroundColor 0 1
…
…
render_options SetBackgroundColor black white
…Errors
Returns 0 if successful, or a non-zero value if an error occurred.