CONTAINERMETRICS

Summary

The CONTAINERMETRICS structure holds the information that controls the container's behavior.

Syntax

typedef struct _CONTAINERMETRICS 
{ 
   L_INT nSize; 
   L_UINT32 dwMask; 
   COLORREF crBorder; 
   L_INT nHandleWidth; 
   L_INT nHandleHeight; 
   COLORREF crHandle; 
   L_BOOL fEnableHandles; 
   RECT rcLimits; 
   LOGFONTW logTextFont; 
   CONTAINERALIGNMENT   nTextAlignment; 
   HPALETTE      hPalette; 
} CONTAINERMETRICS,  *pCONTAINERMETRICS; 

Members

nSize

Size of this structure.

dwMask

Flags that indicate which members of this structure contain valid information. This member must be filled prior to calling LContainer::GetMetrics or LContainer::SetMetrics. Possible values are given below. These values may be combined using the bitwise OR operator ( | ).

crBorder

Specifies the color of the pen used for drawing objects within the container. The default color is RGB ( 0, 0, 0 ).

nHandleWidth

Specifies the width, in logical units, of the handle used when editing an object. The default value is 4.

nHandleHeight

Specifies the height, in logical units, of the handle used when editing an object. The default value is 4.

crHandle

Specifies the color of the pen used when drawing the handle. The default color is RGB (0, 0, 0 ).

fEnableHandles

Flag that indicates whether the handle used when editing objects within the container is enabled or disabled. Possible values are:

rcLimits

RECT structure that contains the boundaries of the container. Any point outside the specified boundaries will not be processed. The container transformation values (scaling and offset) are taken into consideration when determining whether the point is inside the container. The default container boundaries are {0, 0, 0, 0 }. Therefore, the user should set the limits value before getting data from the container.

logTextFont

Pointer to a LOGFONT structure that contains the characteristics of the logical font used with the container text object(s). The default values for this field are:

nTextAlignment

A constant that specifies the text alignment of the container's text object(s), enumerated as CONTAINERALIGNMENT. Possible values are:

hPalette

Handle of the palette used to draw the container objects. This should be the same palette used to paint the window that owns the container. The default value for this field is NULL.

Usage

• LContainer::GetMetrics
• LContainer::SetMetrics