Sets the lowlight color applied to the 3D effects raised, lowered or embossed, or retrieves the current lowlight 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 your objects and change or read their
properties.
Syntax
AttributeLoLightColour(LoLightColour)
LoLightColour:
A value between 0 and 255 representing the lowlight color.
Return Value
If retrieving the current lowlight color setting, a value between 0 and 255. If applying a lowlight 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, AttributeHiLightColour
Example
' Applies a lowlight color to a 3D effect
GraphicsBuilder.AttributeLoLightColour = 45
' Retrieves a value representing a 3D effect's lowlight color
MyVariable = GraphicsBuilder.AttributeLoLightColour
This function is implemented in the C++
environment as two separate functions: put_AttributeLoLightColour applies a lowlight
color setting, and get_AttributeLoLightColour retrieves the
current lowlight color setting.