Class PdfXfaCircleField

Represents the circle of the XFA form.

Inheritance

System.Object

PdfXfaField

PdfXfaCircleField

Inherited Members

PdfXfaField.Margins

PdfXfaField.Name

PdfXfaField.Visibility

Namespace: Syncfusion.Pdf.Xfa

Assembly: Syncfusion.Pdf.NET.dll

Syntax

public class PdfXfaCircleField : PdfXfaField

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.

Declaration

public PdfXfaCircleField(string name, SizeF size)

Parameters

Type	Name	Description
System.String	name	Name of the field
SizeF	size	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, Single, Single)

Initialize a new instance of the PdfXfaCircleField class.

Declaration

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

Parameters

Type	Name	Description
System.String	name	Name of the field.
System.Single	width	width of the field.
System.Single	height	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

Declaration

public PdfXfaCircleAppearance Appearance { get; set; }

Property Value

Type
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

Declaration

public PdfXfaBorder Border { get; set; }

Property Value

Type
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

Declaration

public float Height { get; set; }

Property Value

Type
System.Single

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

Declaration

public PdfXfaRotateAngle Rotate { get; set; }

Property Value

Type
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

Declaration

public int StartAngle { get; set; }

Property Value

Type
System.Int32

Remarks

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

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()

SweepAngle

Gets or sets the sweep angle of the Arc

Declaration

public int SweepAngle { get; set; }

Property Value

Type
System.Int32

Remarks

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

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()

ToolTip

Gets or sets the tool tip of the circle

Declaration

public string ToolTip { get; set; }

Property Value

Type
System.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

Declaration

public float Width { get; set; }

Property Value

Type
System.Single

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.

Declaration

public object Clone()

Returns

Type	Description
System.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()