Class PdfBorderEffect

Represents the border effect style of the annotation.

Inheritance
System.Object
PdfBorderEffect
Implements
Namespace: Syncfusion.Pdf.Interactive
Assembly: Syncfusion.Pdf.UWP.dll
Syntax
public class PdfBorderEffect : Object, IPdfWrapper
Examples
//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Create a new page .
PdfPage page = document.Pages.Add();
//To specify the line end points.
int[] points = new int[] { 80, 420, 150, 420 ,40 ,800 };
//Create a polygon  annotation.
PdfPolygonAnnotation polygonannotation = new PdfPolygonAnnotation(points, "Polygon Annotation");
//Create pdf  border Effect.
PdfBorderEffect borderEffect = new PdfBorderEffect();
borderEffect.Style = PdfBorderEffectStyle.Cloudy;
borderEffect.Intensity = 1;
polygonannotation.BorderEffect = borderEffect;
//Add this annotation to a new page.
page.Annotations.Add(polygonannotation);
//Save the document to disk.
document.Save("Output.pdf");
//close the document.
document.Close(true);
'Create a new PDF document.
Dim document As New PdfDocument()
'Create a new page .
Dim page As PdfPage = document.Pages.Add()
'To specify the line end points.
Dim points() As Integer = { 80, 420, 150, 420, 40, 800 }
'Create a new Polygon annotation.
Dim polygonannotation As New PdfPolygonAnnotation(points, "Polygon Annotation")
'Create pdf  border Effect.
Dim borderEffect As New PdfBorderEffect()
borderEffect.Style = PdfBorderEffectStyle.Cloudy
borderEffect.Intensity=1;
polygonannotation.BorderEffect = borderEffect
'Add this annotation to a new page.
page.Annotations.Add(polygonannotation)
'Save the document to disk.
document.Save("Output.pdf")
'close the document.
document.Close(True)

Constructors

PdfBorderEffect()

Initializes a new instance of the PdfBorderEffect class.

Declaration
public PdfBorderEffect()
Examples
//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Create a new page .
PdfPage page = document.Pages.Add();
//To specify the line end points.
int[] points = new int[] { 80, 420, 150, 420 ,40 ,800 };
//Create a polygon  annotation.
PdfPolygonAnnotation polygonannotation = new PdfPolygonAnnotation(points, "Polygon Annotation");
//Create pdf  border effect.
PdfBorderEffect borderEffect = new PdfBorderEffect();
polygonannotation.BorderEffect = borderEffect;
//Add this annotation to a new page.
page.Annotations.Add(polygonannotation);
//Save the document to disk.
document.Save("Output.pdf");
//close the document.
document.Close(true);
'Create a new PDF document.
Dim document As New PdfDocument()
'Create a new page .
Dim page As PdfPage = document.Pages.Add()
'To specify the line end points.
Dim points() As Integer = { 80, 420, 150, 420, 40, 800 }
'Create a new polygon annotation.
Dim polygonannotation As New PdfPolygonAnnotation(points, "Polygon Annotation")
'Create pdf  border Effect.
Dim borderEffect As New PdfBorderEffect()
polygonannotation.BorderEffect = borderEffect
'Add this annotation to a new page.
page.Annotations.Add(polygonannotation)
'Save the document to disk.
document.Save("Output.pdf")
'close the document.
document.Close(True)

Properties

Intensity

Gets or sets the Intensity of border effect.

Declaration
public float Intensity { get; set; }
Property Value
Type Description
System.Single

The Intensity Specifies the available Intensity for a field border
Remarks

This property has store the range of value 0 to 2.

Examples
//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Create a new page .
PdfPage page = document.Pages.Add();
//To specify the line end points.
int[] points = new int[] { 80, 420, 150, 420 ,40 ,800 };
//Create a polygon  annotation.
//PdfPolygonAnnotation polygonannotation = new PdfPolygonAnnotation(points, "Polygon Annotation");
//Create pdf  border effect.
PdfBorderEffect borderEffect = new PdfBorderEffect();
borderEffect.Style = PdfBorderEffectStyle.Cloudy;
borderEffect.Intensity = 1;
polygonannotation.BorderEffect = borderEffect;
//Add this annotation to a new page.
page.Annotations.Add(polygonannotation);
//Save the document to disk.
document.Save("Output.pdf");
//close the document.
document.Close(true);
'Create a new PDF document.
Dim document As New PdfDocument()
'Create a new page .
Dim page As PdfPage = document.Pages.Add()
'To specify the line end points.
Dim points() As Integer = { 80, 420, 150, 420, 40, 800 }
'Create a new polygon annotation.
Dim polygonannotation As New PdfPolygonAnnotation(points, "Polygon Annotation")
'Create pdf  border Effect.
Dim borderEffect As New PdfBorderEffect()
borderEffect.Style = PdfBorderEffectStyle.Cloudy
borderEffect.Intensity=1;
polygonannotation.BorderEffect = borderEffect
'Add this annotation to a new page.
page.Annotations.Add(polygonannotation)
'Save the document to disk.
document.Save("Output.pdf")
'close the document.
document.Close(True)

Style

Gets or sets the border effect style.

Declaration
public PdfBorderEffectStyle Style { get; set; }
Property Value
Type Description
PdfBorderEffectStyle

The PdfBorderEffect Specifies the available styles for a field border
Examples
//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Create a new page .
PdfPage page = document.Pages.Add();
//To specify the line end points.
int[] points = new int[] { 80, 420, 150, 420 ,40 ,800 };
//Create a polygon  annotation.
PdfPolygonAnnotation polygonannotation = new PdfPolygonAnnotation(points, "Polygon Annotation");
//Create pdf  border Effect.
PdfBorderEffect borderEffect = new PdfBorderEffect();
PdfBorderEffectStyle effect = PdfBorderEffectStyle.Cloudy; 
borderEffect.Style = effect;
borderEffect.Intensity = 1;
polygonannotation.BorderEffect = borderEffect;
//Add this annotation to a new page.
page.Annotations.Add(polygonannotation);
//Save the document to disk.
document.Save("Output.pdf");
//close the document.
document.Close(true);
'Create a new PDF document.
Dim document As New PdfDocument()
'Create a new page .
Dim page As PdfPage = document.Pages.Add()
'To specify the line end points.
Dim points() As Integer = { 80, 420, 150, 420, 40, 800 }
'Create a new Polygon annotation.
Dim polygonannotation As New PdfPolygonAnnotation(points, "Polygon Annotation")
'Create pdf  border Effect.
Dim borderEffect As New PdfBorderEffect()
PdfBorderEffectStyle effect = PdfBrderEffectStle.Cloudy; 
borderEffect.Style = effect;
borderEffect.Intensity=1;
polygonannotation.BorderEffect = borderEffect
'Add this annotation to a new page.
page.Annotations.Add(polygonannotation)
'Save the document to disk.
document.Save("Output.pdf")
'close the document.
document.Close(True)

Methods

Initialize()

Initializes instance.

Declaration
protected void Initialize()

Explicit Interface Implementations

IPdfWrapper.Element

Gets the element.

Declaration
IPdfPrimitive IPdfWrapper.Element { get; }
Returns
Type
IPdfPrimitive

Implements

Extension Methods