PdfFillFormat Class

Namespace:
GemBox.Pdf.Content
Assembly:
GemBox.Pdf.dll

Represents formatting properties that affect filling of PDF textual or geometrical content.

public sealed class PdfFillFormat
Public NotInheritable Class PdfFillFormat
Inheritance:
System.Object
PdfFillFormat
Remarks

The PdfFillFormat is always applicable to PdfFormContent, is applicable to PdfTextContent and PdfPathContent if IsApplied is true, and is not applicable to any other PdfVisualContentElement. The Opacity is, additionally, applicable to PdfImageContent and PdfShadingContent.

If the PdfFillFormat is not applicable, then fill-related graphics state parameters won't be written when writing the associated PdfVisualContentElement to the underlying content stream.

Properties

Color

Gets or sets the fill color.

Initial value: Black.

public PdfColor Color { get; set; }
Public Property Color As PdfColor
Property Value
PdfColor

The fill color.

Remarks

If Space or Pattern of a PdfColor value that is being set is associated with another PdfDocument, this property setter will automatically clone it and associate the clone with the current PdfDocument.

See Also

IsApplied

Gets or sets a value indicating whether the current PDF textual or geometrical content is filled.

Initial value: false for PdfPathContent; otherwise, true.

public bool IsApplied { get; set; }
Public Property IsApplied As Boolean
Property Value
System.Boolean

true if the current PDF textual or geometrical content is filled; otherwise, false.

See Also

Opacity

Gets or sets the fill opacity.

Initial value: 1.0.

public double Opacity { get; set; }
Public Property Opacity As Double
Property Value
System.Double

The fill opacity.

Remarks

A value of 1 specifies that the fill is completely opaque; a value of 0 specifies that it is completely transparent.

Exceptions
System.ArgumentOutOfRangeException

Value is not between 0 and 1 (inclusive).

See Also

Rule

Gets or sets the rule used to specify the interior of the PDF textual or geometrical content that is filled.

Initial value: NonzeroWindingNumber.

public PdfFillRule Rule { get; set; }
Public Property Rule As PdfFillRule
Property Value
PdfFillRule

The rule used to specify the interior of the PDF textual or geometrical content that is filled.

Exceptions
System.ArgumentOutOfRangeException

Value is not between NonzeroWindingNumber and EvenOdd.

See Also

Examples

See Also