FontParams

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
(Label ToWrite removed)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:FontParams}}
 
{{#customTitle:FontParams}}
 
{{#parentPage:PXV:Params_CommonStructures|FontParams|structure}}
 
{{#parentPage:PXV:Params_CommonStructures|FontParams|structure}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 14: Line 14:
 
| class="op_param_name" | Name
 
| class="op_param_name" | Name
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies the name by which this font is referenced in the Font sub-dictionary of the current resource dictionary.  
 
Default value: <tt>'''Arial'''</tt>
 
Default value: <tt>'''Arial'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Size
 
| class="op_param_name" | Size
 
| style="text-align:center" | Double
 
| style="text-align:center" | Double
| Specifies...
+
| Specifies the size of the font.
 
Default value: <tt>'''10.0'''</tt>
 
Default value: <tt>'''10.0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Underline
 
| class="op_param_name" | Underline
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies whether the font contains an underline style.
 
Possible values are:
 
Possible values are:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
| class="op_enum_value" | '''0''' (None) || ...
+
| class="op_enum_value" | '''0''' (None) || No underline will be applied to the text.
 
|-
 
|-
| class="op_enum_value" | '''1''' (Single) || ...
+
| class="op_enum_value" | '''1''' (Single) || The text will be underlined with the single solid line.
 
|-
 
|-
| class="op_enum_value" | '''2''' (Double) || ...
+
| class="op_enum_value" | '''2''' (Double) || The text will be underlined with double solid lines.
 
|-
 
|-
| class="op_enum_value" | '''3''' (Squiggle) || ...
+
| class="op_enum_value" | '''3''' (Squiggle) || The text will be underlined with the wavy line.
 
|}
 
|}
 
Default value: <tt>'''0''' (None)</tt>
 
Default value: <tt>'''0''' (None)</tt>
Line 40: Line 40:
 
| class="op_param_name" | StrikeOut
 
| class="op_param_name" | StrikeOut
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies whether the font contains a strikeout style.
 
Possible values are:
 
Possible values are:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
| class="op_enum_value" | '''0''' (None) || ...
+
| class="op_enum_value" | '''0''' (None) || No strikeout will be applied to the text.
 
|-
 
|-
| class="op_enum_value" | '''1''' (Single) || ...
+
| class="op_enum_value" | '''1''' (Single) || The text will have a single solid line strikeout.
 
|-
 
|-
| class="op_enum_value" | '''2''' (Double) || ...
+
| class="op_enum_value" | '''2''' (Double) || The text will have a double solid line strikeout.
 
|-
 
|-
| class="op_enum_value" | '''3''' (Squiggle) || ...
+
| class="op_enum_value" | '''3''' (Squiggle) || The text will be strikeout with the wavy line.
 
|}
 
|}
 
Default value: <tt>'''0''' (None)</tt>
 
Default value: <tt>'''0''' (None)</tt>
Line 56: Line 56:
 
| class="op_param_name" | FColor
 
| class="op_param_name" | FColor
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies the font color.
 
Default value: <tt>'''Gray(0)'''</tt>
 
Default value: <tt>'''Gray(0)'''</tt>
 
|-
 
|-
 
| class="op_param_name" | SColor
 
| class="op_param_name" | SColor
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies the stroke color.
 
Default value: <tt>'''N'''</tt>
 
Default value: <tt>'''N'''</tt>
 
|-
 
|-
 
| class="op_param_name" | StrokeWidth
 
| class="op_param_name" | StrokeWidth
 
| style="text-align:center" | Double
 
| style="text-align:center" | Double
| Specifies...
+
| Specifies the width of the stroke.
 
Default value: <tt>'''0.0'''</tt>
 
Default value: <tt>'''0.0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | HScale
 
| class="op_param_name" | HScale
 
| style="text-align:center" | Double
 
| style="text-align:center" | Double
| Specifies...
+
| Specifies the horizontal scale of the font.
 
Default value: <tt>'''100.0'''</tt>
 
Default value: <tt>'''100.0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | TextRise
 
| class="op_param_name" | TextRise
 
| style="text-align:center" | Double
 
| style="text-align:center" | Double
| Specifies...
+
| Specifies the text rise value of the font.
 
Default value: <tt>'''0.0'''</tt>
 
Default value: <tt>'''0.0'''</tt>
 
|}
 
|}

Latest revision as of 07:08, 1 March 2016


Options Table

Name Type Value
Name String Specifies the name by which this font is referenced in the Font sub-dictionary of the current resource dictionary.

Default value: Arial

Size Double Specifies the size of the font.

Default value: 10.0

Underline Integer Specifies whether the font contains an underline style.

Possible values are:

0 (None) No underline will be applied to the text.
1 (Single) The text will be underlined with the single solid line.
2 (Double) The text will be underlined with double solid lines.
3 (Squiggle) The text will be underlined with the wavy line.

Default value: 0 (None)

StrikeOut Integer Specifies whether the font contains a strikeout style.

Possible values are:

0 (None) No strikeout will be applied to the text.
1 (Single) The text will have a single solid line strikeout.
2 (Double) The text will have a double solid line strikeout.
3 (Squiggle) The text will be strikeout with the wavy line.

Default value: 0 (None)

FColor String Specifies the font color.

Default value: Gray(0)

SColor String Specifies the stroke color.

Default value: N

StrokeWidth Double Specifies the width of the stroke.

Default value: 0.0

HScale Double Specifies the horizontal scale of the font.

Default value: 100.0

TextRise Double Specifies the text rise value of the font.

Default value: 0.0

See Also

op.document.addBatesNumbering, op.document.addHeaderAndFooter, op.document.addWatermarks, op.document.summarizeAnnots, op.imagesToDoc, op.scanToImages, op.textToDoc