Get Started

API Reference

Class

PdfPageBackgroundShape

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:14
Modifiers sealed

Reusable page background shape rendered behind page content.

Inheritance

  • Object
  • PdfPageBackgroundShape

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public PdfPageBackgroundShape(OfficeShape shape, Double x, Double y) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:14

Creates a page background shape at an absolute page position in points.

Parameters

shape OfficeIMO.Drawing.OfficeShape requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2

Methods

public static PdfPageBackgroundShape BottomBand(Double pageWidth, Double pageHeight, Double height, Nullable<PdfColor> fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:88
Returns: PdfPageBackgroundShape

Creates a full-width band anchored to the bottom of a page.

Parameters

pageWidth System.Double requiredposition: 0
pageHeight System.Double requiredposition: 1
height System.Double requiredposition: 2
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
insetX System.Double = 0 optionalposition: 4
offsetY System.Double = 0 optionalposition: 5
cornerRadius System.Double = 0 optionalposition: 6
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 7
strokeWidth System.Double = 0 optionalposition: 8
fillOpacity System.Nullable{System.Double} = null optionalposition: 9
strokeOpacity System.Nullable{System.Double} = null optionalposition: 10
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 11
public PdfPageBackgroundShape Clone() #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:130
Returns: PdfPageBackgroundShape

Creates a deep copy of this page background shape.

public static PdfPageBackgroundShape Ellipse(Double x, Double y, Double width, Double height, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:66
Returns: PdfPageBackgroundShape

Creates an ellipse background shape.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
public static PdfPageBackgroundShape LeftBand(Double pageWidth, Double pageHeight, Double width, Nullable<PdfColor> fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:102
Returns: PdfPageBackgroundShape

Creates a full-height band anchored to the left side of a page.

Parameters

pageWidth System.Double requiredposition: 0
pageHeight System.Double requiredposition: 1
width System.Double requiredposition: 2
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
insetY System.Double = 0 optionalposition: 4
offsetX System.Double = 0 optionalposition: 5
cornerRadius System.Double = 0 optionalposition: 6
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 7
strokeWidth System.Double = 0 optionalposition: 8
fillOpacity System.Nullable{System.Double} = null optionalposition: 9
strokeOpacity System.Nullable{System.Double} = null optionalposition: 10
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 11
public static PdfPageBackgroundShape Rectangle(Double x, Double y, Double width, Double height, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:52
Returns: PdfPageBackgroundShape

Creates a rectangle background shape.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
public static PdfPageBackgroundShape RightBand(Double pageWidth, Double pageHeight, Double width, Nullable<PdfColor> fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:116
Returns: PdfPageBackgroundShape

Creates a full-height band anchored to the right side of a page.

Parameters

pageWidth System.Double requiredposition: 0
pageHeight System.Double requiredposition: 1
width System.Double requiredposition: 2
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
insetY System.Double = 0 optionalposition: 4
offsetX System.Double = 0 optionalposition: 5
cornerRadius System.Double = 0 optionalposition: 6
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 7
strokeWidth System.Double = 0 optionalposition: 8
fillOpacity System.Nullable{System.Double} = null optionalposition: 9
strokeOpacity System.Nullable{System.Double} = null optionalposition: 10
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 11
public static PdfPageBackgroundShape RoundedRectangle(Double x, Double y, Double width, Double height, Double cornerRadius, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:59
Returns: PdfPageBackgroundShape

Creates a rounded rectangle background shape.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
cornerRadius System.Double requiredposition: 4
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 6
strokeWidth System.Double = 0 optionalposition: 7
fillOpacity System.Nullable{System.Double} = null optionalposition: 8
strokeOpacity System.Nullable{System.Double} = null optionalposition: 9
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 10
public static PdfPageBackgroundShape TopBand(Double pageWidth, Double pageHeight, Double height, Nullable<PdfColor> fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:73
Returns: PdfPageBackgroundShape

Creates a full-width band anchored to the top of a page.

Parameters

pageWidth System.Double requiredposition: 0
pageHeight System.Double requiredposition: 1
height System.Double requiredposition: 2
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 3
insetX System.Double = 0 optionalposition: 4
offsetY System.Double = 0 optionalposition: 5
cornerRadius System.Double = 0 optionalposition: 6
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 7
strokeWidth System.Double = 0 optionalposition: 8
fillOpacity System.Nullable{System.Double} = null optionalposition: 9
strokeOpacity System.Nullable{System.Double} = null optionalposition: 10
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 11

Properties

public OfficeShape Shape { get; set; } #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:25

Shape geometry and styling. Coordinates use the page bottom-left origin.

public Double X { get; set; } #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:34

Left position in points from the page left edge. Negative values are allowed for bleed-style decoration.

public Double Y { get; set; } #
OfficeIMO.Pdf/Model/PdfPageBackgroundShape.cs:43

Bottom position in points from the page bottom edge. Negative values are allowed for bleed-style decoration.