AttributeRectangleStyle

Sets the rectangle style, or retrieves the rectangle style 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

AttributeRectangleStyle(Style)

Style:

0 = none

1 = border

2 = extra line

3 = border and an extra line

Return Value

If retrieving the current rectangle style setting, a value between 0 and 3. If applying a rectangle style, 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 style to a rectangle
GraphicsBuilder.AttributeRectangleStyle = 1

' Retrieves a value representing a rectangle style
MyVariable = GraphicsBuilder.AttributeRectangleStyle

Note: This function is implemented in the C++ environment as two separate functions: put_AttributeRectangleStyle applies a rectangle style, and get_AttributeRectangleStyle retrieves the current rectangle style setting.