IncludedParameters property (ILImageOverlayBox Interface)
|
OverlayBoxParameterEnum IncludedParameters | |
|
Overview |
Refer to Print Management SCU. |
Remarks
The IncludedParameters property specifies the parameters to be included when creating/updating Image Overlay Boxes. It can be set to any combination of the following values:
|
Value |
Meaning |
|
OB_OVERLAY_FILENAME |
[0x01] If no Overlay data is specified when calling the Update method, the method will use the Overlay data contained in the Data Set file specified by the OverlayFilename property. |
|
OB_OVERLAY_ORIGIN |
[0x02] When calling the Update method, the Overlay Origin will be updated as specified by the OverlayOriginRow property and OverlayOriginColumn property. |
|
OB_OVERLAY_MAGNIFICATION_TYPE |
[0x04] Includes the parameter specified by the OverlayMagnificationType property. |
|
OB_OVERLAY_SMOOTHING_TYPE |
[0x08] Includes the parameter specified by the OverlaySmoothingType property. |
|
OB_OVERLAY_IMAGE_MAGNIFICATION |
[0x10] Includes the parameters specified by the OverlayOrImageMagnification property and MagnifyToNumberOfColumns property. |
|
OB_OVERLAY_FOREGROUND_DENSITY |
[0x20] Includes the parameter specified by the OverlayForegroundDensity property. |
|
OB_OVERLAY_BACKGROUND_DENSITY |
[0x40] Includes the parameter specified by the OverlayBackgroundDensity property. |
|
OB_ALL_PARAMETERS |
[0x7F] Combines all the above values and hence includes all the parameters. |
The property can also be set to 0; in this case, none of the parameters will be included.
If a parameter is not specified by the IncludedParameters property, the corresponding Attribute will not be included in the request to the Print SCP. Refer to the Create method and Update method for more details on the Overlay data.
The default value of this property is OB_OVERLAY_FILENAME.
See Also
|
Elements: |
|
|
Topics: |