IncludedParameters property (ILImageBox Interface)

VB.NET example

C# example

Visual Basic example

Visual C++ 6.0 example

 

Syntax

ImageBoxParameterEnum IncludedParameters

Overview

Refer to Print Management SCU.

Remarks

The IncludedParameters property specifies the parameters to be included when updating the Image Box. It can be set to any combination of the following values:

Value

Meaning

IB_IMAGE_FILENAME

[0x001] If no image is specified when calling the Update method, the image to be printed in the Image Box is the one contained in the Data Set file specified by the ImageFilename property.

IB_POLARITY

[0x002] Includes the parameter specified by the Polarity property.

IB_MAGNIFICATION_TYPE

[0x004] Includes the parameter specified by the MagnificationType property.

IB_SMOOTHING_TYPE

[0x008] Includes the parameter specified by the SmoothingType property.

IB_MIN_DENSITY

[0x010] Includes the parameter specified by the MinDensity property (only for Grayscale Image Boxes).

IB_MAX_DENSITY

[0x020] Includes the parameter specified by the MaxDensity property (only for Grayscale Image Boxes).

IB_CONFIGURATION_INFORMATION

[0x040] Includes the parameter specified by the ConfigurationInformation property (only for Grayscale Image Boxes).

IB_REQUESTED_IMAGE_SIZE

[0x080] Includes the parameter specified by the RequestedImageSize property.

IB_REQUESTED_DECIMATE_CROP_BEHAVIOR

[0x100] Includes the parameter specified by the RequestedDecimateCropBehavior property.

IB_REF_IMAGE_OVERLAY_BOX_INSTANCE_UID

[0x200] Includes the parameter specified by the RefImageOverlayBoxInstanceUID property.

IB_REF_PRES_LUT_INSTANCE_UID

[0x400] Includes the parameter specified by the RefPresLUTInstanceUID property (only for Grayscale Image Boxes).

IB_ALL_PARAMETERS

[0x7FF] 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 and hence will not be updated. Refer to the Update method for more details on the image to be printed in the Image Box.

The default value of this property is IB_IMAGE_FILENAME.

See Also

Elements:

Update method

Topics:

DICOM Print Management SCU: Basic Print Management