AttributeHiLightColour

Sets the highlight color applied to the 3D effects raised, lowered or embossed, or retrieves the current highlight color setting.

This function applies to the selected object, which is typically the last placed object. By using the PageSelectFirstObject and PageSelectNextObject functions, you can access objects and change or read their properties.

Note: As this function does not support True Color functionality, it has been superseded by the functions AttributeHiLightOnColourEx and AttributeHiLightOffColourEx.

Syntax

AttributeHiLightColour(HiLightColour)

HiLightColour:

A value between 0 and 255 representing the highlight color.

Return Value

If retrieving the current highlight color setting, a value between 0 and 255. If applying a highlight color, 0 (zero) if successful. In both cases, an error is returned if unsuccessful. If values are out of range on writing to the attribute, the function will exit and report the error E_INVALIDARG. If there is no active object, they will exit and report a return value of E_HANDLE.

Note: For details on handling return and error values, see Error Handling.

Related Functions

Attribute3dEffects, Attribute3dEffectDepth, AttributeShadowColour, AttributeLoLightColour

Example

' Applies a highlight color to a 3D effect
GraphicsBuilder.AttributeHiLightColour = 125

' Retrieves a value representing a 3D effect's highlight color
MyVariable = GraphicsBuilder.AttributeHiLightColour

Note: This function is implemented in the C++ environment as two separate functions: put_AttributeHiLightColour applies a highlight color setting, and get_AttributeHiLightColour retrieves the current highlight color setting.