DISPOFFSETACTIONPROPS

typedef struct tagDISPOFFSETACTIONPROPS
{
   DISPCONTAINERACTIONPROPS DispContainerActionProps;
   L_INT nXOffset;
   L_INT nYOffset;
   L_BOOL bRelativeSensitivity;
} DISPOFFSETACTIONPROPS, * pDISPOFFSETACTIONPROPS;

The DISPOFFSETACTIONPROPS structure contains the properties for controlling the Offset action.

Member

Description

DispContainerActionProps

A structure that contains the general action properties. This member is applied on the container

nXOffset

The X offset of the image. This value is given pixels and is with respect to the center of the cell. This member is applied on the cell level. Default is 0.

nYOffset

The Y offset of the image. This value is given pixels and is with respect to the center of the cell. This member is applied on the cell level. Default is 0.

bRelativeSensitivity

Flag that indicate whether to allow the control to adjust the offset action mouse sensitivity based on the current scale of the image. .This will allow more stable offset movement when the image is scaled up or scaled down. Possible values are:

 

Value

Meaning

 

TRUE

Use the relative sensitivtity feature.

 

FALSE

Don’t used the relative sensitivity feature. This is the default value.

Comments

For each action supported by the image viewer, there are general properties and specific properties. The general properties are those that are common to all actions and are applied at the container level. Each structure specific for an action contains a member that is a DISPCONTAINERACTIONPROPS structure and 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 "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".

To get or set the general action properties and any "Container-level" properties in this structure, call LImageViewer::GetActionProperties or LImageViewer::SetActionProperties with uFlags to CONTAINER_ACTION_CONTAINERLEVEL.

To get or set the specific action properties, "Cell-level" or "Sub-cell level" properties in this structure, call LImageViewer::GetActionProperties or LImageViewer::SetActionProperties with uFlags to CONTAINER_ACTION_CELLLEVEL.