AttributeLineStyle

Applies a style to a line, or retrieves the current style setting. You can only apply a line style if the line width is set to 1.

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

AttributeLineStyle(LineStyle)

LineStyle:

A value between 0 and 4 representing the style applied to a line. Line style only works if line width is set to 1.

0 = solid

1 = dashed

2 = dot

3 = dash dot

4 = dash dot dot

Return Value

If retrieving the current line style, a value between 0 and 4 that represents a particular style. If setting the line 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

AttributeLineWidth, AttributeLineColour

Example

' Applies a style (dash dot) to the current line
GraphicsBuilder.AttributeLineStyle = 3

' Retrieves the style applied to the current line
MyVariable = GraphicsBuilder.AttributeLineStyle

Note: This function is implemented in the C++ environment as two separate functions: put_AttributeLineStyle applies a particular line style, and get_AttributeLineStyle retrieves the current style setting.