| |
You can add HTML to your documents using the AddHtml
method. ABCpdf supports the following HTML tags and attributes.
<Head>
This tag is used to delimit the head of an HTML document. All
content in the head is ignored.
This tag does not accept any attributes.
<Body>
This tag is used to mark the body of an HTML document. The body
is a type of stylerun, and so it accepts the same attributes as a
stylerun tag. It also accepts the following
additional attributes.
| Attribute
|
Notes
|
| link |
The color for links (anchors) in subsequent content.
Colors are generally specified as RGB in hexadecimal notation
(e.g. color="#FF0000") or as one of the sixteen standard color
names (e.g. color=red").
You can specify grayscale colors by supplying only one component
(e.g. color="#80") and CMYK colors by supplying four (e.g.
color="#10203040"). CMYK component ranges between 0 and 100
inclusively so the hexadecimal representation is between 00 and
64.
The default link color is RGB blue.
|
<BR>
This tag is used to force a line break.
This tag does not accept any attributes.
<P>
This tag is used to mark up paragraphs. Paragraphs are types of
styleruns, and so they accept the same attributes as stylerun tags. They also accept the following
additional attributes.
| Attribute
|
Notes
|
| align |
The text alignment for the paragraph. If no value is specified,
it is assumed that the text should be left aligned.
You can specify left aligned text (e.g. align=left), right
aligned text (e.g. align=right), centered text (e.g. align=center)
or justified text (e.g. align=justify).
Changing this attribute is identical to changing the Doc.HPos or
XTextStyle.Justification
properties.
|
| break |
The line breaking style for the paragraph. This attribute takes
a comma delimited list of hints used to control how lines are
broken when chaining from one text area to another.
You can specify that a paragraph should be kept with the next
one by assigning the keepwithnext hint (e.g. break=keepwithnext).
You can specify that there should be a break before a paragraph by
specifying the breakbefore hint (e.g. break=breakbefore).
For details on chaining, see the AddHtml
method.
|
| spacebefore |
Normally, paragraphs have vertical space before and afterwards
the body text.
By setting this attribute to zero, you can remove vertical space
before the paragraph.
|
| spaceafter |
Normally, paragraphs have vertical space before and afterwards
the body text.
By setting this attribute to zero, you can remove vertical space
after the paragraph.
|
<H1> to <H6>
This tag is used to mark header sections. Headers are types of
paragraphs, and so they accept the same attributes as paragraph tags.
<List>
This tag is used to indicate a list of items. Each list item
consists of a marker and some text. Markers may be bullet points,
numbers or letters.
Lists are types of paragraphs, and so they accept the same
attributes as paragraph tags. They also accept the
following additional attributes.
| Attribute
|
Notes
|
| itemindent |
The indent of the item text from the left of the marker. This
value is measured in the current units.
By altering this property, you can change the distance between
the marker and the text.
The default is dynamically determined based on the type of
marker and the size of the text.
|
| markerindent |
The indent of the left of the marker from the current left of
the surrounding text. This value is measured in the current
units.
By altering this property, you can alter the the indent distance
for the markers in the list.
The default is dynamically determined based on the type of
marker and the size of the text.
|
| start |
Specifies the starting number for the first item in the
list.
This is only used when ordered markers are specified.
The default is one.
|
| type |
Specifies the type of marker to use. You can use either ordered
markers or unordered markers.
Ordered markers increment for each item in the list. You can use
numbers (type=1), lower case roman numerals (type=i), upper case
roman numerals (type=I), lower case letters (type='a') or upper
case letters (type=A).
Unordered markers are the same for each item in the list. You
can specify bullet points (type=disk), hollow bullets (type=circle)
or squares (type=square).
The default type is 'disk'.
|
<UL>
The UL tag is used to indicate an unordered list. Unordered
lists are types of lists, and so they accept the same attributes as
list tags. The default marker is the bullet
point, but the marker will change as lists are nested within each
other.
<OL>
The OL tag is used to indicate an ordered list. Ordered lists
are types of lists, and so they accept the same attributes as
list tags. The default marker type is
numeric.
<LI>
This tag is used to indicate an item within a list. It accepts
the following attributes.
| Attribute
|
Notes
|
| value |
Specifies the number for this list item.
Subsequent items are numbered incrementally from this new
value.
|
| type |
Specifies the type of marker to use.
You can use the same types as you find in the type attribute of
the list tag.
|
<A>
The anchor tag is used to mark subsequent content as a
hyperlink. Anchors are types of styleruns, and so they accept the
same attributes as stylerun tags. They also
accept the following additional attributes.
| Attribute
|
Notes
|
| href |
The URL of the destination.
|
Hyperlinks normally appear as blue underlined text. You can
override this style using the body link
attribute or by using stylerun attributes
in the body of your anchor tag.
<B>
This tag is used to apply a bold text style to subsequent
content.
ABCpdf will attempt to reference an appropriate bold font. If it
cannot locate one, it will generate a synthetic bold style using
the XTextStyle.Bold
property.
This tag does not accept any attributes.
<I>
This tag is used to apply an italic text style to subsequent
content.
ABCpdf will attempt to reference an appropriate italic font. If
it cannot locate one, it will generate a synthetic italic style
using the XTextStyle.Italic
property.
This tag does not accept any attributes.
<U>
This tag is used to apply an underline text style to subsequent
content. The effect is identical to changing the XTextStyle.Underline
property.
This tag does not accept any attributes.
<Strike>
This tag is used to apply an strike-through text style to
subsequent content. The effect is identical to changing the
XTextStyle.Strike
property.
This tag does not accept any attributes.
<Sup>
This tag is used to indicate text to be rendered as
superscript.
This tag does not accept any attributes.
<Sub>
This tag is used to indicate text to be rendered as
subscript.
This tag does not accept any attributes.
<Font>
The font tag is used to change the current font style. Fonts are
types of styleruns, and so they accept the same attributes as
stylerun tags. They also accept the
following additional attributes.
| Attribute
|
Notes
|
| size |
The font size for subsequent content.
You can set absolute font size by specifying an integer ranging
from one to seven (e.g. size=6). Or you can specify a font size
relative to the current base font size (e.g. size="+1").
For greater control over the size of text, you should use the
fontsize attribute.
|
| color |
The color for subsequent content.
Colors are generally specified as RGB in hexadecimal notation
(e.g. color="#FF0000") or as one of the sixteen standard color
names (e.g. color=red").
You can specify grayscale colors by supplying only one component
(e.g. color="#80") and CMYK colors by supplying four (e.g.
color="#10203040"). CMYK component ranges between 0 and 100
inclusively so the hexadecimal representation is between 00 and
64.
You can specify an alpha value for your color by appending a
slash and a hex value to the end of your color string (e.g.
color="#10203040/C0").
You can specify that no color should be applied by using the
special 'none' keyword (e.g. color="none"). This can be useful if
you wish to specify your own color operators in your own low-level
code.
This attribute sets both the stroke and fill colors.
|
| color-stroke |
The stroke color for subsequent content.
This attribute allows you to specify the stroke color
independently from the fill color.
|
| color-fill |
The fill color for subsequent content.
This attribute allows you to specify the fill color
independently from the stroke color.
|
| csid |
The color space for subsequent content.
This attribute takes an Object ID obtained from a previous call
to AddColorSpaceFile
or AddColorSpaceSpot.
This attribute sets both the stroke and fill color space.
|
| csid-stroke |
The stroke color space for subsequent content.
This attribute allows you to specify the stroke color space
independently from the fill color space.
|
| csid-fill |
The fill color space for subsequent content.
This attribute allows you to specify the fill color space
independently from the stroke color space.
|
| face |
The font typeface for subsequent content.
This value takes a comma delimited list of typeface names,
listed in order of preference. Fonts are referenced rather than
embedded.
For greater control over the way that fonts are added to your
document, you should use the pid attribute.
|
| embed |
Whether to embed or reference fonts added via the face
attribute.
For details, see the EmbedFont method.
The default is false.
|
| language |
What language to use when embedding fonts added via the face
attribute.
For details, see the EmbedFont method.
The default is Latin.
|
| protection |
Whether to to apply font protection when embedding fonts added
via the face attribute.
For details, see the EmbedFont method.
The default is true.
|
| font-family |
The font family for subsequent content.
This value operates in the same way as the face attribute
detailed above.
|
| font-style |
The font style.
This attribute can take the values oblique, italic or normal.
Normal is the default.
NB. ABCpdf does not currently make a distinction between oblique
and italic styles.
|
| font-weight |
The font weight.
This attribute can take the a value between 100 (lightest) and
900 (heaviest).
It can also take the following pre-defined values - normal,
bold, bolder and lighter.
The default is normal - 400.
NB. ABCpdf cannot currently synthesize font weights of less than
400.
|
| rendering-mode |
The text rendering mode. Possible values are:
0 Fill text (default)
1 Stroke text.
2 Fill, then stroke text.
3 Neither fill nor stroke text (invisible).
4 Fill text and add to path for clipping.
5 Stroke text and add to path for clipping.
6 Fill, then stroke text and add to path for clipping.
7 Add text to path for clipping.
NB. The outline style is a more commonly used alternative to the
rendering-mode.
|
<StyleRun>
The stylerun tag is used to change the current style. It accepts
the following attributes.
| Attribute
|
Notes
|
| pid |
The font typeface for subsequent content.
This attribute takes an Object ID obtained from a previous call
to AddFont or
EmbedFont.
|
| fontsize |
The font size for subsequent content.
Changing this attribute is identical to changing the XTextStyle.Size
property.
|
| charspacing |
The character spacing for subsequent content.
Changing this attribute is identical to changing the XTextStyle.CharSpacing
property.
|
| wordspacing |
The word spacing for subsequent content.
Changing this attribute is identical to changing the XTextStyle.WordSpacing
property.
|
| justification |
The justification for subsequent content.
Changing this attribute is identical to changing the XTextStyle.Justification
property.
|
| hpos |
The horizontal positioning for subsequent content.
Changing this attribute is identical to changing the Doc.HPos
property.
|
| bold |
Whether to apply a synthetic bold style to subsequent
content.
Changing this attribute is identical to changing the XTextStyle.Bold
property.
|
| italic |
Whether to apply a synthetic italic style subsequent
content.
Changing this attribute is identical to changing the XTextStyle.Italic
property.
|
| underline |
Whether to underline subsequent content.
Changing this attribute is identical to changing the XTextStyle.Underline
property.
|
| strike |
Whether to apply a strike-through effect to subsequent
content.
Changing this attribute is identical to changing the XTextStyle.Strike
property.
|
| strike2 |
Whether to apply a double strike-through effect to subsequent
content.
Changing this attribute is identical to changing the XTextStyle.Strike2
property.
|
| outline |
Whether to outline subsequent content.
Changing this attribute is identical to changing the XTextStyle.Outline
property.
|
| linespacing |
The line spacing for subsequent content.
Changing this attribute is identical to changing the XTextStyle.LineSpacing
property.
|
| paraspacing |
The paragraph spacing for subsequent content.
Changing this attribute is identical to changing the XTextStyle.ParaSpacing
property.
|
| leftmargin |
The left margin for subsequent content.
Changing this attribute is identical to changing the XTextStyle.LeftMargin
property.
|
| indent |
The indent for subsequent content.
Changing this attribute is identical to changing the XTextStyle.Indent
property.
|
| fixedwidth |
A fixed with for the style run.
Each style run has a width. The width is normally determined by
the size of the characters in the text.
Under some situations, it can be useful to assign a fixed width
to the entire style run. This can be used for aligning text and for
bullet pointed lists.
|
| textrise |
The text rise for subsequent content.
Positive values shift the text upwards. Negative values shift it
downwards. The textrise distance is measured in the current
units.
|
| annots |
Annotations associated with subsequent content.
You can use a link annotation to insert a hyperlink (e.g.
annots='link:http://www.google.com/').
You can use a goto annotation to insert a link to another page
in the document (e.g. annots='goto:3'). The number indicates the
page number. Note that the destination page must exist at the point
at which the text is inserted.
You can use a text annotation to insert a textual note (e.g.
annots='text:A note to be inserted').
You can use highlight, squiggly, underline, and strikeout
annotations for text markup. (e.g. annots='highlight:some
contents').
While other types of annotations have textual contents (that are
specified after colon), link and goto annotations do not. However,
you can still mark link and goto annotations with (non-displayed)
textual contents using "contents:" so that you can later identify
them easily with Doc.GetInfo
(e.g. annots='link:http://www.google.com/;contents:alternative
description').
|
| dir |
The default reading direction.
Bi-directional text such as Hebrew or Arabic is laid out in the
context of the default reading direction.
You can specify left to right paragraph direction (e.g.
dir=ltr), right to left paragraph direction (e.g. dir=rtl), or use
the default of none (e.g. dir=none).
When none is specified, the original ABCpdf left to right layout
is preserved for compatibility with previous versions.
|
| canbreakafter |
Characters at which lines may be broken.
Normally, ABCpdf will only break lines after certain characters
like spaces. You can indicate additional characters after which a
break is acceptable using this parameter.
For example, to allow a break after hyphens or underscores, you
might use canbreakafter='-_'.
|
| breakengine |
The default line breaking engine.
The line breaking engine determines at which points lines can be
broken.
You can specify the Uniscribe line breaking engine (e.g.
breakengine=uniscribe), the Unicode line breaking engine (e.g.
breakengine=unicode), or use the default of auto (e.g.
breakengine=auto).
When auto is specified, the Uniscribe engine is used for
installations on Windows XP and 2003, and the Unicode engine is
used for installations on Windows NT and 2000.
|
| wrap |
Whether lines should wrap. The default is true.
If wrapping is turned off (i.e. by setting this value to false),
then lines of text extending outside the drawing area will be
truncated.
|
| transform |
The transformation for text.
The format of this value is the same as that of XTransform.String.
The default value is the identity. This attribute takes precedence
over the rotate attribute. The numeric values can optionally be
preceded by 'fixed' (e.g. transform='fixed 2 0 0 2 0 0'), which
fixes the transformation origin.
The direction to which the rightward direction (the default
primary advancement direction) is mapped is the primary advancement
direction. The direction in which a new line is offset (i.e. the
direction of the offset caused by starting a new line) is the
secondary advancement direction.
When the origin is not fixed and the StyleRun is broken into
pieces (because of nested tags or line breaks, for example), the
transformation is applied to each piece individually. When the
primary advancement direction is not horizontal, the effect is
observably different as each piece starts at the original
baseline.
When the origin is fixed, each piece (without its own
transformation) appears as if it starts at where the previous piece
ends because the transformation origin is fixed at the beginning of
the StyleRun.
The secondary advancement direction is always perpendicular to
the primary advancement direction regardless of skews in the
transformation. (This is meaningful only in the context of multiple
lines within a StyleRun with a fixed transformation.) In which of
the two opposite directions the secondary advancement is depends on
the direction to which the downward direction (the default
secondary advancement direction) is mapped. This allows artificial
styles that simulate oblique/italic without affecting the secondary
advancement.
Decorations (underline and strike-through) are placed at the
correct locations without distortion so they remain
rectangular.
|
| rotate |
The rotation for text.
This value is measured in degrees anticlockwise. The default is
zero. This attribute is ignored if the transform attribute is
present. The numeric value can be preceded by 'fixed' (e.g.
rotate='fixed 30'), which fixes the transformation origin as
explained in the transform attribute.
|
| ascender |
The default size of the ascender.
The PDF specification defines text as drawn from a point
anchored at the baseline of a letter. So to place a chunk of text
inside a box, the text needs to be shifted downwards by the
distance between the baseline and the top of the letter. This
distance is typically known as the ascender height.
ABCpdf uses its own methods to determine the ascender height for
fonts. However, using this attribute, you can override these
methods and specify your own values. This can be useful for
situations in which you are drawing text anchored at the baseline
rather than the top of the glyphs.
The ascender value is measured in 1000ths of the font height. A
typical value might be 800.
|
<BlockQuote>
This tag is used to indicate quotations. Block quotes are
indented on the left and right relative to the surrounding text.
The tag accepts the following attributes.
| Attribute
|
Notes
|
| leftindent |
The left indent for the block of text.
Distances are measured in the current units. The default is 36
points.
|
| rightindent |
The right indent for the block of text.
Distances are measured in the current units. The default is 36
points.
|
<Pre>
This tag is used to indicate preformatted text. Spaces and line
breaks are preserved.
|
|
|
