ElementWriterBegin Method (Page, ElementWriterWriteMode, Boolean, Boolean, Obj) |
Begin writing to the given page.
By default, new content will be appended to the page, as foreground graphics.
It is possible to add new page content as background graphics by setting the
second parameter in begin method to 'true' (e.g. writer.Begin(page, true)).
Namespace:
pdftron.PDF
Assembly:
pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax public void Begin(
Page page,
ElementWriterWriteMode placement,
bool page_coord_sys,
bool compress,
Obj resources
)
Public Sub Begin (
page As Page,
placement As ElementWriterWriteMode,
page_coord_sys As Boolean,
compress As Boolean,
resources As Obj
)
public:
virtual void Begin(
[InAttribute] Page^ page,
[InAttribute] ElementWriterWriteMode placement,
[InAttribute] bool page_coord_sys,
[InAttribute] bool compress,
[InAttribute] Obj^ resources
) sealed
function Begin(page, placement, page_coord_sys, compress, resources);
Parameters
- page
- Type: pdftron.PDFPage
The page to write content.
- placement
- Type: pdftron.PDFElementWriterWriteMode
An optional flag indicating whether the new content should
be added as a foreground or background layer to the existing page. By default, the new
content will appear on top of the existing graphics.
- page_coord_sys
- Type: SystemBoolean
An optional flag used to select the target coordinate system.
If true (default), the coordinates are relative to the lower-left corner of the page,
otherwise the coordinates are defined in PDF user coordinate system (which may,
or may not coincide with the page coordinates).
- compress
- Type: SystemBoolean
An optional flag indicating whether the page content stream
should be compressed. This may be useful for debugging content streams. Also
some applications need to do a clear text search on strings in the PDF files.
By default, all content streams are compressed.
- resources
- Type: pdftron.SDFObj
the resource dictionary in which to store resources for the final page.
By default, a new resource dictionary will be created.
See Also