Class PdfXfaCircleField

Namespace

Syncfusion.Pdf.Xfa

Assembly

Syncfusion.Pdf.Portable.dll

Represents the circle of the XFA form.

public class PdfXfaCircleField : PdfXfaField

Inheritance

object

PdfXfaField

PdfXfaCircleField

Inherited Members

PdfXfaField.Name

PdfXfaField.Margins

PdfXfaField.Visibility

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Constructors

PdfXfaCircleField(string, SizeF)

Initialize a new instance of the PdfXfaCircleField class.

public PdfXfaCircleField(string name, SizeF size)

Parameters

name string

Name of the field

size SizeF

size of the field

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

PdfXfaCircleField(string, float, float)

Initialize a new instance of the PdfXfaCircleField class.

public PdfXfaCircleField(string name, float width, float height)

Parameters

name string

Name of the field.

width float

width of the field.

height float

height of the field.

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", 100, 100);
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", 100, 100)
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Properties

Appearance

Gets or sets the apperance of the circle field

public PdfXfaCircleAppearance Appearance { get; set; }

Property Value

PdfXfaCircleAppearance

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set start angle.
circle.StartAngle = 90;
//Set sweep angle.
circle.SweepAngle = 270;
//Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc;
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set start angle.
circle.StartAngle = 90
'Set sweep angle.
circle.SweepAngle = 270
'Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Border

Gets or sets the border of the circle

public PdfXfaBorder Border { get; set; }

Property Value

PdfXfaBorder

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Height

Gets or sets height of the field

public float Height { get; set; }

Property Value

float

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Set height.
circle.Height = 200;
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Set height.
circle.Height = 200
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Rotate

Gets or sets the rotation angle

public PdfXfaRotateAngle Rotate { get; set; }

Property Value

PdfXfaRotateAngle

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set start angle.
circle.StartAngle = 90;
//Set sweep angle.
circle.SweepAngle = 270;
//Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc;
//Set rotation.
circle.Rotate = PdfXfaRotateAngle.RotateAngle270;
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set start angle.
circle.StartAngle = 90
'Set sweep angle.
circle.SweepAngle = 270
'Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc
'Set rotation.
circle.Rotate = PdfXfaRotateAngle.RotateAngle270
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

StartAngle

Gets or sets the start angle of the arc

public int StartAngle { get; set; }

Property Value

int

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set start angle.
circle.StartAngle = 90;
//Set sweep angle.
circle.SweepAngle = 270;
//Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc;
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set start angle.
circle.StartAngle = 90
'Set sweep angle.
circle.SweepAngle = 270
'Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Remarks

The start angle only support when the circle is an arc type.

SweepAngle

Gets or sets the sweep angle of the Arc

public int SweepAngle { get; set; }

Property Value

int

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set start angle.
circle.StartAngle = 90;
//Set sweep angle.
circle.SweepAngle = 270;
//Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc;
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set start angle.
circle.StartAngle = 90
'Set sweep angle.
circle.SweepAngle = 270
'Set the circle appearance.
circle.Appearance = PdfXfaCircleAppearance.Arc
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Remarks

The sweep angle only support when the circle is an arc type.

ToolTip

Gets or sets the tool tip of the circle

public string ToolTip { get; set; }

Property Value

string

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Width

Gets or sets width of the field

public float Width { get; set; }

Property Value

float

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Set the width.
circle.Width = 200;
//Add the field to form.
xfaForm.Fields.Add(circle);
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Set the width.
circle.Width = 200
'Add the field to form.
xfaForm.Fields.Add(circle)
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()

Methods

Clone()

Creates a new object that is a copy of the current instance.

public object Clone()

Returns

object

The copy of the new object for this instance

Examples

//Create a new PDF XFA document.
PdfXfaDocument document = new PdfXfaDocument();
//Create a form.
PdfXfaForm xfaForm = new PdfXfaForm(PdfXfaFlowDirection.Vertical, 595);
//Set margin of the form.            
xfaForm.Margins.All = 10;
//Create a new XFA circle field.
PdfXfaCircleField circle = new PdfXfaCircleField("circle1", new SizeF(100, 100));
//Set border.
circle.Border = new PdfXfaBorder();
//Set border color.
circle.Border.Color = new PdfColor(Color.Green);
//Set tooltip.
circle.ToolTip = "Circle";
//Add the field to form.
xfaForm.Fields.Add(circle);
//Clone the circle field.
xfaForm.Fields.Add(circle.Clone() as PdfXfaCircleField);  
document.XfaForm = xfaForm;
//Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic);
//Close the document
document.Close();

'Create a new PDF XFA document.
Dim document As New PdfXfaDocument()
'Create a form.
Dim xfaForm As New PdfXfaForm(PdfXfaFlowDirection.Vertical, 595)
'Set margin of the form.            
xfaForm.Margins.All = 10
'Create a new XFA circle field.
Dim circle As New PdfXfaCircleField("circle1", New SizeF(100, 100))
'Set border.
circle.Border = New PdfXfaBorder()
'Set border color.
circle.Border.Color = New PdfColor(Color.Green)
'Set tooltip.
circle.ToolTip = "Circle"
'Add the field to form.
xfaForm.Fields.Add(circle)
'Clone the circle field.
xfaForm.Fields.Add(TryCast(circle.Clone() , PdfXfaCircleField)) 
document.XfaForm = xfaForm
'Save the document.
document.Save("output.pdf", PdfXfaType.Dynamic)
'Close the document
document.Close()