L_AnnSetFillPattern

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetFillPattern(hObject, uFillPattern, uFlags)

HANNOBJECT hObject;	/* handle to the annotation object */
L_UINT uFillPattern;	/* constant that specifies the fill pattern */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets the fill pattern of one or more annotation objects.

This function is available in the Document and Medical Imaging toolkits.

Parameter	Description
hObject	Handle to the annotation object.
uFillPattern	The constant that specifies the fill pattern. Possible fill pattern values are:
	Value	Meaning
	ANNPATTERN_SOLID	[0] Solid
	ANNPATTERN_BDIAGONAL	[1] Backward diagonal
	ANNPATTERN_CROSS	[2] Cross
	ANNPATTERN_DIAGCROSS	[3] Diagonal cross
	ANNPATTERN_FDIAGONAL	[4] Forward diagonal
	ANNPATTERN_HORIZONTAL	[5] Horizontal
	ANNPATTERN_VERTICAL	[6] Vertical
	To see the possible fill modes and patterns, refer to Illustration of Fill Options 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 L_AnnGetSelected and L_AnnSetSelected 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.
	ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_FILL menu item has been selected.

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

Windows 2000 / XP/Vista.

See Also

Functions:	L_AnnGetFillPattern, L_AnnGetPolyFillMode, L_AnnSetPolyFillMode, L_AnnGetFillMode, L_AnnSetFillMode, L_AnnGetOptions, L_AnnSetOptions
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Annotation Objects - Automated Features
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Altering Annotation Object Settings

Example

This example gets and updates the property of the object passed by the caller.

 L_INT AnnSetFillPatternExample(HANNOBJECT hAnnObject)
{
   L_INT nRet;
   L_UINT FillPattern; /* Object fill pattern */

   /* Set the fill pattern to solid, unless it already is */
   nRet = L_AnnGetFillPattern(hAnnObject, &FillPattern);
   if(nRet != SUCCESS)
      return nRet;
   if (FillPattern == ANNPATTERN_SOLID)
       MessageBox (NULL, TEXT("Already solid"), TEXT("Notice"), MB_OK);
   else
   {
      nRet = L_AnnSetFillPattern(hAnnObject, ANNPATTERN_SOLID, 0);
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}