AnnotBorder

From PDF XChange PDF SDK
Jump to: navigation, search
(Label ToWrite removed)
Line 58: Line 58:
 
Specifies the dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.
 
Specifies the dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.
 
|}
 
|}
 +
 +
== Sample ==
 +
<pre class="brush:c#">//C#
 +
var border = new PDFXEdit.PXC_AnnotBorder();
 +
border.nStyle = PDFXEdit.PXC_AnnotBorderStyle.ABS_Dashed;
 +
border.nWidth = 4.0f;
 +
border.DashArray = new float[10];
 +
border.DashArray[0] = border.DashArray[1] = 16.0f; //Width of dashes
 +
border.nDashCount = 2; //Number of dashes
 +
</pre>
  
 
== See Also ==
 
== See Also ==
 
[[PXV:op_annots_setProps]]
 
[[PXV:op_annots_setProps]]

Revision as of 06:23, 1 March 2016


Options Table

Name Type Value
S Integer Specifies the annotation's border style

Possible values are:

0 (Solid) A solid border surrounding the annotation
1 (Dashed) A dashed rectangle surrounding the annotation. The dash

pattern may be specified by the D entry.

2 (Bevelled) A simulated embossed rectangle that appears to be raised above the surface of the page.
3 (Inset) A simulated engraved rectangle that appears to be recessed below the surface of the page.
4 (Underline) A single line along the bottom of the annotation rectangle.

Default value: 0 (Solid)

E Integer Specifies the annotation's border style effect

Possible values are:

0 (Standard) No effect.
1 (Cloudy) The border should appear “cloudy”.

Default value: 0 (Solid)

EL Double Specifies the effect level.

Default value: 1.0

W Double Specifies the border width.

Default value: 1.0

D Array Array of Double

Specifies the dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.

Sample

//C#
	var border = new PDFXEdit.PXC_AnnotBorder();
	border.nStyle = PDFXEdit.PXC_AnnotBorderStyle.ABS_Dashed;
	border.nWidth = 4.0f;
	border.DashArray = new float[10];
	border.DashArray[0] = border.DashArray[1] = 16.0f; //Width of dashes
	border.nDashCount = 2; //Number of dashes

See Also

op.annots.setProps