Options

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:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_contentItems_setProps|Options|property}}
 
{{#parentPage:PXV:op_contentItems_setProps|Options|property}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 14: Line 14:
 
| class="op_param_name" | Entries
 
| class="op_param_name" | Entries
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
| Array of <tt>'''IUnknown'''</tt>
+
| Specifies the [[PXV:IPXV_ContentItemEntry|IPXV_ContentItemEntry]] array that will be modified.
Specifies...
+
 
|-
 
|-
 
| class="op_param_name" | Mask
 
| class="op_param_name" | Mask
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies which properties should be set.
 +
 
 +
SColor = '''1''',
 +
 
 +
FColor = '''2''',
 +
 
 +
StrokeWidth = '''4''',
 +
 
 +
BlendMode = '''8''',
 +
 
 +
Font = '''16''',
 +
 
 +
FontSize = '''32''',
 +
 
 +
FontStyle = '''64''',
 +
 
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''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 of the content item.
 
Default value: <tt>'''rgb(0,0,0)'''</tt>
 
Default value: <tt>'''rgb(0,0,0)'''</tt>
 
|-
 
|-
 
| class="op_param_name" | FColor
 
| class="op_param_name" | FColor
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies the fill color of the content item.
 
Default value: <tt>'''rgb(0,0,0)'''</tt>
 
Default value: <tt>'''rgb(0,0,0)'''</tt>
 
|-
 
|-
 
| class="op_param_name" | BlendMode
 
| class="op_param_name" | BlendMode
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies the blend mode of the content item
 
The list of possible values are shown in [[PXV:Params_NamedValues_BlendModes|the table]].
 
The list of possible values are shown in [[PXV:Params_NamedValues_BlendModes|the table]].
  
Line 41: Line 55:
 
| class="op_param_name" | FontID
 
| class="op_param_name" | FontID
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies the font ID  of the content item.
 
Default value: <tt>'''-1'''</tt>
 
Default value: <tt>'''-1'''</tt>
 
|-
 
|-
 
| class="op_param_name" | FontSize
 
| class="op_param_name" | FontSize
 
| style="text-align:center" | Double
 
| style="text-align:center" | Double
| Specifies...
+
| Specifies the font size of the content item.
 
Default value: <tt>'''0.0'''</tt>
 
Default value: <tt>'''0.0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | FontStyle
 
| class="op_param_name" | FontStyle
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies the font style of the content item.
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | FontStyleMask
 
| class="op_param_name" | FontStyleMask
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies what part font style should be modified.
 +
 
 +
Italic = '''1''',
 +
 
 +
Serif = '''2''',
 +
 
 +
Monospaced = '''4''',
 +
 
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | StrokeWidth
 
| class="op_param_name" | StrokeWidth
 
| style="text-align:center" | Double
 
| style="text-align:center" | Double
| Specifies...
+
| Specifies the stroke width of the content item.
 
Default value: <tt>'''0.0'''</tt>
 
Default value: <tt>'''0.0'''</tt>
 
|-
 
|-
 
| class="op_param_name" | KeepTextGroups
 
| class="op_param_name" | KeepTextGroups
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| Specifies whether the text groups should be kept.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|}
 
|}

Latest revision as of 08:13, 12 January 2016


Options Table

Name Type Value
Entries Array Specifies the IPXV_ContentItemEntry array that will be modified.
Mask Integer Specifies which properties should be set.

SColor = 1,

FColor = 2,

StrokeWidth = 4,

BlendMode = 8,

Font = 16,

FontSize = 32,

FontStyle = 64,

Default value: 0

SColor String Specifies the stroke color of the content item.

Default value: rgb(0,0,0)

FColor String Specifies the fill color of the content item.

Default value: rgb(0,0,0)

BlendMode Integer Specifies the blend mode of the content item

The list of possible values are shown in the table.

Default value: 0 (Normal)

FontID Integer Specifies the font ID of the content item.

Default value: -1

FontSize Double Specifies the font size of the content item.

Default value: 0.0

FontStyle Integer Specifies the font style of the content item.

Default value: 0

FontStyleMask Integer Specifies what part font style should be modified.

Italic = 1,

Serif = 2,

Monospaced = 4,

Default value: 0

StrokeWidth Double Specifies the stroke width of the content item.

Default value: 0.0

KeepTextGroups Boolean Specifies whether the text groups should be kept.

Default value: false