AttributeShadowColour

Sets the shadow color when a shadowed 3D effect is used, or retrieves the current shadow 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.

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

Syntax

AttributeShadowColour(ShadowColour)

ShadowColour:

A value between 0 and 255 representing the shadow color.

Return Value

If retrieving the current shadow color setting, a value between 0 and 255. If applying a shadow 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, AttributeHiLightColour, AttributeLoLightColour

Example

' Applies a shadow color to a shadowed 3D effect
GraphicsBuilder.AttributeShadowColour = 125

' Retrieves the current shadow color
MyVariable = GraphicsBuilder.AttributeShadowColour

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