com.esri.arcgis.output
Interface IColorCorrection

All Superinterfaces:
Serializable
All Known Implementing Classes:
PSDriver, PsPrinter

public interface IColorCorrection
extends Serializable

Provides access to members that control the Color Correction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 short getCMYKCorrection(int dataType, int index)
          The Color Correction for the CMYK color model.
 short getLightness(int dataType)
          The Lightness Value of the HLS Color Model.
 short getSaturation(int dataType)
          The Saturation Value of the HLS Color Model.
 short getSupportedColorCorrections()
          The dataType supported: 1 Total, 2 Raster, 4 Vector.
 short getUnderColorRemoval(int dataType)
          The Undercolor Removal Value.
 void setCMYKCorrection(int dataType, int index, short val)
          The Color Correction for the CMYK color model.
 void setLightness(int dataType, short val)
          The Lightness Value of the HLS Color Model.
 void setSaturation(int dataType, short val)
          The Saturation Value of the HLS Color Model.
 void setUnderColorRemoval(int dataType, short val)
          The Undercolor Removal Value.
 

Method Detail

getSupportedColorCorrections

short getSupportedColorCorrections()
                                   throws IOException,
                                          AutomationException
The dataType supported: 1 Total, 2 Raster, 4 Vector.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLightness

short getLightness(int dataType)
                   throws IOException,
                          AutomationException
The Lightness Value of the HLS Color Model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLightness

void setLightness(int dataType,
                  short val)
                  throws IOException,
                         AutomationException
The Lightness Value of the HLS Color Model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
val - The val (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSaturation

short getSaturation(int dataType)
                    throws IOException,
                           AutomationException
The Saturation Value of the HLS Color Model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSaturation

void setSaturation(int dataType,
                   short val)
                   throws IOException,
                          AutomationException
The Saturation Value of the HLS Color Model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
val - The val (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnderColorRemoval

short getUnderColorRemoval(int dataType)
                           throws IOException,
                                  AutomationException
The Undercolor Removal Value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnderColorRemoval

void setUnderColorRemoval(int dataType,
                          short val)
                          throws IOException,
                                 AutomationException
The Undercolor Removal Value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
val - The val (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCMYKCorrection

short getCMYKCorrection(int dataType,
                        int index)
                        throws IOException,
                               AutomationException
The Color Correction for the CMYK color model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
index - A com.esri.arcgis.output.esriCMYKIndex constant (in)
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCMYKCorrection

void setCMYKCorrection(int dataType,
                       int index,
                       short val)
                       throws IOException,
                              AutomationException
The Color Correction for the CMYK color model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dataType - A com.esri.arcgis.output.esriColorCorrectionDataType constant (in)
index - A com.esri.arcgis.output.esriCMYKIndex constant (in)
val - The val (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.