References ▼
#include "ltivw.h"
L_LTIVW_API L_INT L_DispContainerSetActionProperties(hCellWnd, nAction, nSubCellIndex, pActionProperties, uFlags)
Sets the properties of a specific action.
A handle to the window that represents the cell on which the function's effect will be applied.
Value that represents the actions for which to set the properties. If nAction is equal to or greater than 100 it is a user-defined action. Otherwise, it can be one of the following predefined actions:
| Value | Meaning |
|---|---|
| CONTAINER_ACTION_WINDOWLEVEL | [1] Window leveling |
| CONTAINER_ACTION_SCALE | [2] Scaling |
| CONTAINER_ACTION_OFFSET | [3] Offset |
| CONTAINER_ACTION_STACK | [4] Stacking |
| CONTAINER_ACTION_MAG | [5] Magnifying glass |
| CONTAINER_ACTION_ALPHA | [6] Alpha |
| CONTAINER_ACTION_ANNOTATION_RULER | [7] Ruler annotation |
| CONTAINER_ACTION_ANNOTATION_ANGLE | [8] Angle annotation |
| CONTAINER_ACTION_ANNOTATION_TEXT | [9] Text annotation |
| CONTAINER_ACTION_ANNOTATION_ARROW | [10] Arrow annotation |
| CONTAINER_ACTION_ANNOTATION_RECTANGLE | [11] Rectangle annotation |
| CONTAINER_ACTION_ANNOTATION_ELLIPSE | [12] Ellipse annotation |
| CONTAINER_ACTION_ANNOTATION_HILITE | [13] Highlight annotation |
| CONTAINER_ACTION_REGION_RECTANGLE | [14] Rectangular region |
| CONTAINER_ACTION_REGION_ELLIPSE | [15] Elliptical region |
| CONTAINER_ACTION_REGION_FREEHAND | [16] Free hand region |
| CONTAINER_ACTION_REGION_POLYGON | [17] Polygon region |
| CONTAINER_ACTION_REGION_MAGICWAND | [18] Magic wand (contiguous color) region |
| CONTAINER_ACTION_REGION_COLORRANGE | [19] Color range region |
| CONTAINER_ACTION_REGION_CIRCLE | [20] Circular region |
| CONTAINER_ACTION_REGION_SQUARE | [21] Square region |
| CONTAINER_ACTION_REGION_NUDGETOOL | [22] Nudge tool |
| CONTAINER_ACTION_REGION_SHRINKTOOL | [23] Shrink tool |
A zero-based index into the image list attached to the cell specified in nCellIndex. This parameter is only valid when CONTAINER_ACTION_CELLLEVEL is set in uFlags. If uFlags contains CONTAINER_ACTION_CONTAINERLEVEL, this parameter is ignored. Pass -1 to set the properties of a specific action on all sub-cells. Pass -2 to set the properties of a specific action on the selected sub-cell.
Pointer to a structure that contains the properties to be set. The type of structure pointed to depends on the action specified in the nAction parameter.
| If nAction contains: | then pActionProperties points to this structure: |
|---|---|
| CONTAINER_ACTION_WINDOWLEVEL | DISPWLEVELACTIONPROPS |
| CONTAINER_ACTION_SCALE | DISPSCALEACTIONPROPS |
| CONTAINER_ACTION_OFFSET | DISPOFFSETACTIONPROPS |
| CONTAINER_ACTION_STACK | DISPSTACKACTIONPROPS |
| CONTAINER_ACTION_MAG | DISPMAGACTIONPROPS |
| CONTAINER_ACTION_ALPHA | DISPALPHAACTIONPROPS |
| CONTAINER_ACTION_ANNOTATION_RULER | DISPANNOTATIONPROPS |
| CONTAINER_ACTION_ANNOTATION_ANGLE | DISPANNOTATIONPROPS |
| CONTAINER_ACTION_ANNOTATION_TEXT | DISPANNOTATIONPROPS |
| CONTAINER_ACTION_ANNOTATION_ARROW | DISPANNOTATIONPROPS |
| CONTAINER_ACTION_ANNOTATION_RECTANGLE | DISPANNOTATIONPROPS |
| CONTAINER_ACTION_ANNOTATION_ELLIPSE | DISPANNOTATIONPROPS |
| CONTAINER_ACTION_ANNOTATION_HILITE | DISPANNOTATIONPROPS |
| CONTAINER_ACTION_REGION_RECTANGLE | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_ELLIPSE | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_FREEHAND | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_POLYGON | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_MAGICWAND | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_COLORRANGE | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_CIRCLE | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_SQUARE | DISPREGIONPROPS |
| CONTAINER_ACTION_REGION_NUDGETOOL | DISPNUDGETOOLACTIONPROPS |
| CONTAINER_ACTION_REGION_SHRINKTOOL | DISPNUDGETOOLACTIONPROPS |
| Owner Action | DISPOWNERACTIONPROPS |
Flag that determines which properties to set. Possible values are:
| Value | Meaning |
|---|---|
| CONTAINER_ACTION_CONTAINERLEVEL | [0x00000000] Set the general properties. |
| CONTAINER_ACTION_CELLLEVEL | [0x00000001] Set the specific properties. |
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
Each of the structures that may be pointed to by pActionProperties contains a member that is a DISPCONTAINERACTIONPROPS structure. Each of these structures also contains one or more other members. The DISPCONTAINERACTIONPROPS structure contains "general properties" that are common to all actions. The other members of the structures are considered may be "general properties" or "specific properties", depending on whether they are applied at the container level or the cell level. Those members that are applied at the container level are also considered "general properties". Members that are applied at the cell level or the sub-cell level are considered "specific properties". For example, if this function is called to set the scale action properties, a variable of type DISPSCALEACTIONPROPS should be declared and the members of that structure set to the desired values. Pass a pointer to this structure for the pActionProperties parameter. To set only the general properties, set uFlags to CONTAINER_ACTION_CONTAINERLEVEL. To set the specific properties, set uFlags to CONTAINER_ACTION_CELLLEVEL.
If this function is not called before applying the action to the container/cell, the default values are used. For more information on these default values, refer to the structures associated with each action.
Required DLLs and Libraries
For an example, refer to L_DispContainerCreate.