ImageBackgroundFill Class
Provides a class that draws an image as a background fill.
public class ImageBackgroundFill : BackgroundFill, ICloneable
- Inheritance:
- object BackgroundFill object
- Implements:
- ICloneable
Constructors
ImageBackgroundFill()
Initializes a new instance of the ImageBackgroundFill
class.
public ImageBackgroundFill()
Remarks
The default constructor initializes all fields to their default values.
ImageBackgroundFill(ImageBackgroundFill)
Initializes a new instance of the ImageBackgroundFill
class.
protected ImageBackgroundFill(ImageBackgroundFill copyFrom)
Parameter | Type | Description |
---|---|---|
copyFrom | ImageBackgroundFill | An instance of |
Remarks
This constructor used in support of Clone() for base classes to initialize their fields.
ImageBackgroundFill(Image)
Initializes a new instance of the ImageBackgroundFill
class.
public ImageBackgroundFill(Image image)
Parameter | Type | Description |
---|---|---|
image | Image | The image to tile in the background. |
ImageBackgroundFill(Image, ImageBackgroundFillStyle)
Initializes a new instance of the ImageBackgroundFill
class.
public ImageBackgroundFill(Image image, ImageBackgroundFillStyle style)
Parameter | Type | Description |
---|---|---|
image | Image | The image to tile in the background. |
style | ImageBackgroundFillStyle | The style of the image. |
Properties
Image
Gets or sets the image to tile in the background.
Style
Gets or sets the style of the image.
public ImageBackgroundFillStyle Style { get; set; }
Property Value
- ImageBackgroundFillStyle:
A ImageBackgroundFillStyle object containing the style of the image.
Methods
Clone()
Creates an exact duplicate of the BackgroundFill object.
public override BackgroundFill Clone()
Returns
- BackgroundFill:
An exact duplicate of the BackgroundFill object.
Draw(Graphics, Rectangle, Rectangle, Image)
Fills an area with the background fill.
public static void Draw(Graphics g, Rectangle bounds, Rectangle brushBounds, Image image)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
bounds | Rectangle | The bounds of the area to paint. |
brushBounds | Rectangle | The reference bounds for the brush. |
image | Image | The image to tile in the background. |
Draw(Graphics, Rectangle, Rectangle, Image, ImageBackgroundFillStyle)
Fills an area with the background fill.
public static void Draw(Graphics g, Rectangle bounds, Rectangle brushBounds, Image image, ImageBackgroundFillStyle style)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
bounds | Rectangle | The bounds of the area to paint. |
brushBounds | Rectangle | The reference bounds for the brush. |
image | Image | The image to tile in the background. |
style | ImageBackgroundFillStyle | The style of the image. |
DrawScaled(Graphics, Rectangle, Rectangle, Sides, SizeF)
Fills an area with the background fill.
public override void DrawScaled(Graphics g, Rectangle bounds, Rectangle brushBounds, Sides side, SizeF scaleFactor)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
bounds | Rectangle | The bounds of the area to paint. |
brushBounds | Rectangle | The reference bounds for the brush. |
side | Sides | The side with which the background fill should be oriented. |
scaleFactor | SizeF | The factor of the scale transform to be applied where Width is applied to the x-axis, and Height is applied to the y-axis. |
DrawScaled(Graphics, Rectangle, Rectangle, Image, ImageBackgroundFillStyle, SizeF)
Fills an area with the background fill.
public static void DrawScaled(Graphics g, Rectangle bounds, Rectangle brushBounds, Image image, ImageBackgroundFillStyle style, SizeF scaleFactor)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
bounds | Rectangle | The bounds of the area to paint. |
brushBounds | Rectangle | The reference bounds for the brush. |
image | Image | The image to tile in the background. |
style | ImageBackgroundFillStyle | The style of the image. |
scaleFactor | SizeF | The factor of the scale transform to be applied where Width is applied to the x-axis, and Height is applied to the y-axis. |
DrawScaled(Graphics, Rectangle, Rectangle, Image, SizeF)
Fills an area with the background fill.
public static void DrawScaled(Graphics g, Rectangle bounds, Rectangle brushBounds, Image image, SizeF scaleFactor)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
bounds | Rectangle | The bounds of the area to paint. |
brushBounds | Rectangle | The reference bounds for the brush. |
image | Image | The image to tile in the background. |
scaleFactor | SizeF | The factor of the scale transform to be applied where Width is applied to the x-axis, and Height is applied to the y-axis. |
Equals(object)
Determines whether the specified Object
is equal to the current Object
.
public override bool Equals(object obj)
Parameter | Type | Description |
---|---|---|
obj | object | The |
Returns
- bool:
true
if the specifiedObject
is equal to the currentObject
; otherwise,false
.
GetBrush(Rectangle, Sides)
Gets a Brush that represents the background fill.
public override Brush GetBrush(Rectangle bounds, Sides side)
Parameter | Type | Description |
---|---|---|
bounds | Rectangle | The bounds of the area to paint. |
side | Sides | The side with which the background fill should be oriented. |
Returns
GetHashCode()
Returns a hash code for this object.
public override int GetHashCode()
Returns
- int:
An integer value that specifies a hash value for this object.
ResetImage()
Resets the Image property to its default value.
public virtual void ResetImage()
ResetStyle()
Resets the Style property to its default value.
public virtual void ResetStyle()
ShouldSerializeImage()
Indicates whether the Image property should be persisted.
public virtual bool ShouldSerializeImage()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeStyle()
Indicates whether the Style property should be persisted.
public virtual bool ShouldSerializeStyle()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
Inherited Members
- BackgroundFill.Draw(Graphics, Rectangle)
- BackgroundFill.Draw(Graphics, Rectangle, Rectangle)
- BackgroundFill.Draw(Graphics, Rectangle, Sides)
- BackgroundFill.Draw(Graphics, Rectangle, Rectangle, Sides)
- BackgroundFill.DrawScaled(Graphics, Rectangle, SizeF)
- BackgroundFill.DrawScaled(Graphics, Rectangle, Rectangle, SizeF)
- BackgroundFill.DrawScaled(Graphics, Rectangle, Sides, SizeF)
- BackgroundFill.OnPropertyChanged(EventArgs)
- BackgroundFill.PropertyChanged
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object, object)
- object.ReferenceEquals(object, object)