LAnnPolyRuler::SetLineStyle

#include "ltwrappr.h"

virtual L_INT LAnnPolyRuler::SetLineStyle(uLineStyle=ANNLINE_SOLID, uFlags=0)

L_UINT uLineStyle;

/* constant that specifies the line style */

L_UINT uFlags;

/* flags that determine the object to process */

Sets the line style of the annotation object.

Parameter

Description

uLineStyle

The constant that specifies the line style. The following are the possible values of the line style:

 

ANNLINE_SOLID [0]

 

ANNLINE_DASH [1]

 

ANNLINE_DOT [2]

 

ANNLINE_DASHDOT [3]

 

ANNLINE_DASHDOTDOT [4]

 

ANNLINE_NULL [5]

 

Note: Windows displays all lines greater than 1 pixel as solid.

 

To see the possible line styles, refer to Illustration of Line Styles for Annotations.

uFlags

Flags that determine the object to process. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

 

Value

Meaning

 

0

Process only the specified object.

 

ANNFLAG_SELECTED

[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.

 

ANNFLAG_NOINVALIDATE

[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

Example

For an example, refer to LAnnPolyRuler::GetLineStyle.