PdfClipFormat Class

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

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

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

The PdfClipFormat is always applicable to PdfFormContent, is applicable to PdfTextContent and PdfPathContent if IsApplied is true, and is not applicable to any other PdfVisualContentElement.

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

Properties

IsApplied

Gets or sets a value indicating whether the current PDF textual or geometrical content is part of the clipping area.

Initial value: false.

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

true if the current PDF textual or geometrical content is part of the clipping area; otherwise, false.

See Also

Rule

Gets or sets the rule used to specify the interior of the PDF geometrical content that is part of the clipping area.

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 geometrical content that is part of the clipping area.

Remarks

This property can be set only to PdfPathContent. All other PdfVisualContentElement return the initial value (NonzeroWindingNumber).

See Also

Examples