DISPANNOTATIONPROPS
typedef struct tagDISPANNOTATIONPROPS
{
L_UINT uStructSize;
COLORREF crAnnotationColor;
L_UINT bSimpleRuler;
L_BOOL bCreateFromCenter;
L_UINT uFlags;
} DISPANNOTATIONPROPS, * pDISPANNOTATIONPROPS;
The DISPANNOTATIONPROPS structure contains options for controlling the annotation objects appearance and behavior.
Member |
Description |
|
uStructSize |
Size of this structure in bytes, for versioning. Use the sizeof() function to calculate this value. |
|
crAnnotationColor |
COLORREF value that specified the annotation color. This color will be applied as the default color for the newly created annotation if uFlags was set to DCANNOTATION_APPLYCOLOR_FORNEW. |
|
bSimpleRuler |
Flag that indicates whether to show the annotation ruler with tick marks. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
The ruler will not have tick marks; it will be like a simple line. This is the default value. |
|
FALSE |
The ruler will have tick marks and gauges. |
|
|
|
bCreateFromCenter |
Flag that indicates whether to create the symmetrical annotation objects (Rectangle, ellipse and hilite) from center to edge or from edge to edge. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
Create annotation objects from center to edge. |
|
FALSE |
Create annotation objects from edge to edge. This is the default value. |
uFlags |
Flags the control the behavior of the annotation object. You can combine values together when appropriate by using a bitwise OR ( | ). Possible values are: |
|
|
Flags determine on which annotation object the new setting will be applied: |
|
|
Value |
Meaning |
|
DCANNOTATION_APPLYTO_SELECTED |
[0x00000000] Apply on selected object. |
|
DCANNOTATION_APPLYTO_ALLOBJECT |
[0x00000010] Apply on objects that have the same type. (All rulers or all arrows). |
|
DCANNOTATION_APPLYTO_ALL |
[0x00000020] Apply on all annotation objects. |
|
Flag sets the options in this structure as the default options for the newly created annotation objects: |
|
|
Value |
Meaning |
|
DCANNOTATION_APPLYCOLOR_FORNEW |
[0x00000100] The new setting will be the default setting for the annotation object that will be created. |
Comments
This structure is used by L_DispContainerSetActionProperties and L_DispContainerGetActionProperties functions.
This structure is mainly used to change or retrieve the properties of the annotation objects, and it works only with the following actions:
CONTAINER_ACTION_ANNOTATION_RULER
CONTAINER_ACTION_ANNOTATION_ANGLE
CONTAINER_ACTION_ANNOTATION_TEXT
CONTAINER_ACTION_ANNOTATION_ARROW
CONTAINER_ACTION_ANNOTATION_RECTANGLE
CONTAINER_ACTION_ANNOTATION_ELLIPSE
CONTAINER_ACTION_ANNOTATION_HILITE