DISPCONTAINERPROPERTIES

typedef struct tagDISPCONTAINERPROPERTIES
{
   L_UINT uStructSize;
   L_UINT uMask;
   L_UINT uMask1;
   L_UINT uNumRows;
   L_UINT uNumCols;
   COLORREF crEmptyCellBackGroundColor;
   HCURSOR hDefaultCursor;
   HCURSOR hRszVertCursor;
   HCURSOR hRszHorzCursor;
   HCURSOR hRszBothCursor;
   L_BOOL bAutoScroll;
   L_UINT uCellsMaintenance;
   L_UINT uSplitterStyle;
   L_UINT bUseExtraSplitters;
   L_BOOL bCustomSplitterColor;
   COLORREF crSplitterColor;
   L_BOOL bShowContainerScroll;
   L_BOOL bLayoutDesign;
   L_BOOL bGridMode;
   L_BOOL bSnapToGrid;
   L_BOOL bShowGrid;
   L_INT nGridSizeX;
   L_INT nGridSizeY;
   L_INT nDesignTool;
   L_BOOL bAllowOverlappingCells;
   COLORREF clrRectBackColor;
   COLORREF clrRectForeColor;
   COLORREF clrGridColor;
   L_BOOL bShowLayoutPosition;
   L_BOOL bShowLines;
} DISPCONTAINERPROPERTIES, * pDISPCONTAINERPROPERTIES;

The DISPCONTAINERPROPERTIES structure contains options for controlling the behavior of the container.

Member

Description

uStructSize

Size of this structure in bytes, for versioning. Use the sizeof() macro to calculate this value.

uMask

Value that indicates which members contains valid data for setting, or which members should be updated. Flags can be combined using the bitwise 'OR. Possible values are:

 

Value

Meaning

 

DCPF_ALL

All members must be valid or must be filled in.

 

DCPF_NUMROWS

The uNumRows member is valid or must be filled in.

 

DCPF_NUMCOLS

The uNumCols member is valid or must be filled in.

 

DCPF_EMPTYCELLBACKGROUNDCOLOR

The crEmptyCellBackGroundColor member is valid or must be filled in.

 

DCPF_DEFAULTCURSOR

The hDefaultCursor member is valid or must be filled in.

 

DCPF_VERTCURSOR

The hRszVertCursor is valid or must be filled in.

 

DCPF_HORZCURSOR

The hRszHorzCursor is valid or must be filled in.

 

DCPF_BOTHCURSOR

The hRszBothCursor is valid or must be filled in.

 

DCPF_AUTOSCROLL

The bAutoScroll member is valid or must be filled in.

 

DCPF_CELLSMAINTENANCE

The uCellsMaintenance is valid or must be filled in.

 

DCPF_SPLITTERSTYLE

The uSplitterStyle member is valid or must be filled in.

 

DCPF_SPLITTERCOLOR

The crSplitterColor member is valid or must be filled in.

 

DCPF_USEEXTRASPLITTERS

The bUseExtraSplitters member is valid or must filled in.

 

DCPF_SHOWVIEWERSCROLL

The bShowContainerScroll member is valid or must be filled in.

 

DCPF_VIEWERBACKCOLOR

The crEmptyCellBackGroundColor member is valid or must be filled in.

uMask1

Additional value that indicates which members contains valid data for setting, or which members should be updated. Flags can be combined using the bitwise 'OR.  Possible values are:

 

Value

Meaning

 

DCPF1_ALL

All members must be valid or must be filled in.

 

DCPF1_GRIDMODE

[0x00000008] The bGridMode member is valid or must be filled in.

 

DCPF1_LAYOUTDESIGN

[0x00000010] The bGridMode member is valid or must be filled in.

 

DCPF1_SNAPTOGRID

[0x00000020] The bLayoutDesign member is valid or must be filled in.

 

DCPF1_SHOWGRID

[0x00000040] The bShowGrid member is valid or must be filled in.

 

DCPF1_GRIDSIZE

[0x00000080] The nGridSizeX & nGridSizeY members are valid or must be filled in.

 

DCPF1_DESIGNTOOL

[0x00000100] The nDesignTool member is valid or must be filled in.

 

DCPF1_ALLOWOVERLAPPINGCELLS

[0x00000200] The bAllowOverlappingCells member is valid or must be filled in.

 

DCPF1_RECTFORECOLOR

[0x00000400] The clrRectForeColor member is valid or must be filled in.

 

DCPF1_RECTBACKCOLOR

[0x00000800] The clrRectBackColor member is valid or must be filled in.

 

DCPF1_SHOWLAYOUTPOSITION

[0x00001000] The bShowLayoutPosition member is valid or must be filled in.

 

DCPF1_GRIDCOLOR

