Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Options Table)
(Options Table)
 
Line 280: Line 280:
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
 
| Specifies whether the annotations will be in the open state.
 
| Specifies whether the annotations will be in the open state.
Default value: <tt>'''true'''</tt>
+
|-
 +
| class="op_param_name" | LineWidthProfile
 +
| style="text-align:center" | Integer
 +
| Specifies the line width profile type. The ID is the selection ID from the Width Profile combo box (0 is auto).
 +
Default value: <tt>'''0.0'''</tt>
 
|}
 
|}

Latest revision as of 08:45, 23 October 2020


Options Table

Name Type Value
Mask Integer Specifies the annotation modification mask flags.

Default value: 0

MaskEx Integer Specifies the extended annotation modification mask flags.

Default value: 0

Flags Integer Specifies the flags used for the modification.

Default value: 0

FlagsMask Integer Specifies the mask used for the flags.

Default value: -1

Border Dictionary Specifies the annotation border's settings.
SColor String Specifies the annotations' stroke color.

Default value: rgb(0,0,0)

FColor String Specifies the annotations' fill color.

Default value: rgb(0,0,0)

NoteIcon Integer Specifies the icon type that should be used for annotations' notes.

The list of possible values are shown in the table.

Default value: 3 (Comment)

TextMarkupType Integer Specifies the text markup type that should be used.

Possible values are:

2908 (Highlight)
5653 (Squiggly)
5696 (StrikeOut)
6278 (Underline)

Default value: 2908 (Highlight)

Opacity Double Specifies the opacity value that should be used (100% by default).

Default value: 1.0

Author String Specifies the annotations' author.

Default value: Empty String

Subject String Specifies the annotations' subject.

Default value: Empty String

Text String Specifies the text that would be set to the annotations that use it.

Default value: Empty String

RichText String Specifies the rich text that would be set to the annotations that use it.

Default value: Empty String

LS Integer Specifies the line starting style that should be used.

The list of possible values are shown in the table.

Default value: 0 (None)

LE Integer Specifies the line ending style that should be used.

The list of possible values are shown in the table.

Default value: 0 (None)

LLO Double Specifies the line leader offset value.

Default value: 0.0

LLL Double Specifies the line leader length value.

Default value: 0.0

LLE Double Specifies the line leader extension value.

Default value: 0.0

LCV Boolean Specifies whether the line caption should be visible.

Default value: true

LCI Boolean Specifies whether the line caption should be inline.

Default value: true

LCO Dictionary Specifies the line caption offset value.
LineLength Double Specifies the line length value.

Default value: 72.0

LCP Integer Specifies the line caption position.

Possible values are:

0 (Inline) The line caption will be inline.
1 (Top) The line caption will be placed at the annotation's top.

Default value: 0 (Inline)

HighlightMode Integer Specifies the highlight mode that should be applied to the annotations.

Possible values are:

0 (None) No highlight would be applied.
1 (Invert) The current highlight value will be inverted.
2 (Outline) ...
3 (Toggle) ...
3 (Push) ...

Default value: 1 (Invert)

BlendMode Integer Specifies the annotations' blend mode.

The list of possible values are shown in the table.

Default value: 0 (Normal)

Trigger Integer Specifies the annotations' action trigger that would execute the action list.

The list of possible values are shown in the table.

Default value: 4 (Up)

Actions IUnknown Specifies the action list that would be executed by the trigger.
Dest Dictionary Specifies the annotations' destination parameters.
Name String Specifies the annotations' names.

Default value: Empty String

ModDate String Specifies the new modification date of the annotations.

Default value: Empty String

Rotation Double Specifies the annotations' rotation angle.

Default value: 0.0

AbsRotation Boolean Specifies whether the rotation should be added to the previous rotations. If true is specified then the Rotation value will replace the previous rotation value.

Default value: true

Measure IUnknown Specifies the annotations' measure.
DefStyle String Specifies the annotations' default style.

Default value: Empty String

OFC String Specifies the

Default value: gray(0)

OT String Specifies...

Default value: Empty String

ORT Boolean Specifies...

Default value: false

DefFontName String Specifies...

Default value: Empty String

DefFontID Integer Specifies the annotations' default font ID.

Default value: -1

DefFontSize Double Specifies the annotations' default font size.

Default value: 10.0

DefTextColor String Specifies the annotations' default text color.

Default value: rgbd(0,0,0)

DefTextAlign Integer Specifies the annotations' default text align.

Default value: 0

OC IUnknown Specifies...
LSS Double Specifies the annotations' line-ending start scale.

Default value: 0.0

LES Double Specifies the annotations' line-ending end scale.

Default value: 0.0

Opened Boolean Specifies whether the annotations will be in the open state.
LineWidthProfile Integer Specifies the line width profile type. The ID is the selection ID from the Width Profile combo box (0 is auto).

Default value: 0.0