AnnotBorder
From PDF XChange PDF SDK
(Created page with "Category:Editor {{#customTitle:AnnotBorder}} {{#parentPage:PXV:Params_CommonStructures|AnnotBorder|structure}} {{ToWrite}} {{ToReview}} == Options Table == {| class="wik...") |
(→Options Table) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:AnnotBorder}} | {{#customTitle:AnnotBorder}} | ||
{{#parentPage:PXV:Params_CommonStructures|AnnotBorder|structure}} | {{#parentPage:PXV:Params_CommonStructures|AnnotBorder|structure}} | ||
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| Line 14: | Line 14: | ||
| class="op_param_name" | S | | class="op_param_name" | S | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the annotation's [[PXV:PXC_AnnotBorderStyle|border style]] |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (Solid) || | + | | class="op_enum_value" | '''0''' (Solid) || A solid border surrounding the annotation. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (Dashed) || . | + | | class="op_enum_value" | '''1''' (Dashed) || A dashed rectangle surrounding the annotation. The dash pattern may be specified by the '''D''' entry. |
|- | |- | ||
| − | | class="op_enum_value" | '''2''' ( | + | | class="op_enum_value" | '''2''' (Beveled) || A simulated embossed rectangle that appears to be raised above the surface of the page. |
|- | |- | ||
| − | | class="op_enum_value" | '''3''' (Inset) || | + | | class="op_enum_value" | '''3''' (Inset) || A simulated engraved rectangle that appears to be recessed below the surface of the page. |
|- | |- | ||
| − | | class="op_enum_value" | '''4''' (Underline) || | + | | class="op_enum_value" | '''4''' (Underline) || A single line along the bottom of the annotation rectangle. |
|} | |} | ||
Default value: <tt>'''0''' (Solid)</tt> | Default value: <tt>'''0''' (Solid)</tt> | ||
| Line 32: | Line 32: | ||
| class="op_param_name" | E | | class="op_param_name" | E | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the annotation's [[PXV:PXC_AnnotBorderEffect|border style effect]] |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' ( | + | | class="op_enum_value" | '''0''' (Standard) || No effect. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' ( | + | | class="op_enum_value" | '''1''' (Cloudy) || The border should appear “cloudy”. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
Default value: <tt>'''0''' (Solid)</tt> | Default value: <tt>'''0''' (Solid)</tt> | ||
| Line 50: | Line 44: | ||
| class="op_param_name" | EL | | class="op_param_name" | EL | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the effect level. |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | W | | class="op_param_name" | W | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the border width. |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| Line 61: | Line 55: | ||
| style="text-align:center" | Array | | style="text-align:center" | Array | ||
| Array of <tt>'''Double'''</tt> | | Array of <tt>'''Double'''</tt> | ||
| − | Specifies | + | 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]] | ||
Latest revision as of 06:27, 1 March 2016
Options Table
| Name | Type | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| S | Integer | Specifies the annotation's border style
Possible values are:
Default value: 0 (Solid) | ||||||||||
| E | Integer | Specifies the annotation's border style effect
Possible values are:
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
