CodeCarvings.Piczard
BackgroundColor Class
Members  See Also  Send Feedback
CodeCarvings.Piczard Namespace : BackgroundColor Class

Defines the color to use as background and the behavior to follow when an image format supports transparency. This class cannot be inherited.

Syntax

Visual Basic (Declaration)  
<TypeConverterAttribute("System.ComponentModel.ExpandableObjectConverter, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")>
<SerializableAttribute()>
Public NotInheritable Class BackgroundColor 
   Implements IJSONSerializable 
C#  
[TypeConverterAttribute("System.ComponentModel.ExpandableObjectConverter, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
[SerializableAttribute()]
public sealed class BackgroundColor : IJSONSerializable  

Remarks

BackgroundColor is a general-purpose class that allows to configure a color to use as background in 2 distinct situations:

  • When the output image format does not support transparency (e.g. JPEG).
    In this case Piczard always uses the color specified in the Value property of the BackgroundColor class.
  • When the output image format supports transparency (e.g. PNG).
    In this case there are two possibilities:
    • If the AutoUseTransparentColor property of the BackgroundColor class is set to true (default value), then Piczard use the Transparent color (in order to preserve the image transparency).
    • If the AutoUseTransparentColor property of the BackgroundColor class is set to false, then Piczard uses the color specified in the Value property of the BackgroundColor class.

 

The BackgroundColor class is used by the ImageProcessingJob class in order to manage the image background color settings.
It is also used by other Piczard filters (e.g. the CanvasColor property of the ImageCrop class).

For more information please see: Image Processing Job (Controlling the background color of images generated by Piczard).

 

Please note that, when an image is processed but not saved (e.g. when the GetProcessedImage method is invoked), then the BackgroundColor class acts as if the output image format supports transparency.


 

Inheritance Hierarchy

System.Object
   CodeCarvings.Piczard.BackgroundColor

Requirements

Namespace: CodeCarvings.Piczard

Platforms: Windows 8, Windows 7, Windows Vista, Windows XP Professional, Windows 2000 - Windows Server family: 2012, 2008.R2, 2008, 2003, 2000

Assembly: CodeCarvings.Piczard (in CodeCarvings.Piczard.dll)

See Also

©2013 Sergio Turolla. All Rights Reserved.