[0x00020000] The clrGridColor member is valid or must be filled in.

 

DCPF1_GRIDSHOWLINES

[0x00040000] The bShowLines member is valid or must be filled in.

uNumRows

Number of rows in the container. The default value is 1. The maximum is 4.

uNumCols

Number of columns in the container. The default value is 1. The maximum is 8.

crEmptyCellBackGroundColor

Background color to display in empty cells. The default color is black.

hDefaultCursor

Default cursor for the container. The default value is IDC_ARROW.

hRszVertCursor

Default cursor for resizing vertically. The default value is IDC_SIZENS.

hRszHorzCursor

Default cursor for resizing horizontally. The default value is IDC_SIZEWE.

hRszBothCursor

Default cursor for resizing horizontally and vertically. The default value is IDC_SIZEBOTH.

uSplitterStyle

Flags that determine the style of the splitter. Possible values are:

 

Value

Meaning

 

CONTAINER_BORDERSIZE_NONE

No splitter is shown.

 

CONTAINER_BORDERSIZE_THIN

One pixel width splitter.

 

CONTAINER_BORDERSIZE_THICK

Thick 3D splitter (Default).

bUseExtraSplitters

Flag that indicates whether to display the extra splitter at the bottom and right of the control in order to allow adding more rows and columns dynamically. Possible values are:

 

Value

Meaning

 

TRUE

Show the splitter at the right and bottom of the control.

 

FALSE

Do not show the splitters at the right and bottom of the control.

bCustomSplitterColor

Flag that indicates whether to use crSplitterColor to draw the splitter or to use the system theme color. Possible values are:

 

Value

Meaning

 

TRUE

The color of the splitters will be specified in crSplitterColor member.

 

FALSE

The color of the splitters will be determined by the system theme color.

crSplitterColor

Color of the splitter. This value is ignored when bCustomSplitterColor is FALSE.

bShowContainerScroll

Flag that indicates whether to display the viewer scroll that is used to scroll throw the cells. Possible value are:

 

Value

Meaning

 

TRUE

Display the viewer scroll

 

FALSE

Don’t display the viewer scroll.

 

uCellsMaintenance

Flag that indicates whether to maintain, if possible, cell size or cell position. Possible values are:

 

Value

Meaning

 

DCPF_CELLSMAINTENANCE_SIZE

Maintain cell size, if possible. This is the default value.

 

DCPF_CELLSMAINTENANCE_POS

Maintain cell position.

 

bAutoScroll

value that indicate whether to allow the medical viewer to add a scroll bar to scroll through the cells. Possible values are:

 

Value

Meaning

 

TRUE

Add a scroll bar to scroll through the cells

 

FALSE

Not to add a scroll bar to scroll through the cells

bLayoutDesign

Flag that indicates whether the viewer is in design mode. Possible values are:

 

Value

Meaning

 

TRUE

The viewer is in design mode.

 

FALSE

The viewer is in run mode.

bGridMode

Flag that indicate whether the viewer is layout is in grid mode. Possible values are:

 

Value

Meaning

 

TRUE

The viewer is in a grid layout mode.

 

FALSE

The viewer can position cells using layout coordinates.

bSnapToGrid

Flag that indicates whether snap to grid functionality is enabled in design mode. Possible values are:

 

Value

Meaning

 

TRUE

Enable snap to grid.

 

FALSE

Disable snap to grid.

bShowGrid

Flag that indicates whether to show a layout grid in design mode. Possible values are:

 

Value

Meaning

 

TRUE

Display the layout grid.

 

FALSE

Do not display the layout grid.

nGridSizeX

Specifies the horizontal size of the grid in design mode.

nGridSizeY

Specifies the vertical size of the grid in design mode.

nDesignTool

Specifies the design tool to use during design mode. Possible values are:

 

Value

Meaning

 

0

Select.

 

1

Draw.

bAllowOverlappingCells

Flag that indicates whether or not to allow overlapping cells. Possible values are:

 

Value

Meaning

 

TRUE

Allow overlapping cells.

 

FALSE

Do not allow overlapping cells.

clrRectBackColor

Specifies the background color of the cell rectangle in design mode.

clrRectForeColor

Specifies the foreground color of the cell rectangle in design mode.

clrGridColor

Specifies the color of the layout grid in design mode.

bShowLayoutPosition

Flag that indicates whether to display cell locations in design mode. Possible values are:

 

Value

Meaning

 

TRUE

Display cell positions.

 

FALSE

Do not display cell positions.

bShowLines

Flag that indicates whether to display grid lines in design mode. Possible values are:

 

Value

Meaning

 

TRUE

Display grid lines.

 

FALSE

Do not display grid lines.

Comments

This structure is used by the LImageViewer::SetProperties and LImageViewer::GetProperties functions.