LAnnContainer::SetLineStyle

#include "ltwrappr.h"

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

L_UINT uLineStyle;

/* constant that specifies the line style */

L_UINT uFlags;

/* flags that determine which objects to process */

Sets the line style of the annotation object.

Parameter

Description

uLineStyle

The constant that specifies the line style. Possible line style values are:

 

Value

Meaning

 

ANNLINE_SOLID

[0] Solid line

 

ANNLINE_DASH

[1] Dashed line

 

ANNLINE_DOT

[2] Dotted line

 

ANNLINE_DASHDOT

[3] Dash dot line

 

ANNLINE_DASHDOTDOT

[4] Dash dot dot line

 

ANNLINE_NULL

[5] No line

 

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 which objects to process. Most of the flags apply only to container objects. 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 LAnnContainer::GetSelectItems and LAnnotation::SetSelected functions.

 

ANNFLAG_NOTTHIS

[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.

 

ANNFLAG_RECURSE

[0x0008] Process objects within a container, and within any subcontainers, down to any level.

 

ANNFLAG_NOTCONTAINER

[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.

 

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.

Comments

This function applies to multiple and selected objects based on values of the uFlags parameter.

This function does not affect objects that do not have this property or that do not let you change the property. For descriptions of the various types of objects and their properties, refer to Types of Annotations.

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

L_INT LAnnContainer_SetLineStyleExample(LAnnContainer  * pAnnContainer)
{
   L_INT nRet;
   nRet = pAnnContainer->SetLineStyle(ANNLINE_DASH);
   return nRet;
}